Installation and setup

Following you find guidelines for the installation process for linux and windows. TESPy is a Python package, thus it requires you to have Python 3 installed.

uv (recommended)

uv is a fast Python package and project manager. Install it by following the official instructions, then initialise a new project and add TESPy:

uv init my-project
cd my-project
uv add tespy

To include the optional optimisation dependencies:

uv add tespy[opt]

pip

We recommend installing TESPy within a virtual Python environment. Create and activate one, then install TESPy via pip:

python -m venv tespy-env
source tespy-env/bin/activate  # Linux/macOS
# tespy-env\Scripts\activate   # Windows
pip install tespy

To include the optional optimisation dependencies:

pip install tespy[opt]

conda

TESPy is available on conda-forge. You can install it into a new or existing conda environment:

conda install -c conda-forge tespy

Developer Version

If you would like to get access to not yet released features or features under development you can install the developer version. Fork and clone the TESPy repository, then install all development dependencies with uv:

cd tespy
uv sync --extra dev

Alternatively, follow the instructions on this page.