geoloop 1.0.1__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
 
 

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

@@ -1,12 +1,12 @@
 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
 
 
@@ -257,6 +257,7 @@ class ProcessLithologyToThermalConductivity:
 
     def __init__(
         self,
+        lithology_properties_df: pd.DataFrame,
         borehole_df: pd.DataFrame,
         Tg: float,
         Tgrad: float,
@@ -270,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()
@@ -385,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-1.0.1.dist-info → geoloop-1.0.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: geoloop
-Version: 1.0.1
+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-Expression: Apache-2.0

{geoloop-1.0.1.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=hYpskvpol_82Ai5RsGTcH7zBWLX8SYSSFSF0NBs21ig,33131
-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
@@ -28,7 +28,8 @@ 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=LjNKJ77PKnrZlvBZ27Lt7kiFdjj8X5CVe39Obb9dPgM,26327
+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
@@ -38,9 +39,9 @@ geoloop/plotting/load_data.py,sha256=7-HGOLV4e-_D8PShTljMSbehRrX10vok6aTjenrfOYM
 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.1.dist-info/licenses/LICENSE.md,sha256=0MhY1_Mi2BnmfY4sG2hMfaIQBsGbCR-_jPNOQ2wjnaI,582
-geoloop-1.0.1.dist-info/METADATA,sha256=ANOyDCdRzvdS5doWu2VF-4fa8R2S3--Y8toow1Jy0kA,4302
-geoloop-1.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-geoloop-1.0.1.dist-info/entry_points.txt,sha256=MK2kD_B90zZfZN-kUVrfQyJZqorcgg1WYLe7CSgvfHc,56
-geoloop-1.0.1.dist-info/top_level.txt,sha256=V20v-HNxFxZn9Tguuo4KZFG3c9Kn4D4w06tL1tlRbwE,8
-geoloop-1.0.1.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,,