changing the spelling of pythermogis to lowercase everywhere

# pyThermoGIS

# pythermogis

**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.

**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/).

# Installation

PyThermoGIS has been designed to be used as a python package you import into your own python projects.

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 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) on your computer:

Example:

![img.png](docs/images/dotenv_file_example.png)

### 3. Import pyThermoGIS into your own python projects

### 3. Import pythermogis into your own python projects

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

```

# pyThermoGIS

# pythermogis

**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/).

**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/).

<div style="display: flex; gap: 10px;">

  <img src="../images/pyThermoGIS_transparent.png" style="width: 20%; max-width: 600px; height: auto;">

  <img src="../images/pythermogis_transparent.png" style="width: 20%; max-width: 600px; height: auto;">

  <img src="../images/GeologischeDienstlogo.png" alt="Image 1" style="width: 100%; max-width: 600px; height: auto;">

</div>

<div style="display: flex; gap: 10px;">

#  Pythermogis Usage - Examples

#  pythermogis Usage - Examples

Through a number examples the core functionality of **pyThermoGIS** is explained.  Many aspects 

Through a number examples the core functionality of **pythermogis** is explained.  Many aspects 

of the these examples can also be found in the  tests.

The underlying theory of the geothermal doublet simulation is explained in the [theory section](../theory/introduction.md).

- [parallelization](parallelization.md) page describes how to parallelize simulations and determine the optimal chunk size for parallelization for your hardware

!!! info "Plotting, calculations and result analysis"

    pyThermoGIS is designed to enable users to run geothermal doublet simulations. 

    pythermogis is designed to enable users to run geothermal doublet simulations. 

    Customized plotting is intentionally limited, as users often have specific preferences 

    for visual presentation. Rather than attempt to accommodate all 

    potential styles, our focus is on providing reliable simulation tools.