This repository includes SLAC-specific python code to be utilized with creating and running virtual accelerators of SLAC beamlines via the LUME framework (see https://github.com/slaclab/lume-base, https://github.com/lume-science).

Installation

Clone this repo into a local location, enter it and run

pip install .

the -e flag can be added if editing the files. See pyproject.toml for dependencies. If you want to use the virtual-accelerator package without all of the codes, you can install code-dependent packages (Bmad, cheetah, etc.) yourself and install virtual-accelerator without all dependencies via the flag -no-deps.

Creating the model instances requires the $LCLS_LATTICE environment variable to be set to a location containing the contents of the lcls-lattice repo https://github.com/slaclab/lcls-lattice.

Note

The Cu Injector model is present in .submodules/repo. To pull latest changes from the Cu Inj repo

git subtree pull --prefix=.submodules/repo https://github.com/slaclab/lcls_cu_injector_ml_model main --squash