Welcome to LightWin’s documentation!

PyPI - Python Version

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

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

Developers

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.

Create a dedicated Python environment.
From LightWin folder: pip install -e .[test, cython]
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:

Install Python 3.12 or higher.

Learn to use Python environments, pipenv or virtualenv.

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.