LightWin

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

Installation

The full installation instructions are detailed in the documentation.

The steps are straightforward and can be summarized as follows:

Users

1. Create a dedicated Python environment.
2. Run pip install lightwin[cython]

Developers

1. Clone the repository: git clone git@github.com:AdrienPlacais/LightWin.git

Warning

If you Download ZIP this repository (which can happen if you don't have access to git), installation will fail at step #3. A workaround is proposed in the documentation.

2. Create a dedicated Python environment.
3. From LightWin folder: pip install -e .[test, cython]
4. Test that everything is working with pytest -m "not tracewin and not implementation".

Note

If you are completely new to Python and these instructions are unclear, check this tutorial. In particular, you will want to:

1. Install Python 3.12 or higher.
2. Learn to use Python environments, pipenv or virtualenv.
3. Install a Python IDE such as Spyder or VSCode.

Note

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 now automatically built and hosted on Read the docs.

How to run

See documentation.

Example

See the data/example folder.