LightWin

LightWin is a tool to automatically find compensation settings for cavity failures in linacs.

Installation

The full installation instructions are detailed here. The steps are straightforward and can be summarized as follows:

1. Clone the repository: git clone git@github.com:AdrienPlacais/LightWin.git
2. Navigate to the LightWin directory, and switch to the last released version: git checkout v0.7.0.
3. Install LightWin with all its dependencies: pip install -e .
4. Test that everything is working with pytest -m "not tracewin and not implementation"

Note that the TraceWin module will not work out of the box. You will need to tell LightWin were to find your TraceWin executables. See dedicated instructions.

Documentation

Documentation is available here. To build the documentation from scratch:

1. Build the source files make -C docs/ apidoc
2. Build the CSV files used for documenting configuration make -C docs/ generate_csv
3. Build the documentation make -C docs/ multiversion Note that for quick tests, you can also build the unversioned documentation with make -C docs/ html

How to run

See here.

Example

See the data/example folder.

Future updates

BeamCalculator

• Beam calculator developed by JM Lagniel for SPIRAL2.
• Envelope solvers with space-charge.

Quality of life

• Plotter object.
• Friendlier Evaluator.
• Support for SET_SYNC_PHASE (see note).
• Better handling of TraceWin errors (currently: a single error and whole run is lost).

Optimization

• Correlation matrices.
• Add SNS compensation method