Skip to main content

Geoloop: A BHE Calculator for Python

PyPI Documentation

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:

pip install geoloop

For detailed setup instructions (including uv-based environments and development setup), see the Installation Guide.


Requirements

Geoloop requires Python version >=3.12,<3.14.

Core dependencies include:

  • pygfunction
  • matplotlib
  • numpy
  • scipy
  • h5py
  • xarray
  • pandas
  • seaborn
  • tqdm
  • netCDF4
  • SecondaryCoolantProps
  • openpyxl
  • h5netcdf
  • pathlib
  • pydantic
  • typer

Quick Start

Explore the Examples folder to get started quickly with Geoloop.

Read the full documenation here.


License

This project is licensed under the Apache 2.0 License.
See the LICENSE.md file for details.


Acknowledgments

Developed with the support of the Netherlands Enterprise 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., Lourens, A. and Van Wees, J.D.: Geoloop (v1.0) – a stochastic, depth-dependent borehole heat exchanger model, Geoscientific Model Development (in prep), 2026

Metadata

Release files for geoloop 1.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for geoloop 1.1.0
File Size Uploaded
geoloop-1.1.0.tar.gz 121.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for geoloop 1.1.0
File Interpreter ABI Platform
geoloop-1.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 251.6 kB

Release files / geoloop-1.1.0.tar.gz

Download URL geoloop-1.1.0.tar.gz
Size 121.7 kB
Tags Source
SHA-256 checksum
How to use checksums
f2c144a82a0d6c306c565f64ba30773b33041cea0672b6e6b59465c90eed8b85
BLAKE2b-256 checksum
How to use checksums
7414e67215f6cd8e0eda65c38b3e81efa12843ffa56a13499265a61d447fde5e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.9.7

Release files / geoloop-1.1.0-py3-none-any.whl

Download URL geoloop-1.1.0-py3-none-any.whl
Size 129.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
727b07d924ae9cc284709db457f27d61364874e2c3f9e5049bccab784aa118fc
BLAKE2b-256 checksum
How to use checksums
2aadc9d1c00045264a1505451cebb880d102e5cc1ed08f7910a047774e1d04ea
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.9.7

Release history Release notifications | RSS feed

This release

1.1.0 This release

2 release files

1.0.7

2 release files

1.0.6

2 release files

1.0.5

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page