geoloop 1.0.0b1__tar.gz → 1.0.1__tar.gz

{geoloop-1.0.0b1/src/geoloop.egg-info → geoloop-1.0.1}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: geoloop
-Version: 1.0.0b1
-Summary: This is a Python package for simulation of (deep) Borehole Heat Exchanger (BHE) systems
+Version: 1.0.1
+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: Apache 2.0
+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
@@ -33,20 +33,22 @@ Dynamic: license-file
 
 ## What is **Geoloop**?
 
-**Geoloop** is a Python package for simulating borehole heat exchanger (BHE) systems,
-with a focus on optimal implementation of subsurface thermal properties and their impact on system performance.
+**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, in a tool for deterministic or stochastic performance analyses with the opportunity
-for optimization of the system design and operation. This makes Geoloop ideal for scenario analyses and sensitivity 
+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** uses thermal response factors (*g*-functions) calculated using the analytical Finite Line Source model from 
-the *pygfunction* package. This setup is extended into a stacked approach for depth-dependent thermal response calculations. 
-A detailed description and benchmark of this depth-dependent semi-analytical method is provided in Korevaar & Van Wees (in prep.).
-**Geoloop's** generic framework allows for easy switching between simulation methods, including the innovative depth-dependent
-semi-analytical approach, the depth-uniform implementation of g-functions as implemented in *pygfunction* and a numerical 
+**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.
 
 ---
@@ -66,7 +68,7 @@ see the [Installation Guide](https://geoloop-8f7a36.ci.tno.nl/installation/insta
 
 ## Requirements
 
-Geoloop requires **Python 3.12 or higher**.
+Geoloop requires **Python version >=3.12,<3.14**.
 
 Core dependencies include:
 - pygfunction
@@ -105,8 +107,14 @@ 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.
+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

geoloop-1.0.1/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 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](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 **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

{geoloop-1.0.0b1 → geoloop-1.0.1}/pyproject.toml

@@ -4,14 +4,15 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "geoloop"
-version = "1.0.0b1"
-description = "This is a Python package for simulation of (deep) Borehole Heat Exchanger (BHE) systems"
+version = "1.0.1"
+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 = { text = "Apache 2.0" }
+license = "Apache-2.0"
+license-files = ["LICENSE.md"]
 requires-python = ">=3.12,<3.14"
 keywords = [
     "borehole heat exchanger", "BHE", "geothermal", "ground-source heat pump",

{geoloop-1.0.0b1 → geoloop-1.0.1}/src/geoloop/configuration.py

@@ -399,7 +399,7 @@ class SingleRunConfig(BaseModel, extra="allow"):
     fluid_percent : float or int
         Mixture percentage for the fluid dissolved in water.
     m_flow : float
-        Mass flow rate per pipe [kg/s].
+        Mass flow rate [kg/s].
     epsilon : float
         Pipe roughness [m].
     r_in : list of float, optional

{geoloop-1.0.0b1 → geoloop-1.0.1}/src/geoloop/geoloopcore/b2g_ana.py

@@ -110,28 +110,9 @@ class B2G_ana:
         for k in range(nsegments):
             la = gt.load_aggregation.ClaessonJaved(sim_params.dt, sim_params.tmax)
             LoadAgg.append(la)
-        # TODO: JD: the workaround below was not reuired anymore?
+
         # The field contains only one borehole
-        # boreField = [gt.boreholes.Borehole(custom_pipe.b.H, custom_pipe.b.D, custom_pipe.b.r_b, x=0., y=0.)]
-        # The field contains only one borehole, but needs one extra at very large distance to be correct, ie. gfunc plateaus at 6.7)
-        boreField = [
-            gt.boreholes.Borehole(
-                custom_pipe.b.H,
-                custom_pipe.b.D,
-                custom_pipe.b.r_b,
-                x=0.0,
-                y=0.0,
-                tilt=np.radians(0.1),
-            ),
-            gt.boreholes.Borehole(
-                custom_pipe.b.H,
-                custom_pipe.b.D,
-                custom_pipe.b.r_b,
-                x=1000.0,
-                y=0.0,
-                tilt=np.radians(0.1),
-            ),
-        ]
+        boreField = [gt.boreholes.Borehole(custom_pipe.b.H, custom_pipe.b.D, custom_pipe.b.r_b, x=0., y=0.)]
 
         # Get time values needed for g-function evaluation
         time_req = LoadAgg[0].get_times_for_simulation()

{geoloop-1.0.0b1 → geoloop-1.0.1}/src/geoloop/lithology/process_lithology.py

@@ -9,8 +9,6 @@ from geoloop.configuration import LithologyConfig
 from geoloop.constants import lithology_properties_xlsx
 from geoloop.geoloopcore.strat_interpolator import TgInterpolator
 
-# TODO: save the config paramters (error and scaling factors) in the thermcon h5 file that now only stores the results
-
 
 class ThermalConductivityCalculator:
     """

{geoloop-1.0.0b1 → geoloop-1.0.1}/src/geoloop/plotting/create_plots.py

@@ -199,7 +199,7 @@ class PlotResults:
         -------
         None
         """
-        out_path_prefix = out_path.with_name(out_path.name + "timeplot")
+        out_path_prefix = out_path.with_name(out_path.name + "_timeplot")
 
         # Ensure results_dfs is a list of dataframes
         if isinstance(results_dfs, pd.DataFrame):
@@ -237,12 +237,7 @@ class PlotResults:
                 and "Q_b" in df.columns
                 and "qloop" in df.columns
             ):
-                mean_Q = df["Q_b"].mean()
-                mean_q = df["qloop"].mean()
-                mean_COP = mean_Q / mean_q
-                df["COP"] = mean_COP  # abs(df['Q_b'] / df['qloop'])
-                # df['COP'] = abs(df['Q_b']) / df['qloop']
-                # print(df["COP"].min())
+                df['COP'] = abs(df['Q_b']) / df['qloop']
             if (
                 "Delta_T" in plot_parameters
                 and "T_fi" in df.columns
@@ -253,7 +248,7 @@ class PlotResults:
         plots = [
             ("Q_b", "Heat Load [W]", "Q_b", None, None),
             ("flowrate", "Flowrate [kg/s]", "flowrate", None, None),
-            ("COP", "Coefficient of Performance", "COP", None, None),
+            ("COP", "Coefficient of Performance", "COP", None, None)
         ]
 
         plotted_params = []
@@ -281,11 +276,12 @@ class PlotResults:
 
                 ax.legend(loc=(-0.07, -0.35))
 
-            ax_twin = ax.twinx()
-            ax_twin.set_ylabel("Pump Power [W]")
-
             for idx, df in enumerate(results_dfs):
                 if "qloop" in plot_parameters and "qloop" in df.columns:
+
+                    ax_twin = ax.twinx()
+                    ax_twin.set_ylabel("Pump Power [W]")
+
                     color = next(color_iter)
 
                     # Plot the line
@@ -319,7 +315,7 @@ class PlotResults:
                 ax_twin.grid(axis="both")
 
             file_name = out_path.with_name(
-                out_path.name + f"timeplot_{'_'.join(sorted(set(plotted_params)))}.png"
+                out_path.name + f"_timeplot_{'_'.join(sorted(set(plotted_params)))}.png"
             )
 
             fig.tight_layout()
@@ -440,7 +436,7 @@ class PlotResults:
 
             file_name = out_path.with_name(
                 out_path.name
-                + "timeplot_"
+                + "_timeplot_"
                 + "_".join(sorted(set(plotted_params)))
                 + ".png"
             )
@@ -473,6 +469,15 @@ class PlotResults:
                         label=labels[idx][param],
                         color=next(color_iter),
                     )
+                    if param=="COP":
+                        if param == "COP":
+                            ax.text(
+                                0.7, 0.9,  # 2% from left and bottom of the axes
+                                f"mean COP: {df['COP'].mean():.2f}",
+                                transform=ax.transAxes,
+                                bbox=dict(boxstyle="round,pad=0.3", facecolor="white", alpha=0.7),
+                                fontsize=12
+                            )
 
             ax.legend(loc=(-0.07, -0.17 - (0.08 * len(results_dfs))))
             ax.grid()
@@ -984,7 +989,7 @@ class PlotResults:
                 bbox_to_anchor=(0, -0.1), loc="upper left"
             )  # Adjust legend position if needed
 
