This Python module implements the ITR methodology, elaborated in this Functional Overview. A graphical representation of the fundamental calculations is also available in the docs directory.

If you use Anaconda environments, open an Anaconda prompt window, navigate to the 'examples' directory and run:

conda env create -f environment.yml
conda activate itr_ui
python ITR_UI.py

For virtual environments, open a command prompt/terminal window, navigate to the 'examples' directory and run:

python3 -m venv itr_ui

On Unix or MacOS, activate the environment with

source itr_ui/bin/activate

On Windows, activate the environment with

itr_ui\Scripts\activate.bat

Next, run:

python3 -m pip install --upgrade pip
pip install -r requirements.txt
python3 ITR_UI.py

Finally, open a browser window and navigate to http://127.0.0.1:8050/ to access the user interface.

To work with notebooks from the 'examples' directory please register the kernel from your virtual environment such that it is available in Jupyter. Kernels from Anaconda environments will be available by default. Replace <env_name> in the following command by your environment name (itr_ui or itr_env) and run it in your environment.

python -m ipykernel install --user --name=<env_name>

Start Jupyter by activating your environment and running

jupyter-notebook

If you use Anaconda environments, open an Anaconda prompt window, navigate to the project directory and run:

conda env create -f environment.yml
conda activate itr_env

For virtual environments, open a command prompt/terminal window, navigate to the project directory and run:

python3 -m venv itr_env

On Unix or MacOS, activate the environment with

source itr_env/bin/activate

On Windows, activate the environment with

itr_env\Scripts\activate.bat

Next, run:

python3 -m pip install --upgrade pip
pip install -r requirements.txt
pip install -e .[dev]