Installation

Note

SimFrame is compatible only with python 3.12 and above.

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

Cloning from Github

Clone SimFrame from Github:

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

(It is recommended to activate a python3.12 virtual environment to run SimFrame.)

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

pip install .

To install the MasterLattice package along with SimFrame, use this command from the SimFrame directory:

pip install .[test]

In order to enable SimFrame 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

WIP…..

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

The following dependency is optional, but is generally required for running CLARA simulations:

This can be installed via pip:

pip install MasterLattice

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