diff --git a/README.md b/README.md index 5300d761fb4644f299b7bf1a6aedc2806459d129..3366dd0be5275d1c9e589bcbec6b049006273625 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 @@ -34,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/). --- @@ -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 0f6a70249d8e0d81e46c15c685f3b40b37ff6e03..e4d1b82b95238a4045815451f3e5bb61a68c623c 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