Installing cstool

Requirements

cstool is a Python 3 tool. It depends on ELSEPA, which you need to compile and install yourself.

Before you begin, be sure that the following software is installed:

• Python 3.5 or greater
• On Linux: a fortran77 compiler

All required python packages can be easily installed via pip.

Download and compile ELSEPA

On Linux

Download ELSEPA from the official website. Unpack the archive, and compile the software with the following commands:

gfortran -O -Wall elscata.f -o elscata
gfortran -O -Wall elscatm.f -o elscatm

Then, add the folder containing ELSEPA to your PATH environment variable, so that cstool will be able to find it. This can be done with the following:

export PATH=$PATH:/path/to/elsepa

It is often a good idea to add this line to the .bashrc file in your home directory, otherwise you will have to do this every time you start a new terminal session.

On Windows

It is possible to compile ELSEPA yourself on Windows by installing a fortran compiler. Alternatively, you can get a zip file with pre-compiled executables here.

Extract the zip file, and add the folder to the PATH environment variable by doing this every time you run cstool:

set PATH=%PATH%;C:\path\to\elsepa;

Download and install cstool

On Linux

Get the code from github:

git clone https://github.com/nebula-simulator/cstool

You are now recommended to create a virtual environment, so that you don't contaminate your regular python setup when you install cstool:

python -m venv cstool-env
source cstool-env/bin/activate
pip install --upgrade pip

Then install cstool:

cd cstool
pip install .

On Windows

Instructions will follow...

Run cstool

See the next page for instructions on running cstool.