Building from source (for developers)

Pre-requisites:

• Python 3.12 or higher.

• A C++ compiler. On Unix systems, install gcc. On Windows, check here.

Cloning the repository

Download the source from GitHub.

git clone git@github.com:AdrienPlacais/LightWin.git

Alternatively, you can download the code as a .zip file from the repository’s page. However, please note that using this method requires manually downloading updates whenever changes are made to the repository.

Installation

Navigate to the LightWin folder. Create and activate a Python environment (see instructions). Install and test with:

pip install -e .[test]
pytest -m "not tracewin"

Setting up TraceWin requires additional steps.

Hint

If you encounter issues with the [test] extra dependency, try escaping the brackets:

pip install -e .\[test\]

If you want to install LightWin with conda, you will have to manually install all the dependencies listed in the pyproject.toml file.