LightWin
  • Installation
    • Simple installation (recommended)
    • Building from source (for developers)
    • TraceWin (facultative)
    • Cython setup (should be automatic)
    • Testing (for developers)
    • Troubleshooting
  • Usage
  • Example notebooks
  • The get method
  • Configuration
  • Units and conventions
  • Utility scripts
  • Bibliography
  • API Reference
  • Contributing
  • Changelog
LightWin
  • Installation
  • Simple installation (recommended)
  • View page source

Simple installation (recommended)

You will need Python 3.12 or higher. If you run a 32-bits Windows system, you will also need a C compiler. Set up a virtual environment; instructions will vary according to you installation.

Python’s built-in venv module is the recommended way to create a virtual environment.

python -m venv venv

Activate the environment:

  • On macOS/Linux:

    source venv/bin/activate
    
  • On Windows:

    venv\Scripts\activate
    

If you prefer virtualenv, install it first:

pip install virtualenv
virtualenv venv

Activate the environment:

  • On macOS/Linux:

    source venv/bin/activate
    
  • On Windows:

    venv\Scripts\activate
    

If you manage environments with Conda:

conda create --name lightwin python=3.x
conda activate lightwin

Once it is activated, run the following command:

pip install lightwin[cython]

Note that Cython is not mandatory, but speeds up calculations. If you run into a Cython related issue, you can always:

pip install lightwin
Previous Next

© Copyright 2026, A. Plaçais, F. Bouly, J.-M. Lagniel, D. Uriot, B. Yee-Rendon.

Built with Sphinx using a theme provided by Read the Docs.