geoloop 1.0.0b1__py3-none-any.whl → 1.0.2__py3-none-any.whl

geoloop/configuration.py

@@ -19,6 +19,8 @@ class LithologyConfig(BaseModel):
         Path to the JSON configuration file that created this object.
     out_dir_lithology : str or Path
         Directory where lithology outputs will be written.
+    lithology_properties_path: str or Path
+        Path to the Excel table  with lithology properties.
     borehole_lithology_path : str or Path
         Path to the Excel or CSV file containing lithology data.
     borehole_lithology_sheetname : str
@@ -48,6 +50,7 @@ class LithologyConfig(BaseModel):
     config_file_path: str | Path
     out_dir_lithology: str | Path
     input_dir_lithology: str | Path
+    lithology_properties_path: str |Path | None = None
     borehole_lithology_path: str | Path
     borehole_lithology_sheetname: str
     out_table: str
@@ -89,6 +92,23 @@ class LithologyConfig(BaseModel):
         if not isinstance(self.out_dir_lithology, Path):
             self.out_dir_lithology = base_dir_lithology / Path(self.out_dir_lithology)
 
+        # Lithology properties table
+        # Resolve user-supplied path
+        if self.lithology_properties_path is not None:
+            if not isinstance(self.lithology_properties_path, Path):
+                self.lithology_properties_path = Path(self.lithology_properties_path)
+
+            if not self.lithology_properties_path.is_absolute():
+                self.lithology_properties_path = (
+                        base_dir_lithology / self.lithology_properties_path
+                ).resolve()
+
+            if not self.lithology_properties_path.exists():
+                raise FileNotFoundError(
+                    f"Lithology properties file not found: "
+                    f"{self.lithology_properties_path}"
+                )
+
         return self
 
 
@@ -399,7 +419,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/constants.py

@@ -1,20 +1,3 @@
-from pathlib import Path
-
-repo_path = Path(__file__).parent.parent.parent
-
-# Test directories
-test_dir = repo_path / "test"
-tests_input_path = test_dir / "input"
-test_output_path = test_dir / "output"
-
-# Resources directory
-resources_path = repo_path / "resources"
-
-# Lithology resources directory
-lithology_properties_xlsx = (
-    resources_path / "lithology_properties" / "lithology_properties.xlsx"
-)
-
 # Dictionary of units for various parameters in the model.
 units_dict = {
     "Q_b": "W",

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/lithology/process_lithology.py

@@ -1,16 +1,14 @@
 import math
 from pathlib import Path
+from importlib.resources import files
 
 import numpy as np
 import pandas as pd
 import xarray as xr
 
 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:
     """
@@ -259,6 +257,7 @@ class ProcessLithologyToThermalConductivity:
 
     def __init__(
         self,
+        lithology_properties_df: pd.DataFrame,
         borehole_df: pd.DataFrame,
         Tg: float,
         Tgrad: float,
@@ -272,8 +271,7 @@ class ProcessLithologyToThermalConductivity:
         out_table: str,
         read_from_table: bool,
     ) -> None:
-        # Read lithology properties reference table (Excel)
-        self.lithology_props_df = pd.read_excel(lithology_properties_xlsx)
+        self.lithology_props_df = lithology_properties_df
 
         self.borehole_df = borehole_df
         self.lithology_props_dict = self.create_lithology_props_dict()
@@ -387,12 +385,22 @@ class ProcessLithologyToThermalConductivity:
             Initialized instance.
         """
 
-        borehole_path = config.borehole_lithology_path
+        # Read borehole lithology table (Excel)
         borehole_df = pd.read_excel(
-            borehole_path, sheet_name=config.borehole_lithology_sheetname
+            config.borehole_lithology_path, sheet_name=config.borehole_lithology_sheetname
         )
+        # Read lithology properties reference table (Excel)
+        if config.lithology_properties_path is not None:
+            lithology_properties_df = pd.read_excel(
+                config.lithology_properties_path
+            )
+        else:
+            lithology_properties_df = pd.read_excel(
+                files("geoloop.lithology.resources").joinpath("lithology_properties.xlsx")
+            )
 
         return cls(
+            lithology_properties_df=lithology_properties_df,
             borehole_df=borehole_df,
             Tg=config.Tg,
             Tgrad=config.Tgrad,

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.dist-info → geoloop-1.0.2.dist-info}/METADATA

@@ -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.2
+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.dist-info → geoloop-1.0.2.dist-info}/RECORD

@@ -1,6 +1,6 @@
 geoloop/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-geoloop/configuration.py,sha256=RuouQFQGbElpD382KI1JZviK0TfTJSHQP3IZimW3C7g,33140
-geoloop/constants.py,sha256=F2fsh3e35Fp8AqNguPba6W96jaIAfsWazk1d6uzKi6I,2698
+geoloop/configuration.py,sha256=dhiqW326YYxZLT9-hdiKG5_UqVUIhCETnNOyjxl-xb4,34052
+geoloop/constants.py,sha256=v_U88LpjxQCBq-7wv8XCprNqa4XTpsNFW7XLKFC2cuw,2276
 geoloop/axisym/AxisymetricEL.py,sha256=uGERxWzt9PIixzyYqK_v2kBuOEye6ZhqqXVBBEbrRig,28218
 geoloop/axisym/__init__.py,sha256=s3Suw3X0GzuQKGvR1ia6RCYGa43Az8g4gtRgedkf2b0,84
 geoloop/bin/Flowdatamain.py,sha256=vwVn7y9jPH-6RU2_eH2tWLvcsbFFHDxi8APoQ5ug1J0,2566
