Initial commit to public repo

/docs/_build/

*.h5

*.egg-info

.idea/

*.iml

*.xml

stages:

  - test

Run tests:

  stage: test

  image: python:3.12

  before_script:

    - pip install uv

    - uv venv

    - uv sync --extra dev

    - uv pip install -e .

  script:

    - uv run pytest -vv

  only:

    - main

    - merge_requests

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.

You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.

 No newline at end of 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.readthedocs.io)

## What is *Geoloop*?

*Geoloop* is a Python package for evaluating borehole heat exchanger (BHE) performance

with depth-dependent thermal properties, temperature profiles, and borehole design options.

It integrates realistic subsurface models to improve simulation reliability and supports

informed decision-making for both research and practical applications.

The package is based on thermal response factors (or *g*-functions) for borehole heat exchangers, calculated

using an analytical solution to the Finite Line Source model. The model set-up with *g*-functions is extended 

into a stacked, depth-dependent formulation for depth-dependent thermal response calculations.

Read the full documenation [here](https://AGS.gitlab.io/geoloop/).

```python

import geoloop as gl

gl.bin.run_batch_from_json('examples/borefield/ME_cooling/batch_me.json')

```

---

## Installation

Install from PyPI using:

```bash

pip install geoloop

```

For detailed setup instructions (including Pixi-based environments and development setup),

see the [Installation Guide](https://geoloop.readthedocs.io/en/latest/installation/install/).

---

## Requirements

Geoloop requires **Python 3.10 or higher**.

Core dependencies include:

- pygfunction

- numpy

- scipy

- matplotlib

- pandas

- xarray

- h5py

- seaborn

- tqdm

- netCDF4

- SecondaryCoolantProps

- openpyxl

---

## Quick Start

Explore the [Examples](docs/examples/) folder to get started quickly with Geoloop.

Full documentation is available at  

👉 [https://geoloop.readthedocs.io](https://geoloop.readthedocs.io)

---

## License

This project is licensed under the MIT 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.

# FlowDataConfig API Reference

::: geoloop.configuration.FlowDataConfig