TNO Intern

Commit 47458665 authored by Hen Brett's avatar Hen Brett 🐔
Browse files

Merge branch '80-rename-everything-to-pythermogis-in-the-documentation' into 'main' 

Resolve "rename everything to pythermogis in the documentation"

Closes #80

See merge request !96
parents e500f2a2 07004f7a

README.md

+4 −4
Original line number Diff line number Diff line 
# 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/).
@@ -14,7 +14,7 @@ pixi run mkdocs serve 


# 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:
@@ -38,7 +38,7 @@ This file should contain the following variables: 
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:

```

docs/index.md

+3 −3
Original line number Diff line number Diff line 
# 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;">

docs/install/install.md

+2 −2
Original line number Diff line number Diff line 
# 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:
@@ -25,7 +25,7 @@ Example: 
![img.png](../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:

```

docs/theory/geothermalresource/concepts.md

+1 −1
Original line number Diff line number Diff line 
# Geothermal Resource



In pyThermoGIS we consider reservoirs with natural permeability.

In pythermogis we consider reservoirs with natural permeability.

These can be sedimentary rocks and (fractured) basement/magmatic geothermal reservoirs.



- [Sedimentary rocks](sedimentary_basin.md): These are typically characterized by their stratigraphy,

docs/theory/introduction.md

+4 −4
Original line number Diff line number Diff line 
#  pyThermoGIS calculation methods

#  pythermogis calculation methods



## introduction







pyThermoGIS is a Python package that provides API access to pre-drill doublet simulations and economic calculations implemented in ThermoGIS.

pythermogis is a Python package that provides API access to pre-drill doublet simulations and economic calculations implemented in ThermoGIS.

[ThermoGIS](https://www.thermogis.nl/en) is a web-based information system for geothermal prospectivity that has originally been developed to support Geothermal development in the Netherlands, 

and has promoted a very successful geothermal energy development for direct heating.

Over the past two decades, 84 deep geothermal wells in a depth range of 1500-3000 m have been drilled
@@ -16,11 +16,11 @@ In the EU27, Netherlands ranks first in terms of exploited geothermal heating an 
and third in terms of the number of installed geothermal plants for geothermal district heating (EGEC, 2024). 

The first successful deep geothermal system was completed less than 20 years ago in 2007. 

 

At the heart of pyThermoGIS and [ThermoGIS](https://www.thermogis.nl/en) is the [DoubletCalc1D](https://www.nlog.nl/en/tools) doublet technical performance assesment tool (van Wees et al., 2012), 

At the heart of pythermogis and [ThermoGIS](https://www.thermogis.nl/en) is the [DoubletCalc1D](https://www.nlog.nl/en/tools) doublet technical performance assesment tool (van Wees et al., 2012), 

which is a software tool developed by TNO that calculates how much geothermal water can be pumped at a given pump power, 

taking into account well engineering aspects and specific subsurface conditions, including aquifer temperature, and reservoir flow properties.



pyThermoGIS is very flexible and  can be applied for:

pythermogis is very flexible and  can be applied for:



- site-specific analysis

- grid input based  reservoir properties