geoloop 0.0.1__py3-none-any.whl → 1.0.0__py3-none-any.whl

geoloop-1.0.0.dist-info/METADATA

@@ -0,0 +1,120 @@
+Metadata-Version: 2.4
+Name: geoloop
+Version: 1.0.0
+Summary: This is a Python package for simulation of (deep) vertical Borehole Heat Exchanger (BHE) systems
+Author-email: Zanne Korevaar <zanne.korevaar@tno.nl>, Jan-Diederik van Wees <jan_diederik.vanwees@tno.nl>
+License-Expression: Apache-2.0
+Keywords: borehole heat exchanger,BHE,geothermal,ground-source heat pump,deep borehole heat exchanger
+Requires-Python: <3.14,>=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: pygfunction>=2.2.2
+Requires-Dist: matplotlib>=3.10.1
+Requires-Dist: numpy>=2.2.4
+Requires-Dist: scipy>=1.7.3
+Requires-Dist: h5py>=3.4.0
+Requires-Dist: xarray>=2025.3.1
+Requires-Dist: pandas<3,>=2.2.3
+Requires-Dist: seaborn>=0.13.2
+Requires-Dist: tqdm>=4.67.1
+Requires-Dist: netCDF4>=1.7.2
+Requires-Dist: SecondaryCoolantProps>=1.3
+Requires-Dist: openpyxl>=3.1.5
+Requires-Dist: h5netcdf>=1.7.3
+Requires-Dist: pathlib>=1.0.1
+Requires-Dist: pydantic>=2.12.4
+Requires-Dist: typer>=0.20.0
+Dynamic: license-file
+
+# Geoloop: A BHE Calculator for Python
+
+[![PyPI](https://img.shields.io/pypi/v/geoloop.svg)](https://pypi.org/project/geoloop/)
+[![Documentation](https://img.shields.io/badge/docs-latest-blue)](https://geoloop-8f7a36.ci.tno.nl/)
+
+## What is **Geoloop**?
+
+**Geoloop** is a Python package for simulating vertical borehole heat exchanger (BHE) systems,
+with a focus on the impact of depth-dependent thermal properties and geothermal gradient and their impact on system performance.
+
+**Geoloop** incorporates (uncertainty in) depth-variations in subsurface thermal conductivity, subsurface temperature, 
+BHE design and diverse operational boundary conditions such as seasonal load variations or 
+minimum fluid temperatures. It allows for deterministic or stochastic performance analyses with the opportunity
+for optimization of the system design and operation. This makes Geoloop well suited for scenario analyses and sensitivity 
+studies in both research and practical applications.
+
+**Geoloop**  provides a novel depth-dependent approach for thermal response calculations. 
+A detailed description and benchmark of this depth-dependent semi-analytical method is provided in Korevaar et al. (2026).
+**Geoloop** uses the *pygfunction* package, developed by Cimmino & Cook (2022), including its implementation
+of *g*-functions, time aggregation schemes for varying loads, borehole and fluid thermal properties, and various visualization capabilities
+
+**Geoloop's** generic framework allows for easy switching between simulation methods, including the 
+depth-dependent model, the depth-uniform implementation of g-functions as implemented in *pygfunction* and a numerical 
+finite volume approach.
+
+---
+
+## Installation
+
+Install from PyPI using:
+
+```bash
+pip install geoloop
+```
+
+For detailed setup instructions (including uv-based environments and development setup),
+see the [Installation Guide](https://geoloop-8f7a36.ci.tno.nl/installation/install/).
+
+---
+
+## Requirements
+
+Geoloop requires **Python 3.12 or higher**.
+
+Core dependencies include:
+- pygfunction
+- matplotlib
+- numpy
+- scipy
+- h5py
+- xarray
+- pandas
+- seaborn
+- tqdm
+- netCDF4
+- SecondaryCoolantProps
+- openpyxl
+- h5netcdf
+- pathlib
+- pydantic
+- typer
+
+---
+
+## Quick Start
+
+Explore the [Examples](docs/examples/) folder to get started quickly with Geoloop.
+
+Read the full documenation [here](https://geoloop-8f7a36.ci.tno.nl/).
+
+---
+
+## License
+
+This project is licensed under the Apache 2.0 License.  
+See the [LICENSE.md](LICENSE.md) file for details.
+
+---
+
+## Acknowledgments
+
+Developed with the support of the Dutch funding agency **RVO**, in a consortium project with grant nr. MOOI322009.
+
+---
+
+
+## References
+
+- Cimmino, M. and Cook, J.: pygfunction 2.2: New features and improvements in accuracy and computational efficiency, 
+        in: Proceedings of the IGSHPA Research Track 2022, International Ground Source Heat Pump Association, 
+        https://doi.org/10.22488/okstate.22.000015, 2022. 
+- Korevaar, Z., Brett, H., Van Wees, J.D.: Geoloop (v1.0) – a stochastic, depth-dependent borehole heat exchanger model, Geoscientific Model Development (in prep), 2026

geoloop-1.0.0.dist-info/RECORD

@@ -0,0 +1,46 @@
+geoloop/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+geoloop/configuration.py,sha256=hYpskvpol_82Ai5RsGTcH7zBWLX8SYSSFSF0NBs21ig,33131
+geoloop/constants.py,sha256=F2fsh3e35Fp8AqNguPba6W96jaIAfsWazk1d6uzKi6I,2698
+geoloop/axisym/AxisymetricEL.py,sha256=uGERxWzt9PIixzyYqK_v2kBuOEye6ZhqqXVBBEbrRig,28218
+geoloop/axisym/__init__.py,sha256=s3Suw3X0GzuQKGvR1ia6RCYGa43Az8g4gtRgedkf2b0,84
+geoloop/bin/Flowdatamain.py,sha256=vwVn7y9jPH-6RU2_eH2tWLvcsbFFHDxi8APoQ5ug1J0,2566
+geoloop/bin/Lithologymain.py,sha256=8vzXVsLbleIp7FN0aM1Y6qrPfFeK0vaG9RuZC71rNsA,2839
+geoloop/bin/Loadprofilemain.py,sha256=A491o8eiImAfanjZrdJPGkbWgiW1L6-KeNazKTwJKVg,3218
+geoloop/bin/Plotmain.py,sha256=7D7lAjMSgyyeuVRG3m8C6JpuUpEZRSPRW7EjXecOmns,10293
+geoloop/bin/Runbatch.py,sha256=b5EbMEbUI7pYrOxfkFgmxYnFuJ4Cutsb1Y-caZlUji0,2211
+geoloop/bin/Runmain.py,sha256=nan1DlWijdfb3DK_yWvbaDNnw3jAlkDbeQNIyixyNWc,2729
+geoloop/bin/SingleRunSim.py,sha256=xzQOBzTF_JSUNHzFK4PKdcDNrMYQ42N2opvL1rc4sS8,29483
+geoloop/bin/__init__.py,sha256=TCfdSH7pJZUGcJEdcnwnoLwtOv7JtEZJTfHMjNGiFhE,76
+geoloop/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+geoloop/cli/batch.py,sha256=S_H-XWwH5NN2isXZsuJvbgCSAjHmMvZeeDe76V_mwSM,3499
+geoloop/cli/main.py,sha256=OPLHHZ_jTcRhJJyxMso11lBbV_QV6u9sv672SCiXLPA,3061
+geoloop/geoloopcore/CoaxialPipe.py,sha256=QDoelo4LmIy99Wf6_w8ECZOQbNQ7hTRMrvY6RgdiA94,18395
+geoloop/geoloopcore/CustomPipe.py,sha256=2sRUj0dhqtqbi0h2ydj_uDvpxYpqi1yowXvhlpOoRYA,23885
+geoloop/geoloopcore/__init__.py,sha256=-KGPB9JKniMxRslEodzCwcrRPrdz_JgWion7uDbfF9I,104
+geoloop/geoloopcore/b2g.py,sha256=U7Hw6M1v4ckY78K9IYzyqk_NtVTU5ibwUlTsGNbEeiY,29098
+geoloop/geoloopcore/b2g_ana.py,sha256=3gFY3Q8DdXGnMmerf2crmgBnC__oBLhyiaFen1jG1Og,18469
+geoloop/geoloopcore/boreholedesign.py,sha256=k9TlSHrnRFCnw9TtDoZ8rURIWMksHncS0Uz0qp7fY8E,23574
+geoloop/geoloopcore/getloaddata.py,sha256=Lj5q8dx6JQms0TIpkhA2GzQ-BGrgJEp4agFq-i3d15Y,4135
+geoloop/geoloopcore/pyg_ana.py,sha256=b66IoR4UwvB9n_bFUBqjYvq34e49MeBcXMwKVwyLy3k,9756
+geoloop/geoloopcore/pygfield_ana.py,sha256=vBMSg8ii47Gs1L9I9jXVpSmmc4sZRtmYkix0BiSeblQ,16957
+geoloop/geoloopcore/simulationparameters.py,sha256=_fd4FKiZCs6D553cJ10enCps-_38kKHNviatxhP64QQ,4122
+geoloop/geoloopcore/soilproperties.py,sha256=vpH5Iq7Uuf1AX2wEqWEAv9J8w9nQqh-CfEAYHPVhPpU,6053
+geoloop/geoloopcore/strat_interpolator.py,sha256=BB-xMA5Py3QOOoAdZMZBnxsuGpEug9xCfvuE7ZL6Ysk,6071
+geoloop/lithology/__init__.py,sha256=Nwcc5G-DCpBQjTIn2VK0Rvm2HDs3cc8gjXUAjRg7DmU,158
+geoloop/lithology/plot_lithology.py,sha256=SyOYH6hEAhMz8f4qk9XlofEVG7cEpOtBxOwgh6uEeQ0,9477
+geoloop/lithology/process_lithology.py,sha256=LjNKJ77PKnrZlvBZ27Lt7kiFdjj8X5CVe39Obb9dPgM,26327
+geoloop/loadflowdata/__init__.py,sha256=5LO-5fjkWkw50gOuLwDIY2oZHojguTdKJrOtuHHVFPo,138
+geoloop/loadflowdata/flow_data.py,sha256=FM9QZ-oK0zSrMTfTTOjjifP4G5F5sAiWHhnSpRVGaaw,5395
+geoloop/loadflowdata/loadprofile.py,sha256=a0sMkNfqs-YDMwuLreX1Oy3L_yF4aciziHBthsnEvMM,9746
+geoloop/plotting/__init__.py,sha256=cUvbg7WZIuEAYLgQrhhUyS0MFzkwhWaktVV9TwmncuU,125
+geoloop/plotting/create_plots.py,sha256=KJbqH3UN25C3NttQBJUGQ8zhQhWosGjFlCc3XBG5LaE,45549
+geoloop/plotting/load_data.py,sha256=7-HGOLV4e-_D8PShTljMSbehRrX10vok6aTjenrfOYM,18184
+geoloop/utils/RunManager.py,sha256=_teQvHJ5ET5STjTv1YZbYUD4I9lC6xPpACL5zer7nas,5861
+geoloop/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+geoloop/utils/helpers.py,sha256=Xrowd6t1nUUsU642y2bD3haKtNs0Zi8cCR8PtIFqAug,32139
+geoloop-1.0.0.dist-info/licenses/LICENSE.md,sha256=0MhY1_Mi2BnmfY4sG2hMfaIQBsGbCR-_jPNOQ2wjnaI,582
+geoloop-1.0.0.dist-info/METADATA,sha256=zxLkYV-_NSVW2iIyezQP4u712TUOcRPamzhX8vknh_w,4269
+geoloop-1.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+geoloop-1.0.0.dist-info/entry_points.txt,sha256=MK2kD_B90zZfZN-kUVrfQyJZqorcgg1WYLe7CSgvfHc,56
+geoloop-1.0.0.dist-info/top_level.txt,sha256=V20v-HNxFxZn9Tguuo4KZFG3c9Kn4D4w06tL1tlRbwE,8
+geoloop-1.0.0.dist-info/RECORD,,

geoloop-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+geoloop = geoloop.cli.main:simulation

geoloop-0.0.1.dist-info/licenses/LICENSE → geoloop-1.0.0.dist-info/licenses/LICENSE.md

@@ -1,4 +1,5 @@
-Copyright 2025 TNO
+Copyright (c) 2025, TNO
+All rights reserved.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

geoloop-0.0.1.dist-info/METADATA

@@ -1,10 +0,0 @@
-Metadata-Version: 2.4
-Name: geoloop
-Version: 0.0.1
-Summary: Reserved package name
-Author-email: Jan-Diederik van Wees <Jan_Diederik.vanWees@tno.nl>, Zanne Korevaar <zanne.korevaar@tno.nl>
-License: Apache 2.0
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Dynamic: license-file

geoloop-0.0.1.dist-info/RECORD

@@ -1,6 +0,0 @@
-geoloop/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-geoloop-0.0.1.dist-info/licenses/LICENSE,sha256=kBlk8vnfPW7g3Bkg0mhhm15kY4Y1uxj-Zy1Q_LN4rb0,555
-geoloop-0.0.1.dist-info/METADATA,sha256=62hkwWs_w1cs0p4Oxs8GVr8_-pho1rEWRpfZ3OLsJxE,325
-geoloop-0.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-geoloop-0.0.1.dist-info/top_level.txt,sha256=V20v-HNxFxZn9Tguuo4KZFG3c9Kn4D4w06tL1tlRbwE,8
-geoloop-0.0.1.dist-info/RECORD,,