From 057624b3babf212abf18ac354cdc245df071f7fa Mon Sep 17 00:00:00 2001 From: korevaarzer Date: Fri, 19 Dec 2025 11:53:06 +0100 Subject: [PATCH 1/2] Add links to full docs and public geoloop repo to the readme and the docs. Also add full list of main dependencies to the readme. --- README.md | 25 ++++++++++--------------- docs/installation/install.md | 4 ++-- 2 files changed, 12 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 5300d76..8ddb4a5 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # 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) +[![Documentation](https://img.shields.io/badge/docs-latest-blue)](https://geoloop-8f7a36.ci.tno.nl/) ## What is *Geoloop*? @@ -15,14 +15,6 @@ The package is based on thermal response factors (or *g*-functions) for borehole 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 @@ -44,17 +36,21 @@ Geoloop requires **Python 3.10 or higher**. Core dependencies include: - pygfunction +- matplotlib - numpy - scipy -- matplotlib -- pandas -- xarray - h5py +- xarray +- pandas - seaborn - tqdm - netCDF4 - SecondaryCoolantProps - openpyxl +- h5netcdf +- pathlib +- pydantic +- typer --- @@ -62,14 +58,13 @@ Core dependencies include: 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) +Read the full documenation [here](https://geoloop-8f7a36.ci.tno.nl/). --- ## License -This project is licensed under the MIT License. +This project is licensed under the Apache 2.0 License. See the [LICENSE.md](LICENSE.md) file for details. --- diff --git a/docs/installation/install.md b/docs/installation/install.md index 0f6a702..e4d1b82 100644 --- a/docs/installation/install.md +++ b/docs/installation/install.md @@ -25,7 +25,7 @@ If you prefer to use [uv](https://docs.astral.sh/uv/getting-started/) for enviro 1. Clone the repository: ```bash - git clone https://github.com/geoloop/geoloop.git + git clone https://ci.tno.nl/gitlab/ags_public/geoloop.git cd geoloop ``` @@ -47,6 +47,6 @@ If you prefer to use [uv](https://docs.astral.sh/uv/getting-started/) for enviro Contributions are very welcome! Please open issues or submit pull requests on -[GitHub → geoloop/geoloop](https://github.com/geoloop/geoloop). +[Gitlab → geoloop](https://ci.tno.nl/gitlab/ags_public/geoloop). --- \ No newline at end of file -- GitLab From ff4eb27e64c62c4f3ad03773caee0c1829315460 Mon Sep 17 00:00:00 2001 From: korevaarzer Date: Fri, 19 Dec 2025 11:55:42 +0100 Subject: [PATCH 2/2] update link to installation guide in readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8ddb4a5..3366dd0 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ 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/). +see the [Installation Guide](https://geoloop-8f7a36.ci.tno.nl/installation/install/). --- -- GitLab