Python (mandatory)

LightWin requires Python 3.12 or higher. Ensure that you have an appropriate version of Python installed on your system. If not, you can download the latest version from the official Python website.

Packages

Mandatory

The following packages are mandatory for LightWin to execute:

matplotlib
numpy
palettable
pandas
scipy
tkinter
pymoo - This package is used for genetic optimization algorithms. If you prefer not to use pymoo, you can remove the related imports in fault.py and fault_scenario.py.

Optional

cython - Used to speed up calculations. Check cython integration documentation.

Note: Installing cython prior to pymoo enable compilation of some pymoo functions for improved performance.

pytest - To run tests and ensure everything is working as expected.
cloudpickle - To pickle/unpickle some objects (see the util.pickling documentation).

For developers

To compile the documentation, the following packages are necessary:

sphinx_rtd_theme
myst-parser
nbsphinx

The files are formatted with black.

Reminders

Installation of a package

To install a package, use the appropriate method based on your environment:

If using pip:
```
pip install <package>
```
If using conda, avoid mixing with pip to prevent potential conflicts. Instead, use:
```
conda install <package>
```

Note

Since pymoo is not available on the default Anaconda channels, you should create a conda environment and use conda-forge:

conda create -n <env-name> -c conda-forge python=3.12
conda activate <env-name>
conda install cython matplotlib numpy palettable pandas scipy tkinter pymoo pytest -c conda-forge

Always specify -c conda-forge when installing or updating packages.

Warning

pip and conda are not fully compatible. Avoid using them together, or create a dedicated environment to prevent conflicts. For more details, you may refer to this video.

Set up the Python Path

You must add the /path/to/lightwin/source directory to your PYTHONPATH environment variable.

Todo

Consider providing more detailed instructions for setting the PYTHONPATH. For now, you can search for “PYTHONPATH” or “ModuleNotFoundError” online for additional guidance.