-            save_path = outpath.with_name(outpath.name + f"Sensitivity_{y_variable}")
+            save_path = outpath.with_name(outpath.name + f"_sensitivity_{y_variable}")
             plt.savefig(save_path, bbox_inches="tight")
             plt.close()
         else:

{geoloop-1.0.0b1 → geoloop-1.0.1/src/geoloop.egg-info}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: geoloop
-Version: 1.0.0b1
-Summary: This is a Python package for simulation of (deep) Borehole Heat Exchanger (BHE) systems
+Version: 1.0.1
+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: Apache 2.0
+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
@@ -33,20 +33,22 @@ Dynamic: license-file
 
 ## What is **Geoloop**?
 
-**Geoloop** is a Python package for simulating borehole heat exchanger (BHE) systems,
-with a focus on optimal implementation of subsurface thermal properties and their impact on system performance.
+**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, in a tool for deterministic or stochastic performance analyses with the opportunity
-for optimization of the system design and operation. This makes Geoloop ideal for scenario analyses and sensitivity 
+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** uses thermal response factors (*g*-functions) calculated using the analytical Finite Line Source model from 
-the *pygfunction* package. This setup is extended into a stacked approach for depth-dependent thermal response calculations. 
-A detailed description and benchmark of this depth-dependent semi-analytical method is provided in Korevaar & Van Wees (in prep.).
-**Geoloop's** generic framework allows for easy switching between simulation methods, including the innovative depth-dependent
-semi-analytical approach, the depth-uniform implementation of g-functions as implemented in *pygfunction* and a numerical 
+**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.
 
 ---
@@ -66,7 +68,7 @@ see the [Installation Guide](https://geoloop-8f7a36.ci.tno.nl/installation/insta
 
 ## Requirements
 
-Geoloop requires **Python 3.12 or higher**.
+Geoloop requires **Python version >=3.12,<3.14**.
 
 Core dependencies include:
 - pygfunction
@@ -105,8 +107,14 @@ 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.
+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

geoloop-1.0.0b1/README.md

@@ -1,84 +0,0 @@
-# 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 borehole heat exchanger (BHE) systems,
-with a focus on optimal implementation of subsurface thermal properties 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, in a tool for deterministic or stochastic performance analyses with the opportunity
-for optimization of the system design and operation. This makes Geoloop ideal for scenario analyses and sensitivity 
-studies in both research and practical applications.
-
-**Geoloop** uses thermal response factors (*g*-functions) calculated using the analytical Finite Line Source model from 
-the *pygfunction* package. This setup is extended into a stacked approach for depth-dependent thermal response calculations. 
-A detailed description and benchmark of this depth-dependent semi-analytical method is provided in Korevaar & Van Wees (in prep.).
-**Geoloop's** generic framework allows for easy switching between simulation methods, including the innovative depth-dependent
-semi-analytical approach, 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.
-
----
-
-