Installation

Prerequisites

ILTpy is compatible with python versions 3.9 to 3.13.
ILTpy can be installed using python’s package manager, pip.
To install and use ILTpy, Python must be installed on your device and be available on system PATH.
Python is available for download at the official website.

Check the Python installation by executing in a terminal (or command prompt) :

python --version
#  Note that the alias for ``python`` may be ``python3`` on your system.

This should display the python version. Confirm that the python version is compatible with ILTpy. Other Dependencies are listed below.

Dependencies

3.9 <= Python < 3.14
1.13.1 <= SciPy <=1.16.0
1.25.1 < NumPy <= 2.3.1
1.4.2 <= joblib <=1.5.1
tqdm

Since ILTpy will install compatible versions of dependencies, you might want to use a python virtual environment to avoid conflicts with other libraries.

Installing ILTpy

Install using pip from PyPi

Run the following in a terminal (or command prompt) :

python -m pip install ilt-py-lib

Install using pip from FZJ’s app server

Run the following in a terminal (or command prompt) :

python -m pip install --index-url https://apps.fz-juelich.de/iltpy/packages --extra-index-url https://pypi.org/simple ilt-py-lib

Install from source

ILTpy is hosted on JuGit, which is the Gitlab server of Forshungszentrum Jülich. Clone the ILTpy git repository to download the source code. This can be done by executing the following command in a terminal (or command prompt) if you have git installed :

git clone https://jugit.fz-juelich.de/iet-1/iltpy.git

Alternatively, download the source code by clicking the Code button (top-right) on the ILTpy git repository and extracting the archive.

Navigate to the local directory where ILTpy was downloaded/extracted. The ILTpy directory should contain a setup.py file along with other folders. While inside the ILTpy directory, run the following command in a terminal (or command prompt) :

python -m pip install .

Note

If you would like to install ILTpy for development or if you want to contribute to ILTpy, please consult ILTpy’s contribution guidelines.

Along with ILTpy, the following python libraries required by ILTpy will also be installed :

SciPy : Fundamental algorithms for scientific computing in Python
NumPy : The fundamental package for scientific computing with Python
Joblib : Running Python functions as pipeline jobs
tqdm: A Fast, Extensible Progress Bar for Python

Optionally, you might also want to install matplotlib for plotting results generated using ILTpy and using the in-built plotting function iltplot. To install matplotlib, run in a terminal :

python -m pip install matplotlib

For using ILTpy in an interactive python environment such as IPython, jupyter notebook or jupyterlab is recommended.

Importing ILTpy

If the installation is successful, you can try importing ILTpy and printing the version as shown below.

import iltpy as ilt
print(ilt.__version__)

Upgrading ILTpy

Installed from PyPi

Run the following in a terminal (or command prompt) :

python -m pip install ilt-py-lib --upgrade

Installed from FZJ’s app server

Run the following in a terminal (or command prompt) :

python -m pip install --index-url https://apps.fz-juelich.de/iltpy/packages --extra-index-url https://pypi.org/simple ilt-py-lib --upgrade

Installed from source

Navigate to the local directory where ILTpy was downloaded/extracted. Run the following commands in a terminal (or command prompt) :

git pull origin main
python -m pip install .