Denis Anikiev committed Feb 18, 2022 1 ``````# Py4HIP `````` Denis Anikiev committed Apr 08, 2022 2 ``````**Py4HIP**: **Py**thon tool **for** **H**eat-**I**n-**P**lace calculations `````` Denis Anikiev committed Feb 21, 2022 3 4 5 6 `````` ## Contents [TOC] `````` Denis Anikiev committed Apr 05, 2022 7 ``````## Description `````` Denis Anikiev committed Apr 05, 2022 8 ``````**Py4HIP** is implemented as a self-explanatory [Jupyter notebook](https://jupyter-notebook-beginner-guide.readthedocs.io/en/latest/what_is_jupyter.html) [Py4HIP.ipynb](./Py4HIP.ipynb). `````` Denis Anikiev committed Apr 05, 2022 9 `````` `````` Denis Anikiev committed Apr 08, 2022 10 11 12 13 14 ``````Calculation of the Heat In Place (HIP) for certain geological units or confined reservoirs is a standard method performed in various regions to assess the spatial variability of geothermal potential ([Nathenson, 1975](#Nathenson1975); [Muffler and Cataldi, 1978](#MufflerCataldi1978); [Garg and Combs, 2015](#GargCombs2015)). The respective implementation in **Py4HIP** is based on a volumetric quantification of contained energy after [Muffler and Cataldi (1978)](#MufflerCataldi1978), where the geological unit at hand is considered as spatially variable in terms of its thickness, porosity, as well as density and specific heat capacity. **Py4HIP** calculations take into account the pore fluid density and the salinity effect. The energy values provided by **Py4HIP** as ASCII lists and map representations correspond to the stored energy in \$J/m^2\$. `````` Denis Anikiev committed Apr 05, 2022 15 16 17 ``````## Getting started ### Requirements `````` Denis Anikiev committed Apr 05, 2022 18 ``````**Py4HIP** requires [Python](https://www.python.org/) >= 3.5, [JupyterLab](https://jupyterlab.readthedocs.io/en/stable/), and uses the following packages: `````` Denis Anikiev committed Apr 05, 2022 19 20 ``````- [numpy](https://github.com/numpy/numpy) - [pandas](https://github.com/pandas-dev/pandas) `````` Denis Anikiev committed Apr 05, 2022 21 22 ``````- [pathlib](https://docs.python.org/3/library/pathlib.html) (for creating folders) - [matplotlib](https://github.com/matplotlib/matplotlib) (for plotting figures) `````` Denis Anikiev committed Apr 05, 2022 23 24 `````` ### Installation `````` Denis Anikiev committed Apr 05, 2022 25 ``````The following instructions explain how to install the required packages with [`conda`](https://docs.conda.io/en/latest/). `````` Denis Anikiev committed Apr 05, 2022 26 `````` `````` Denis Anikiev committed Apr 05, 2022 27 ``````We recommend to use [miniforge](https://github.com/conda-forge/miniforge) for working with conda. `````` Denis Anikiev committed Apr 05, 2022 28 `````` `````` Denis Anikiev committed Apr 05, 2022 29 ``````1. To install the required packages open conda prompt and run: `````` Denis Anikiev committed Apr 05, 2022 30 ````````` `````` Denis Anikiev committed May 20, 2022 31 ``````conda install -y numpy pandas pathlib matplotlib `````` Denis Anikiev committed Apr 05, 2022 32 33 34 35 ````````` **Note:** you may want to use a specific [conda environment](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html). `````` Denis Anikiev committed Apr 05, 2022 36 ``````2. Install the JupyterLab: `````` Denis Anikiev committed Apr 05, 2022 37 38 39 40 ````````` conda install -y jupyterlab ``` `````` Denis Anikiev committed Apr 05, 2022 41 ``````3. Get the tool by cloning the git repository using [Git](https://git-scm.com/): `````` Denis Anikiev committed Feb 22, 2022 42 43 44 45 46 47 48 `````````bash git clone git@git.gfz-potsdam.de:basin-modelling/python/py4hip.git ``` or ```bash git clone https://git.gfz-potsdam.de/basin-modelling/python/py4hip.git ``` `````` Denis Anikiev committed Apr 05, 2022 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 ``````Alternatively, load the package as [zip file](https://git.gfz-potsdam.de/basin-modelling/python/py4hip/-/archive/main/py4hip-main.zip). ### How to run 1. Open conda prompt and start JupyterLab using: ``` jupyter lab ``` You may access JupyterLab by opening the notebook server’s URL in the browser, usually `http://localhost:8888/lab` wihch you can find in the output, e.g. ``` To access the server, open this file in a browser: Or copy and paste one of these URLs: or ``` It often necessary to insert the token generated after server has started. You can find this in the command output after `token=`, e.g.: ``` http://localhost:8888/lab?token=73e08328facee92d67a8dd2b587b6fa7cb8a3e3323d653f8 ``` 2. In the JupyterLab interface open [Py4HIP.ipynb](./Py4HIP.ipynb) 3. Read the instructions and run `````` Denis Anikiev committed Feb 22, 2022 73 74 `````` ## License `````` Denis Anikiev committed Apr 08, 2022 75 ``````**Py4HIP** is [licensed](./LICENSE) under the [EUROPEAN UNION PUBLIC LICENCE (EUPL) v. 1.2](https://joinup.ec.europa.eu/collection/eupl/introduction-eupl-licence). `````` Denis Anikiev committed Apr 05, 2022 76 `````` `````` Denis Anikiev committed Feb 21, 2022 77 ``````## Citation `````` Denis Anikiev committed Apr 05, 2022 78 ``````Please cite **Py4HIP** as follows:\ `````` Denis Anikiev committed May 23, 2022 79 ``````*Bott, J., Benoit, L., Koltzer, N., & Anikiev, D. (2022). Py4HIP: Python tool for Heat-In-Place calculations. GFZ Data Services. https://doi.org/10.5880/GFZ.4.5.2022.001* `````` Denis Anikiev committed Feb 22, 2022 80 `````` `````` Denis Anikiev committed Apr 08, 2022 81 82 ``````Citation bib file: [CITATION.bib](./CITATION.bib) `````` Denis Anikiev committed Feb 22, 2022 83 ``````## Authors and contributions `````` Denis Anikiev committed Apr 05, 2022 84 ``````See also the list of [authors](../AUTHORS.md) who participated in this project. `````` Denis Anikiev committed Apr 05, 2022 85 ``````If you what to contribute to this project please follow the [contributing guidelines](../CONTRIBUTING.md). `````` Denis Anikiev committed Feb 22, 2022 86 87 `````` ## Acknowledgments `````` Denis Anikiev committed Apr 05, 2022 88 ``````We are grateful to all colleagues who supported the project. `````` Denis Anikiev committed Feb 21, 2022 89 `````` `````` Denis Anikiev committed Apr 08, 2022 90 ``````## References `````` Denis Anikiev committed Apr 08, 2022 91 `````` `````` Denis Anikiev committed Apr 08, 2022 92 93 ``````Bär, K. M. (2012). Untersuchung der tiefengeothermischen Potenziale von Hessen. (Ph.D. Thesis). TU Darmstadt, Darmstadt. https://tuprints.ulb.tu-darmstadt.de/3067/ `````` Denis Anikiev committed Apr 08, 2022 94 `````` `````` Denis Anikiev committed Apr 08, 2022 95 96 ``````Batzle, M., & Wang, Z. (1992). Seismic properties of pore fluids. Geophysics, 57(11), 1396-1408. https://www.doi.org/10.1190/1.1443207 `````` Denis Anikiev committed Apr 08, 2022 97 `````` `````` Denis Anikiev committed Apr 08, 2022 98 99 100 ``````Garg, S. K., & Combs, J. (2015). A reformulation of USGS volumetric “heat in place” resource estimation method. Geothermics, 55, 150-158. https://www.doi.org/10.1016/j.geothermics.2015.02.004 `````` Denis Anikiev committed Apr 08, 2022 101 `````` `````` Denis Anikiev committed Apr 08, 2022 102 103 104 ``````Muffler, P., & Cataldi, R. (1978). Methods for regional assessment of geothermal resources. Geothermics, 7(2-4), 53-89. https://www.doi.org/10.1016/0375-6505(78)90002-0 `````` Denis Anikiev committed Apr 08, 2022 105 `````` `````` Denis Anikiev committed Apr 08, 2022 106 107 ``````Nathenson, M. (1975). Physical factors determining the fraction of stored energy recoverable from hydrothermal convection systems and conduction-dominated areas (No. USGS-OFR-75-525). Geological Survey, Menlo Park, Calif.(USA). https://www.doi.org/10.2172/7348122 `````` Denis Anikiev committed Apr 08, 2022 108 `````` `````` Denis Anikiev committed Apr 08, 2022 109 110 111 ``````Vosteen, H.-D., & Schellschmidt, R. (2003). Influence of temperature on thermal conductivity, thermal capacity and thermal diffusivity for different types of rock. Physics and Chemistry of the Earth, Parts A/B/C, 28(9-11), 499-509. https://doi.org/10.1016/S1474-7065(03)00069-X `````` Denis Anikiev committed Apr 08, 2022 112 113 ``````References are available as [a bib file](./references.bib). `````` Denis Anikiev committed Feb 22, 2022 114 ``````## Contact `````` Denis Anikiev committed Feb 22, 2022 115 ``[Judith Bott](@sippel): judith.bott@gfz-potsdam.de``