Getting Started

Building

Checkout and compilation from VCS repository

git clone https://github.com/frib-high-level-controls/FLAME.git flame
mkdir flame/build
cd flame/build
cmake ..
make

CLI

The command line interface ('flame' executable) is found in the tools/ sub-directory.

./tools/flame -h

Prints some help hints.

./tools/flame -L python/flame/test/LS1.lat

Run simulation with the LS1 lattice and prints final output state.

./tools/flame -F hdf5,file=out.h5 -T marker python/flame/test/LS1.lat
python ../tools/h5plotsim.py out.h5

Run simulation with the LS1 lattice and stores the output state of each marker element in an HDF5 file. The 'h5plotsim' helper script does a quick plot.

Python

To use the python module it is necessary that the 'flame' module be in the python module search path. For a VCS build this needs set explicitly.

$ export PYTHONPATH=$PWD/python
$ python -m flame
This is FLAME
 Python API version: 0
 C++ API version: 0

See examples/sim.py for a basic example of API usage. Also:

API Usage (C++ and Python)

Python API reference