Installation

Note

SIMBA is compatible only with python 3.10 and above.

Contact Alex Brynes in case of any issues during installation / testing / etc.

Cloning from Github

Clone SIMBA from Github:

git clone https://github.com/astec-stfc/simba.git

(It is recommended to activate a python3.10 (or higher) virtual environment to run SIMBA.)

The package and its dependencies can be installed using the following command in the SIMBA directory:

pip install .

In order to enable SIMBA to access the simulation codes, refer to the instructions here – this step is necessary to perform the tests.

To check that the install was completed successfully, run this command from the top level:

pytest --cov

SIMBA is available from pypi:

pip install simba-accelerator

Check out the pyproject.toml file for a full list of dependencies for SIMBA.

In order to set up the SimCodes required for running simulations, refer to SimCodes