Skip to content

3. Getting Started

Mingsong Li edited this page Mar 9, 2019 · 2 revisions

3.1 System Requirements

This software is developed in MatLab version 2015b and 2017a. It was tested in Mac OS Mojave system (macOS 10.14) and Windows 7 & 10.

[1. MatLab version]:

The package works with both Mac OS and Windows. MatLab is essential for the Acycle software package. Specified MatLab toolboxes may be needed.

[2. Mac version]:

This software is a stand-alone program. It was tested in Mac OS Mojave system (macOS 10.14). If the Mac runs with no MatLab, MatLab runtime R2015b is essential for the Acycle stand-alone software.

Two versions are available:

v1. AcycleX.X-Mac-green

No installation needed. Size: ~100 Mb.

MatLab runtime R2015b is not included in this package and can be downloaded at: https://www.mathworks.com/products/compiler/matlab-runtime.html.

v2. AcycleX.X-Mac-Installer

Install Acycle and MatLab runtime R2015b simultaneously.

Size: ~100 Mb

[3. Windows version]:

This software is a stand-alone program. It was tested in Windows 10 & 7.

AcycleX.X-Win-Installer.zip

Size: ~100 Mb.

If the computer runs with no MatLab, MatLab runtime R2017a is essential for the Acycle stand-alone software.

3.2 Downloading the Acycle software

The Acycle software is available for download from:

MatLab version:

