geoloop 0.0.1__tar.gz → 1.0.0__tar.gz

geoloop-0.0.1/LICENSE → geoloop-1.0.0/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-1.0.0/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,92 @@
+# 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/pyproject.toml

@@ -0,0 +1,85 @@
+[build-system]
+requires = ["setuptools>=61", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "geoloop"
+version = "1.0.0"
+description = "This is a Python package for simulation of (deep) vertical Borehole Heat Exchanger (BHE) systems"
+authors = [
+    { name = "Zanne Korevaar", email = "zanne.korevaar@tno.nl" },
+    { name = "Jan-Diederik van Wees", email = "jan_diederik.vanwees@tno.nl" }
+]
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE.md"]
+requires-python = ">=3.12,<3.14"
+keywords = [
+    "borehole heat exchanger", "BHE", "geothermal", "ground-source heat pump",
+    "deep borehole heat exchanger"
+]
+dependencies = [
+    "pygfunction>=2.2.2",
+    "matplotlib>=3.10.1",
+    "numpy>=2.2.4",
+    "scipy>=1.7.3",
+    "h5py>=3.4.0",
+    "xarray>=2025.3.1",
+    "pandas>=2.2.3,<3",
+    "seaborn>=0.13.2",
+    "tqdm>=4.67.1",
+    "netCDF4>=1.7.2",
+    "SecondaryCoolantProps>=1.3",
+    "openpyxl>=3.1.5",
+    "h5netcdf>=1.7.3",
+    "pathlib>=1.0.1",
+    "pydantic>=2.12.4",
+    "typer>=0.20.0",
+]
+
+[dependency-groups]
+dev = [
+    "ruff>=0.14.6",
+    "black",
+    "flake8",
+    "pytest>=8.4.2",
+    "mkdocs>=1.6.1",
+    "mkdocs-material>=9.6.23",
+    "mike>=2.1.3,<3",
+    "mkdocstrings>=0.30.1",
+    "mkdocstrings-python>=1.18.2",
+    "build>=1.3.0",
+    "twine>=6.2.0",
+    "wheel>=0.45.1",
+    "setuptools>=80.9.0",
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[project.scripts]
+geoloop = "geoloop.cli.main:simulation"
+
+[tool.uv.workspace]
+members = [
+    "geoloop",
+]
+
+[tool.ruff]
+line-length = 88
+
+[tool.ruff.lint]
+select = [
+    # pycodestyle (style guide violations)
+    "E",
+    # Pyflakes (bug detection)
+    "F",
+    # pyupgrade (modern Python syntax)
+    "UP",
+    # flake8-bugbear (common bugs and design issues)
+    "B",
+    # flake8-simplify (simplifiable constructs)
+    "SIM",
+    # isort (import sorting)
+    "I",
+]