geoloop 1.0.1__tar.gz → 1.0.3__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: geoloop
-Version: 1.0.1
+Version: 1.0.3
 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 → geoloop-1.0.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "geoloop"
-version = "1.0.1"
+version = "1.0.3"
 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" },
@@ -60,6 +60,9 @@ where = ["src"]
 [project.scripts]
 geoloop = "geoloop.cli.main:simulation"
 
+[tool.setuptools.package-data]
+"geoloop.lithology.resources" = ["lithology_properties.xlsx"]
+
 [tool.uv.workspace]
 members = [
     "geoloop",

{geoloop-1.0.1 → geoloop-1.0.3}/src/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-1.0.1 → geoloop-1.0.3}/src/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-1.0.1 → geoloop-1.0.3}/src/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 → geoloop-1.0.3/src/geoloop.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: geoloop
-Version: 1.0.1
+Version: 1.0.3
 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 → geoloop-1.0.3}/src/geoloop.egg-info/SOURCES.txt

@@ -38,6 +38,8 @@ src/geoloop/geoloopcore/strat_interpolator.py
 src/geoloop/lithology/__init__.py
 src/geoloop/lithology/plot_lithology.py
 src/geoloop/lithology/process_lithology.py
+src/geoloop/lithology/resources/__init__.py
+src/geoloop/lithology/resources/lithology_properties.xlsx
 src/geoloop/loadflowdata/__init__.py
 src/geoloop/loadflowdata/flow_data.py
 src/geoloop/loadflowdata/loadprofile.py

{geoloop-1.0.1 → geoloop-1.0.3}/test/test_b2g.py

@@ -4,10 +4,11 @@ from pathlib import Path
 import numpy as np
 import xarray as xr
 
+from paths import test_dir, tests_input_path
+
 from geoloop.configuration import SingleRunConfig, LithologyConfig, load_nested_config
 from geoloop.utils.helpers import save_singlerun_results
 from geoloop.bin.SingleRunSim import SingleRun
-from geoloop.constants import test_dir, tests_input_path
 from geoloop.geoloopcore.b2g import B2G
 from geoloop.lithology.process_lithology import ProcessLithologyToThermalConductivity
 

{geoloop-1.0.1 → geoloop-1.0.3}/test/test_b2g_ana.py

@@ -4,6 +4,8 @@ from pathlib import Path
 import numpy as np
 import xarray as xr
 
+from paths import test_dir, tests_input_path
+
 from geoloop.configuration import SingleRunConfig, load_nested_config, LithologyConfig, StochasticRunConfig
 from geoloop.utils.helpers import (
     save_MCrun_results,
@@ -11,7 +13,6 @@ from geoloop.utils.helpers import (
 )
 from geoloop.utils.RunManager import run_models
 from geoloop.bin.SingleRunSim import SingleRun
-from geoloop.constants import test_dir, tests_input_path
 from geoloop.geoloopcore.b2g_ana import B2G_ana
 from geoloop.lithology.process_lithology import ProcessLithologyToThermalConductivity
 

{geoloop-1.0.1 → geoloop-1.0.3}/test/test_h5.py

@@ -4,10 +4,11 @@ from pathlib import Path
 import numpy as np
 import xarray as xr
 
+from paths import test_dir, tests_input_path
+
 from geoloop.configuration import load_nested_config, SingleRunConfig, LithologyConfig
 from geoloop.utils.helpers import save_singlerun_results
 from geoloop.bin.SingleRunSim import SingleRun
-from geoloop.constants import test_dir, tests_input_path
 from geoloop.lithology.process_lithology import ProcessLithologyToThermalConductivity
 
 

{geoloop-1.0.1 → geoloop-1.0.3}/test/test_lithology.py

@@ -2,7 +2,8 @@ import unittest
 
 import xarray as xr
 
-from geoloop.constants import tests_input_path, test_output_path
+from paths import tests_input_path, test_output_path
+
 from geoloop.configuration import LithologyConfig, load_single_config
 from geoloop.lithology.process_lithology import ProcessLithologyToThermalConductivity
 

{geoloop-1.0.1 → geoloop-1.0.3}/test/test_loadflowdata.py

@@ -2,9 +2,10 @@ import unittest
 
 import numpy as np
 
+from paths import tests_input_path, test_output_path
+
 from geoloop.configuration import LoadProfileConfig, FlowDataConfig, load_single_config
 from geoloop.utils.helpers import apply_smoothing
-from geoloop.constants import tests_input_path, test_output_path
 from geoloop.loadflowdata.flow_data import FlowData
 from geoloop.loadflowdata.loadprofile import LoadProfile
 

{geoloop-1.0.1 → geoloop-1.0.3}/test/test_plotting.py

@@ -7,9 +7,10 @@ import matplotlib.pyplot as plt
 import numpy as np
 import xarray as xr
 
+from paths import test_dir, tests_input_path
+
 from geoloop.configuration import PlotInputConfig, load_single_config
 from geoloop.bin.Plotmain import DataSelection, DataTotal, PlotInput
-from geoloop.constants import test_dir, tests_input_path
 from geoloop.plotting.create_plots import PlotResults
 
 

{geoloop-1.0.1 → geoloop-1.0.3}/test/test_pyg_ana.py

@@ -4,10 +4,11 @@ from pathlib import Path
 import numpy as np
 import xarray as xr
 
+from paths import test_dir, tests_input_path
+
 from geoloop.configuration import load_nested_config, SingleRunConfig, LithologyConfig
 from geoloop.utils.helpers import save_singlerun_results
 from geoloop.bin.SingleRunSim import SingleRun
-from geoloop.constants import test_dir, tests_input_path
 from geoloop.geoloopcore.pyg_ana import PYG_ana
 from geoloop.lithology.process_lithology import ProcessLithologyToThermalConductivity
 

{geoloop-1.0.1 → geoloop-1.0.3}/test/test_pygfield_ana.py

@@ -2,9 +2,10 @@ import unittest
 
 import numpy as np
 
+from paths import tests_input_path
+
 from geoloop.configuration import load_nested_config, SingleRunConfig, LithologyConfig
 from geoloop.bin.SingleRunSim import SingleRun
-from geoloop.constants import tests_input_path
 from geoloop.geoloopcore.pygfield_ana import (
     PYGFIELD_ana,
     create_curved_borehole,