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.

Installing Python 3

Most Linux distributions will have Python 3 in their repository. Use the specific software management to install it, if it is not yet installed. If you are using Ubuntu/Debian try executing the following code in your terminal:

sudo apt-get install python3

You can also download different versions of Python via https://www.python.org/downloads/.

Having Python 3 installed

We recommend installing TESPy within a virtual Python environment and not into the base, system-wide Python installation. On Linux you can use virtualenv to do so.

  1. Install virtualenv using the package management of your Linux distribution, pip install or install it from source (see virtualenv documentation)

  2. Open terminal to create and activate a virtual environment by typing:

    virtualenv -p /usr/bin/python3 your_env_name
    source your_env_name/bin/activate
    
  3. In terminal type: pip install tespy

Warning: If you have an older version of virtualenv you should update pip pip install --upgrade pip.

Using Conda

Alternatively you can use conda for environment and package management. You can follow the installation instructions for windows users.

For windows we recommend using conda as package manager. You can download a lightweight open source variant of conda: “miniforge3”.

  1. Download latest miniforge3 for Python 3.x (64 or 32 bit).

  2. Install miniforge3

  3. Open “miniforge prompt” to manage your virtual environments. You can create a new environment and acivate it by

    conda create -n tespy-env python=3.9
    activate tespy-env
    
  4. In the active prompt type: pip install tespy

If you would like to get access to not yet released features or features under development you can install the developer version. The steps are similar to the steps here, but INSTEAD of installing TESPy using

pip install tespy

follow the instructions on this page.