1.1. Install

1.1.1. Dependencies

Warning

Versioning errors can occur. Make sure that you have the version of each dependency installed as listed below.

  • Anaconda version 4.2.0 , python 2.7

    conda tool version
    conda version ≥ 4.2.9
    conda-env version ≥ 4.2.9
    conda-build version 2.1.10
    python version 2.7.12.final.0
    requests version ≥ 2.10.0

  • Boost 1.61.0

  • FFTW3 3.3.4

  • gcc-4.8, g++-4.8

For a more indepth explaination of how to install these, see the prequisites section.

1.1.2. Installation

Warning

Mac users - please see the known issues for Mac.

We use Anaconda to install PySLGR.
If you do not have Anaconda installed, you can download it here

  1. Download the latest PySLGR release from https://github.com/mitll/pyslgr/releases

  2. Copy the provided conda package (pyslgr<version>.tar.bz2) to your local system. Make sure you have the correct version for your operating system. We will refer to the location of this file as <pyslgr-pkg dir>.

  3. Also copy the provided models and examples packages (models.tar.gz, examples.tar.gz)

  4. Unpack examples.tar.gz into a directory of your choosing.

  5. Unpack the models.tar.gz in the examples directory created in the previous step.

  6. Open the terminal and run:

    conda install <pyslgr-pkg dir>/<pkg-name.tar.bz2>

    where <pkg-name.tar.bz2> is the name of the file provided.

See also

For details on how to build the package from the source code, see How to Build PySLGR.

1.1.3. Check Installation

Warning

Not all examples may work on Mac machines. See known issues for Mac.

Note

Make sure that the examples.tar.gz is unpacked and contains an unpacked models.tar.gz directory.

  1. Locate a sample script in the examples directory.

  2. Run:

    python <sample_script>

1.1.4. To Remove

Run:

conda remove --name <env-name> pyslgr

where <env-name> is the name of an existing environment.

To list all environments use:

conda info -env$