Installation¶

pythermogis is a Python package that provides API access to the ThermoGIS doublet simulations and economic calculations, ThermoGIS is developed and maintained by the Geological Survey of the Netherlands which is part of TNO, additionally, pythermogis was also partially developed by and for the GoForward project.

Read the full documenation here.

If you wish to build the documentation locally, follow the installation from source step and run:

pixi run mkdocs serve

Installation¶

pythermogis has been designed to be used as a python package you import into your own python projects. It works by creating a python API access to the Core ThermoGIS techno-economic application, which is written in Java.

The ThermoGIS techno-economic Core application is packaged within pythermogis, this is the reason the package is quite large (~150mb). Additionally the first time you run a simulation with pythermogis, a Java 17 Virtual machine (JVM) will be automatically installed (using the package install-jdk).

The Java 17 virtual machine is an additional ~350mb so there should be at least 500mb of space on any machine you install pythermogis on (and preferably more).

Installation of the JVM can take some time (0.5 - 2 minutes) depending on the speed of your internet connection, but will only be done once per pythermogis installation.

pythermogis has been tested on Windows and Linux operating systems.

1. Import pythermogis into your own python projects¶

You can use pip to install the package directly from the gitlab project:

pip install pythermogis --index-url https://ci.tno.nl/gitlab/api/v4/projects/18271/packages/pypi/simple

If you are using pixi as your dependency manager:

pixi run pip install pythermogis --index-url https://ci.tno.nl/gitlab/api/v4/projects/18271/packages/pypi/simple

If you are using uv as your dependency manager:

uv add pythermogis --default-index https://ci.tno.nl/gitlab/api/v4/projects/18271/packages/pypi/simple

2. Installation from source¶

Clone and install from source with Pixi:

git clone https://ci.tno.nl/gitlab/ags_public/pythermogis.git
cd pythermogis
pixi install