GitHub (https://github.com/mingsongli/acycle/)

downloading

Mac / Windows stand-alone versions:

Dropbox (https://www.dropbox.com/sh/t53vjs539gmixnm/AAC0BqTR0U5xghKwuVc1Iwbma?dl=0), or

Baidu Cloud (https://pan.baidu.com/s/14-xRzV_-BBrE6XfyR_71Nw)

3.3 MatLab version

3.3.1 Installation

Unzip the Acycle software package to your root directory. No installation is needed.

Warning: the working directory and file names contain NO SPACE or no language other than ENGLISH.

3.3.2 Startup

Step 1: Startup MatLab.

Step 2: Change the MatLab working directory to the Acycle directory.

You may use the icon in blue Box 1 or type the directory in blue Box 2 below. matlab startup

Step 3: Launch ac.m

  • Option 1: Type ac in MatLab’s command window, then press the Enter key.

  • Option 2: Right click ac.m file and choose Run.

    Then, all set!

run

Warning: the working directory and file names contain NO SPACE or no language other than ENGLISH.  

3.4 Mac version

3.4.1 Introduction

This version of Acycle is a stand-alone program. It is tested in Mac OS Mojave system (macOS 10.14). Two versions are available:

  • Section 3.4.2 AcycleX.X-Mac-green
  • Section 3.4.3 AcycleX.X-Mac-Installer

3.4.2 AcycleX.X-Mac-green

3.4.2.1 Download AcycleX.X-Mac-green.zip

Dropbox (https://www.dropbox.com/sh/t53vjs539gmixnm/AAC0BqTR0U5xghKwuVc1Iwbma?dl=0), or Baidu Cloud (https://pan.baidu.com/s/14-xRzV_-BBrE6XfyR_71Nw).

3.4.2.2 Installation of Runtime

runtime

  • Step 2: Install for Mac OS X. Double click the file blue box below (left panel).

Or right-click and select “Show Package Contents”. In the pop-up folder, double click “InstallForMacOSX”.

Then it may ask permission for installation. Follow instructions of the MatLab Runtime installer, you will install Runtime.

run run

  • Step 3. Setup Runtime environment.

[Click here to read more about "How to setup runtime environment"](https://github.com/mingsongli/acycle/wiki/Frequently-Asked-Questions#2-how-to-set-the-matlab-runtime-environment-variable-dyld_library_path)

3.4.2.3 Startup AcycleX.X-Mac-green

You only need to do Steps 1-3 for the first time. Then only Step 4 below is need.

  • Step 1: Drag the AcycleX.X-Mac file to the /Applications folder.
  • Step 2: Go to the “/Applications” folder. Right click “AcycleX.X-Mac” file, choose “Show Package Content”.

run

  • Step 3: Go to “/Contents/MacOS” folder, drag the “applauncher” file to dock (NOT the “Acycle” file).
  • Step 4: Click the icon of “applauncher” in the dock to start the Acycle software.

Note the first-time run will be very bit slow.

Warning: NEVER close the terminal window (left panel below) when using Acycle. This will close Acycle.

Warning: the working directory contains no SPACE or no language other than ENGLISH.

dock

3.4.3 AcycleX.X-Mac-Installer

3.4.3.1 Download AcycleX.X-Mac-Installer

Dropbox (https://www.dropbox.com/sh/t53vjs539gmixnm/AAC0BqTR0U5xghKwuVc1Iwbma?dl=0), or Baidu Cloud (https://pan.baidu.com/s/14-xRzV_-BBrE6XfyR_71Nw).

3.4.3.2 Installation of Acycle and MatLab runtime simultaneously.

  • Step 1: Double click “AcycleX.X-Mac-Installer” to start the installation. The admin permission may be required.

installer

  • Step 2: Following instructions of Acycle Installer. Choose Acycle installation folder (default folder is /Applications/Acycle).

  • Step 3: Choose MATLAB Runtime installation folder (default folder is /Applications/MATLAB/MATLAB_Runtime).

  • Step 4: License Agreement: Do you accept the terms of the license agreement? You may select Yes.

  • Step 5: Install Acycle.

3.4.3.3 Startup AcycleX.X-Mac

You only need to do Steps 1-3 for the first run. Then only Step 4 below is need.

  • Step 1: Go to the installation folder (for example: /Applications/Acycle/application).

  • Step 2: Right click “Acycle” file, choose “Show Package Content”
  • Step 3: Go to the “Contents/MacOS” folder, drag the applauncher file to dock.

  • Step 4: Click icon of “applauncher” above to start the Acycle software.

Warning: NEVER close the terminal window (panel below) when using Acycle. This will close Acycle either. To kill Acycle software, press CTRL + C keys Note the first-time run will be very slow. Please ignore various warning messages and forgive my naïve program skills. Warning: the working directory should contain NO SPACE or no language other than ENGLISH.

3.5 Windows version

3.5.1 Introduction

This version of Acycle is a stand-alone program. It has been tested in Windows 10 OS. Two versions are available:

3.5.2 AcycleX.X-Win-Installer

3.5.2.1 Download AcycleX.X-Win-Installer

Dropbox (https://www.dropbox.com/sh/t53vjs539gmixnm/AAC0BqTR0U5xghKwuVc1Iwbma?dl=0), or Baidu Cloud (https://pan.baidu.com/s/14-xRzV_-BBrE6XfyR_71Nw).

3.5.2.2 Installation

Double click “AcycleInstaller.exe” to install Acycle and MatLab runtime R2017a. Following the instructions, you will get everything set.

Downloading MatLab runtime R2017a can take a lot of time. The runtime needs 1 GB space.

3.5.2.3 Start-up

You could just double click the Acycle icon on the desktop to start or start from the Windows “All Program” menu like any other software.

However, I strongly recommend the following start-up method, which will enable a command window showing a lot of information about many time-consuming steps.

  1. Step 1: Use “Win + R” short-cut keys to start the “RUN” of Windows (figure below). Then in the pop-up window, type cmd and click the OK button.

run

  1. Step 2: Type following two lines of commend below in the command window. My software was installed under the directory “ C:\Program Files”, so it should be:

cd C:\Program Files\Acycle\application\

Acycle

run

Acycle will start.

Now, you need to change the working directory (change) to the working folder.

Warning: the working directory should contain NO SPACE or no language other than ENGLISH. Warning: the first-time start-up can be very slow. Never close the command window when Acycle is running. The commend window will keep on showing information when it runs time-consuming steps.

3.5.3 AcycleX.X-Win-green

3.5.3.1 Download AcycleX.X-Win-green, unzip the file.

Dropbox (https://www.dropbox.com/sh/t53vjs539gmixnm/AAC0BqTR0U5xghKwuVc1Iwbma?dl=0), or Baidu Cloud (https://pan.baidu.com/s/14-xRzV_-BBrE6XfyR_71Nw).

3.5.3.2 Installation of MatLab runtime 2017a

https://www.mathworks.com/products/compiler/matlab-runtime.html

3.5.3.3 Double click “Acycle.exe” to run Acycle.

3.5.3.4 Now, you need to change directory (change) to the working folder.

Warning: the working directory should contain NO SPACE or no language other than ENGLISH.  

3.6 Data Requirement

The input file of data series can be in a variety of formats, including comma-, table- or space-delimited text (.txt), and comma-separated values files (.csv) from an Excel-type spreadsheet. No header is permitted.

Most data files should contain two columns of series. The first column must be in depth or time, and the second column should be value in the corresponding depth or time.

directory

Please make sure there is NO SPACE or language other than ENGLISH in the address line. Or you need to change the directory (change) to new working folder.

Still have no idea? Don't worry. Try this, you’ll have a perfect example: Choose “Basic Series” menu --> "Examples" --> choose any data or image file

Examples

The data will be saved in the working directory. All data files, plots, and folders are displayed in the GUI list box.

Clone this wiki locally