TNO Intern

Resolve "rename everything to pythermogis in the documentation"

Hen Brettrequested to merge
80-rename-everything-to-pythermogis-in-the-documentation into main

Closes #80 (closed)

Merge request reports

docs/install/install.md

+2 −2
Changes for docs/install/install.md: 2 added lines, 2 removed lines.
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
Changes for docs/theory/geothermalresource/concepts.md: 1 added line, 1 removed line.
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/utcprops/contents.md

+4 −4
Changes for docs/theory/utcprops/contents.md: 4 added lines, 4 removed lines.
Original line number Diff line number Diff line 
#  Pythermogis Default and Custom Properties

#  pythermogis Default and Custom Properties





The default and custom properties in Pythermogis can be found in the`tests/resources/scenarios` directory. 

The default and custom properties in pythermogis can be found in the`tests/resources/scenarios` directory. 



The default properties are defined in the `doublet_techno-econ_basecase.xml` file,
@@ -15,7 +15,7 @@ while various use-case scenarios have been defined based on modifications to the 
## default properties 





The default properties of Pythermogis are defined in the `doublet_techno-econ_basecase.xml` 

The default properties of pythermogis are defined in the `doublet_techno-econ_basecase.xml` 

file located in the `tests/resources/scenarios` directory

The default properties are as follows in xml (and corresponding shortnames used throughout this documentation)
@@ -96,7 +96,7 @@ The default properties are as follows in xml (and corresponding shortnames used 
The XML files for thermogis contain more parapeters than the ones listed above, which is

required for compatibility with the DoubletCalc1D java code. Parameter names which need 

to be set in the XML file are listed below, and include the ones lister above

parameters marked by * are not of relevance for pyThermogis, but are required for compatibility with the DoubletCalc1D java code.

parameters marked by * are not of relevance for pythermogis, but are required for compatibility with the DoubletCalc1D java code.



| #   | Parameter Name                                                           |

|-----|--------------------------------------------------------------------------|

docs/theory/utcprops/utc_props_TG.md

+1 −1
Changes for docs/theory/utcprops/utc_props_TG.md: 1 added line, 1 removed line.
Original line number Diff line number Diff line 
#  Pythermogis ThermoGIS NL Properties

#  pythermogis ThermoGIS NL Properties





pythermogis scenarios which have been used for [thermoGIS](https://www.thermogis.nl) are defined through the following xml files in `tests/resources/scenarios`:

docs/theory/utcprops/utc_props_ga4a.md

+1 −1
Changes for docs/theory/utcprops/utc_props_ga4a.md: 1 added line, 1 removed line.
Original line number Diff line number Diff line 
#  Pythermogis Geothermal Atlas for Africa Properties

#  pythermogis Geothermal Atlas for Africa Properties



pythermogis scenarios which have been used for [Geothermal Atlas for Africa](https://gaa-proxy.azurewebsites.net/) are defined through the following xml files in `tests/resources/scenarios`: