**pyThermoGIS** is a Python package that provides API access to the [ThermoGIS](https://www.thermogis.nl/en) doublet simulations and economic calculations.
**pyThermoGIS** is a Python package that provides API access to the [ThermoGIS](https://www.thermogis.nl/en) doublet simulations and economic calculations, ThermoGIS is developed and maintained by the [Geological Survey of the Netherlands](https://www.geologischedienst.nl/en/) which is part of [TNO](https://www.tno.nl/en/). Additionally, pythermogis was also partially developed by and for the [GoForward](https://go-forward-project.eu/) project.
Read the full documenation [here](https://pythermogis-15909e.ci.tno.nl/).
If you wish to build the documentation locally, run:
If you wish to build the documentation locally, follow the installation steps and run:
```bash
pixi run mkdocs serve
@@ -12,9 +12,9 @@ pixi run mkdocs serve
# Installation
PyThermoGIS has been designed to be used in one of two ways; either as a python package you import into your own python projects, or as a standalone package where you can access the calculations via a CLI.
Either way, you need to Install a Java 17 VM and store the ThermoGIS Jar:
PyThermoGIS has been designed to be used as a python package you import into your own python projects.
It works by creating python API access to the ThermoGIS techno-economic application, which is written in Java.
Because of this dependency you need to Install a Java 17 VM and store the ThermoGIS Jar (a Java executable file):
### 1. Install Java 17 and Download the ThermoGIS JAR
This package requires a Java 17 VM (we recommend using [Amazon Corretto 17](https://docs.aws.amazon.com/corretto/latest/corretto-17-ug/downloads-list.html)) and a ThermoGIS Jar file (Version >=1.7).
@@ -31,17 +31,17 @@ This package requires a Java 17 VM (we recommend using [Amazon Corretto 17](http
---
### 2a) import pyThermoGIS into your own python projects
### Import pyThermoGIS into your own python projects
This repository is currently hosted privately on [ci.tno.nl](https://ci.tno.nl) and will become publicly available in the future.
This repository is currently hosted privately on [ci.tno.nl](https://ci.tno.nl) and is only accessible to TNO employees. The intention is that this package will become publicly available in the near future.
Until then you will need to use Gitlab API keys to use this module:
Until then, you will need to use Gitlab API keys to use this module:
#### 🔐 Step-by-step Installation
##### a. Create a Personal Access Token (PAT)
1. Log in to GitLab.
1. Log in to the TNO GitLab.
2. Navigate to **Preferences > Access Tokens**.
3. Create a token with the following scopes:
-`read_api`
@@ -54,11 +54,11 @@ Until then you will need to use Gitlab API keys to use this module:
**pyThermoGIS** is a Python package that provides API access to the [ThermoGIS](https://www.thermogis.nl/en) doublet simulations and economic calculations, ThermoGIS is developed by the [Geological Survey of the Netherlands](https://www.geologischedienst.nl/en/) which is part of [TNO](https://www.tno.nl/en/).
**pyThermoGIS** is a Python package that provides API access to the [ThermoGIS](https://www.thermogis.nl/en) doublet simulations and economic calculations, ThermoGIS is developed and maintained by the [Geological Survey of the Netherlands](https://www.geologischedienst.nl/en/) which is part of [TNO](https://www.tno.nl/en/).
The intended usage of this pacakge is to import into your own projects so you can run your own doublet simulations using your own input parameters or statistical frameworks.
Additionally, pythermogis was also partially developed by and for the [GoForward](https://go-forward-project.eu/) project:
The intended usage of this pacakge is to import into your own projects so you can run your own doublet simulations.
Detailed examples can be found in the [usage](usage/contents.md) documentation page.
This package allows a user to simulate geothermal doublets providing the following parameters:
@@ -40,7 +47,6 @@ The reason to do so is to avoid attributing produced energy which is not renewab
For details on how these parameters are calculated we refer users to the theory section as well as [Thermogis calculation webpage](https://www.thermogis.nl/en/calculation-model).
For energy conversion to electricity, and chill the power concerns net electricty production and net chill respectively
The simulations are conducted in Java, and this package uses [JPype](https://jpype.readthedocs.io/en/latest/userguide.html) to create a Python-Java binding.
PyThermoGIS has been designed to be used as a package you import into your own projects.
A number of examples have been provided to show how to setup your own simulations and develop your own statistical frameworks.
# Installation
Under the hood PyThermoGIS runs the ThermoGIS code, which is written in Java, so you need to install a Java interpreter and have a file of the ThermoGIS Jar:
PyThermoGIS has been designed to be used as a python package you import into your own python projects.
It works by creating python API access to the ThermoGIS techno-economic application, which is written in Java.
Because of this dependency you need to Install a Java 17 VM and store the ThermoGIS Jar (a Java executable file):
## 1. Install Java 17 and Download the ThermoGIS JAR
### 1. Install Java 17 and Download the ThermoGIS JAR
This package requires a Java 17 VM (we recommend using [Amazon Corretto 17](https://docs.aws.amazon.com/corretto/latest/corretto-17-ug/downloads-list.html)) and a ThermoGIS Jar file (Version >=1.7).
*(You can find the JAR in this repository's resources folder or request it via the [ThermoGIS website](https://www.thermogis.nl/).)*
### 🧱 Required Environment Variables
#### 🧱 Required Environment Variables
-`JAVA_HOME`: Path to the Java 17 installation
*(e.g., on Windows: `C:\Program Files\Amazon Corretto\jdk17.0.0_0`)*
@@ -21,34 +21,34 @@ This package requires a Java 17 VM (we recommend using [Amazon Corretto 17](http
---
## import pyThermoGIS into your own python projects
### Import pyThermoGIS into your own python projects
This repository is currently hosted privately on [ci.tno.nl](https://ci.tno.nl) and will become publicly available in the future.
This repository is currently hosted privately on [ci.tno.nl](https://ci.tno.nl) and is only accessible to TNO employees. The intention is that this package will become publicly available in the near future.
Until then you will need to use Gitlab API keys to use this module:
Until then, you will need to use Gitlab API keys to use this module:
### 🔐 Step-by-step Installation
#### 🔐 Step-by-step Installation
##### a. Create a Personal Access Token (PAT)
1. Log in to GitLab.
1. Log in to the TNO GitLab.
2. Navigate to **Preferences > Access Tokens**.
3. Create a token with the following scopes:
-`read_api`
-`read_package_registry`
4. Copy and store the token securely (you won’t be able to see it again).
