diff --git a/README.md b/README.md index 9153aea91330a90c9bb7ca77092d0a1a2903874e..7193f7dabe77b48c0ef9c89d93d438789bba5b56 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# 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: ``` diff --git a/docs/index.md b/docs/index.md index 18c8f5d13f28d4c4d7047f19e73f214da10e0b7a..ecca901e3b544aa95d49155da78dac7f4efdac7f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,10 +1,10 @@ -# 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/).
- + Image 1
diff --git a/docs/install/install.md b/docs/install/install.md index 7fe549d7eeaa23105271d364ef125faea0073d46..fadd7077bd7edfc94abe1567c7d4aa3cb693e011 100644 --- a/docs/install/install.md +++ b/docs/install/install.md @@ -1,6 +1,6 @@ # 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: ``` diff --git a/docs/theory/geothermalresource/concepts.md b/docs/theory/geothermalresource/concepts.md index 93d2a030c665791a6495bff3468d5fa39ab5e7c2..6b7f250029d087b729e4a689938ed6c84bbaddb7 100644 --- a/docs/theory/geothermalresource/concepts.md +++ b/docs/theory/geothermalresource/concepts.md @@ -1,6 +1,6 @@ # 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, diff --git a/docs/theory/introduction.md b/docs/theory/introduction.md index 49c24a43c0f1f63c675030db2a8c90ec5d9ca111..f6da3a29ef14d76c8d9b02d1f37dc45a4fd8ef85 100644 --- a/docs/theory/introduction.md +++ b/docs/theory/introduction.md @@ -1,10 +1,10 @@ -# 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 diff --git a/docs/theory/utcprops/contents.md b/docs/theory/utcprops/contents.md index 9080ef679671b57eaa882bf5e3866f615f8ae52a..283a1fbc471252603752ca66be0b07461a38b65b 100644 --- a/docs/theory/utcprops/contents.md +++ b/docs/theory/utcprops/contents.md @@ -1,7 +1,7 @@ -# 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 | |-----|--------------------------------------------------------------------------| diff --git a/docs/theory/utcprops/utc_props_TG.md b/docs/theory/utcprops/utc_props_TG.md index 465b9c1f8e13a8d80d1e2abc47696d9fddd6e8fb..e77a8ac06fb5943e97bc397f61bee4d38a4d9b4d 100644 --- a/docs/theory/utcprops/utc_props_TG.md +++ b/docs/theory/utcprops/utc_props_TG.md @@ -1,4 +1,4 @@ -# 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`: diff --git a/docs/theory/utcprops/utc_props_ga4a.md b/docs/theory/utcprops/utc_props_ga4a.md index 5f6e50305c0f4c41c7575a5e84e94c0f3ef6b24a..e3b07f8d005bfe4cdbb409ae97305ac945957fdf 100644 --- a/docs/theory/utcprops/utc_props_ga4a.md +++ b/docs/theory/utcprops/utc_props_ga4a.md @@ -1,4 +1,4 @@ -# 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`: diff --git a/docs/usage/contents.md b/docs/usage/contents.md index cbf862f24683d2fac3e3ab8fa10f7399989765e8..ba2f17c8231f6ec0dcbf18661e0a825b22dda685 100644 --- a/docs/usage/contents.md +++ b/docs/usage/contents.md @@ -1,6 +1,6 @@ -# 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). @@ -14,7 +14,7 @@ The underlying theory of the geothermal doublet simulation is explained in the [ - [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.