@@ -18,7 +18,7 @@ geoloop/geoloopcore/CoaxialPipe.py,sha256=QDoelo4LmIy99Wf6_w8ECZOQbNQ7hTRMrvY6Rg
 geoloop/geoloopcore/CustomPipe.py,sha256=2sRUj0dhqtqbi0h2ydj_uDvpxYpqi1yowXvhlpOoRYA,23885
 geoloop/geoloopcore/__init__.py,sha256=-KGPB9JKniMxRslEodzCwcrRPrdz_JgWion7uDbfF9I,104
 geoloop/geoloopcore/b2g.py,sha256=U7Hw6M1v4ckY78K9IYzyqk_NtVTU5ibwUlTsGNbEeiY,29098
-geoloop/geoloopcore/b2g_ana.py,sha256=_jcSudb6qZX4XiERtEH1Mv193jRqLtGr2gGWz4BsE78,19193
+geoloop/geoloopcore/b2g_ana.py,sha256=3gFY3Q8DdXGnMmerf2crmgBnC__oBLhyiaFen1jG1Og,18469
 geoloop/geoloopcore/boreholedesign.py,sha256=k9TlSHrnRFCnw9TtDoZ8rURIWMksHncS0Uz0qp7fY8E,23574
 geoloop/geoloopcore/getloaddata.py,sha256=Lj5q8dx6JQms0TIpkhA2GzQ-BGrgJEp4agFq-i3d15Y,4135
 geoloop/geoloopcore/pyg_ana.py,sha256=b66IoR4UwvB9n_bFUBqjYvq34e49MeBcXMwKVwyLy3k,9756
@@ -28,19 +28,20 @@ geoloop/geoloopcore/soilproperties.py,sha256=vpH5Iq7Uuf1AX2wEqWEAv9J8w9nQqh-CfEA
 geoloop/geoloopcore/strat_interpolator.py,sha256=BB-xMA5Py3QOOoAdZMZBnxsuGpEug9xCfvuE7ZL6Ysk,6071
 geoloop/lithology/__init__.py,sha256=Nwcc5G-DCpBQjTIn2VK0Rvm2HDs3cc8gjXUAjRg7DmU,158
 geoloop/lithology/plot_lithology.py,sha256=SyOYH6hEAhMz8f4qk9XlofEVG7cEpOtBxOwgh6uEeQ0,9477
-geoloop/lithology/process_lithology.py,sha256=ukAExhO-41NnS6FI1Lp2FoKB2yjWztHSSkEZIYImctA,26449
+geoloop/lithology/process_lithology.py,sha256=F4Z7gTJRzU_P46EFUW7tsdBGfY1wI13vxvvUH3ntAHo,26765
+geoloop/lithology/resources/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 geoloop/loadflowdata/__init__.py,sha256=5LO-5fjkWkw50gOuLwDIY2oZHojguTdKJrOtuHHVFPo,138
 geoloop/loadflowdata/flow_data.py,sha256=FM9QZ-oK0zSrMTfTTOjjifP4G5F5sAiWHhnSpRVGaaw,5395
 geoloop/loadflowdata/loadprofile.py,sha256=a0sMkNfqs-YDMwuLreX1Oy3L_yF4aciziHBthsnEvMM,9746
 geoloop/plotting/__init__.py,sha256=cUvbg7WZIuEAYLgQrhhUyS0MFzkwhWaktVV9TwmncuU,125
-geoloop/plotting/create_plots.py,sha256=b6ggMpn2UgDzZKZnD0_p6rp7fLTpAN-cIG0LTSqdCe0,45269
+geoloop/plotting/create_plots.py,sha256=KJbqH3UN25C3NttQBJUGQ8zhQhWosGjFlCc3XBG5LaE,45549
 geoloop/plotting/load_data.py,sha256=7-HGOLV4e-_D8PShTljMSbehRrX10vok6aTjenrfOYM,18184
 geoloop/utils/RunManager.py,sha256=_teQvHJ5ET5STjTv1YZbYUD4I9lC6xPpACL5zer7nas,5861
 geoloop/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 geoloop/utils/helpers.py,sha256=Xrowd6t1nUUsU642y2bD3haKtNs0Zi8cCR8PtIFqAug,32139
-geoloop-1.0.0b1.dist-info/licenses/LICENSE.md,sha256=0MhY1_Mi2BnmfY4sG2hMfaIQBsGbCR-_jPNOQ2wjnaI,582
-geoloop-1.0.0b1.dist-info/METADATA,sha256=F2WiBAsKe6nSpTGtuA1NpOYBkiGmnongTMbI2nvM_LI,3680
-geoloop-1.0.0b1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-geoloop-1.0.0b1.dist-info/entry_points.txt,sha256=MK2kD_B90zZfZN-kUVrfQyJZqorcgg1WYLe7CSgvfHc,56
-geoloop-1.0.0b1.dist-info/top_level.txt,sha256=V20v-HNxFxZn9Tguuo4KZFG3c9Kn4D4w06tL1tlRbwE,8
-geoloop-1.0.0b1.dist-info/RECORD,,
+geoloop-1.0.2.dist-info/licenses/LICENSE.md,sha256=0MhY1_Mi2BnmfY4sG2hMfaIQBsGbCR-_jPNOQ2wjnaI,582
+geoloop-1.0.2.dist-info/METADATA,sha256=iniZ8EQ_-5rm7qvJ6Zqlg7eA2DqIPOfvw1I_WhECR5w,4302
+geoloop-1.0.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+geoloop-1.0.2.dist-info/entry_points.txt,sha256=MK2kD_B90zZfZN-kUVrfQyJZqorcgg1WYLe7CSgvfHc,56
+geoloop-1.0.2.dist-info/top_level.txt,sha256=V20v-HNxFxZn9Tguuo4KZFG3c9Kn4D4w06tL1tlRbwE,8
+geoloop-1.0.2.dist-info/RECORD,,