geometallurgy 0.4.12__py3-none-any.whl → 0.4.14__py3-none-any.whl

elphick/geomet/block_model.py

@@ -10,7 +10,6 @@ from scipy import stats
 from elphick.geomet import extras
 from elphick.geomet.base import MassComposition
 from elphick.geomet.extras import BlockmodelExtras
-from elphick.geomet.utils.block_model_converter import volume_to_vtk
 from elphick.geomet.utils.timer import log_timer
 
 if TYPE_CHECKING:
@@ -21,8 +20,8 @@ if TYPE_CHECKING:
 def import_extras(func):
     @wraps(func)
     def wrapper(*args, **kwargs):
-        omf, omfvista, pv = extras.import_blockmodel_packages()
-        extras_instance = BlockmodelExtras(omf, omfvista, pv)
+        omfpandas, omfvista, pv = extras.import_blockmodel_packages()
+        extras_instance = BlockmodelExtras(omfpandas, omfvista, pv)
         return func(*args, imports=extras_instance, **kwargs)
 
     return wrapper
@@ -66,105 +65,67 @@ class BlockModel(MassComposition):
     @classmethod
     @import_extras
     def from_omf(cls, omf_filepath: Path, imports,
-                 name: Optional[str] = None,
-                 columns: Optional[list[str]] = None) -> 'BlockModel':
-
-        reader = imports.omf.OMFReader(str(omf_filepath))
-        project: imports.omf.Project = reader.get_project()
-        # get the first block model detected in the omf project
-        block_model_candidates = [obj for obj in project.elements if isinstance(obj, imports.omf.volume.VolumeElement)]
-        if name:
-            omf_bm = [obj for obj in block_model_candidates if obj.name == name]
-            if len(omf_bm) == 0:
-                raise ValueError(f"No block model named '{name}' found in the OMF file.")
-            else:
-                omf_bm = omf_bm[0]
-        elif len(block_model_candidates) > 1:
-            names: list[str] = [obj.name for obj in block_model_candidates]
-            raise ValueError(f"Multiple block models detected in the OMF file - provide a name argument from: {names}")
-        else:
-            omf_bm = block_model_candidates[0]
-
-        origin = np.array(project.origin)
-        bm = volume_to_vtk(omf_bm, origin=origin, columns=columns)
-
-        # Create DataFrame
-        df = pd.DataFrame(bm.cell_centers().points, columns=['x', 'y', 'z'])
-
-        # set the index to the cell centroids
-        df.set_index(['x', 'y', 'z'], drop=True, inplace=True)
+                 element_name: Optional[str] = None,
+                 columns: Optional[list[str]] = None,
+                 query: Optional[str] = None,
+                 density: float = 2.5) -> 'BlockModel':
+        """Create a BlockModel from an OMF file.
+
+        Args:
+            omf_filepath: Path to the OMF file.
+            imports: internally used to import the necessary packages.
+            element_name: The name of the element in the OMF file.
+            columns: The columns to extract from the OMF file.
+            query: The query to filter the DataFrame.
+            density: The density of the material in g/cm3, used to calculate DMT (Dry Mass Tonnes).  A workaround.
+
+        Returns:
+            BlockModel: The BlockModel instance.
 
-        if not isinstance(bm, imports.pv.RectilinearGrid):
-            for d, t in zip(['dx', 'dy', 'dz'], ['tensor_u', 'tensor_v', 'tensor_w']):
-                # todo: fix - wrong shape
-                df[d] = eval(f"omf_bm.geometry.{t}")
-            df.set_index(['dx', 'dy', 'dz'], append=True, inplace=True)
+        """
 
-        # Add the array data to the DataFrame
-        for name in bm.array_names:
-            df[name] = bm.get_array(name)
+        omfpr: imports.omfpandas.OMFPandasReader = imports.omfpandas.OMFPandasReader(filepath=omf_filepath)
+        blocks: pd.DataFrame = omfpr.read_blockmodel(blockmodel_name=element_name, attributes=columns,
+                                                     query=query)
 
-        # temporary workaround for no mass
-        df['DMT'] = 2000
-        moisture_in_scope = False
+        # get the block volume
 
-        return cls(data=df, name=omf_bm.name, moisture_in_scope=moisture_in_scope)
+        volume: Union[float, np.ndarray[float]]
+        from omfpandas.blockmodel import OMFBlockModel
+        from omfpandas.blockmodels.convert_blockmodel import df_to_blockmodel
+        from omfpandas.blockmodels.geometry import Geometry
+        geom: Geometry = OMFBlockModel(df_to_blockmodel(blocks, blockmodel_name=element_name)).geometry
 
-    @import_extras
-    def to_omf(self, omf_filepath: Path, imports, name: str = 'Block Model', description: str = 'A block model'):
-
-        # Create a Project instance
-        project = imports.omf.Project(name=name, description=description)
-
-        # Create a VolumeElement instance for the block model
-        block_model = imports.omf.VolumeElement(name=name, description=description,
-                                                geometry=imports.omf.VolumeGridGeometry())
-
-        # Set the geometry of the block model
-        block_model.geometry.origin = self.data.index.get_level_values('x').min(), \
-            self.data.index.get_level_values('y').min(), \
-            self.data.index.get_level_values('z').min()
-
-        # Set the axis directions
-        block_model.geometry.axis_u = [1, 0, 0]  # Set the u-axis to point along the x-axis
-        block_model.geometry.axis_v = [0, 1, 0]  # Set the v-axis to point along the y-axis
-        block_model.geometry.axis_w = [0, 0, 1]  # Set the w-axis to point along the z-axis
-
-        # Set the tensor locations and dimensions
-        if 'dx' not in self.data.index.names:
-            # Calculate the dimensions of the cells
-            x_dims = np.diff(self.data.index.get_level_values('x').unique())
-            y_dims = np.diff(self.data.index.get_level_values('y').unique())
-            z_dims = np.diff(self.data.index.get_level_values('z').unique())
-
-            # Append an extra value to the end of the dimensions arrays
-            x_dims = np.append(x_dims, x_dims[-1])
-            y_dims = np.append(y_dims, y_dims[-1])
-            z_dims = np.append(z_dims, z_dims[-1])
-
-            # Assign the dimensions to the tensor attributes
-            block_model.geometry.tensor_u = x_dims
-            block_model.geometry.tensor_v = y_dims
-            block_model.geometry.tensor_w = z_dims
+        if geom.__class__.__name__ == 'RegularGeometry':
+            volume = geom.block_size[0] * geom.block_size[1] * geom.block_size[2]
+        elif geom.__class__.__name__ == 'TensorGeometry':
+            # TODO: Implement the volume calculation for TensorGeometry - this is a placeholder.
+            volume = geom.block_sizes[0][0] * geom.block_sizes[0][1] * geom.block_sizes[0][2]
         else:
-            block_model.geometry.tensor_u = self.data.index.get_level_values('dx').unique().tolist()
-            block_model.geometry.tensor_v = self.data.index.get_level_values('dy').unique().tolist()
-            block_model.geometry.tensor_w = self.data.index.get_level_values('dz').unique().tolist()
-
-        # Sort the blocks by their x, y, and z coordinates
-        blocks: pd.DataFrame = self.data.sort_index()
+            raise ValueError(f"Geometry type '{geom.__class__.__name__}' not supported.")
 
-        # Add the data to the block model
-        data = [imports.omf.ScalarData(name=col, location='cells', array=blocks[col].values) for col in blocks.columns]
-        block_model.data = data
+        if density is not None:
+            blocks['mass_dry'] = volume * density
+            moisture_in_scope = False
 
-        # Add the block model to the project
-        project.elements = [block_model]
+        return cls(data=blocks, name=element_name, mass_dry_var='mass_dry', moisture_in_scope=moisture_in_scope)
 
-        assert project.validate()
+    @import_extras
+    def to_omf(self, omf_filepath: Path, imports, element_name: str = 'Block Model',
+               description: str = 'A block model'):
+        """Write the BlockModel to an OMF file.
+
+        Args:
+            omf_filepath: Path to the OMF file.
+            imports: internally used to import the necessary packages.
+            element_name: The name of the element in the OMF file.
+            description: Description of the block model.
+        """
+        # Create an OMFPandasWriter instance
+        writer = imports.omfpandas.OMFPandasWriter(filepath=omf_filepath)
 
-        # Write the project to a file
-        imports.omf.OMFWriter(project, str(omf_filepath))
+        # Write the block model to the OMF file
+        writer.write_blockmodel(blockmodel_name=element_name, description=description, dataframe=self.data)
 
     @log_timer
     def get_blocks(self) -> Union['pv.StructuredGrid', 'pv.UnstructuredGrid']:
@@ -235,7 +196,7 @@ class BlockModel(MassComposition):
     def create_structured_grid(self, imports) -> 'pv.StructuredGrid':
 
         # Get the unique x, y, z coordinates (centroids)
-        data = self.data
+        data = self.data.sort_values(['z', 'y', 'x'])  # ensure the data is sorted F-style
         x_centroids = data.index.get_level_values('x').unique()
         y_centroids = data.index.get_level_values('y').unique()
         z_centroids = data.index.get_level_values('z').unique()
@@ -274,7 +235,7 @@ class BlockModel(MassComposition):
         """
 
         # Get the x, y, z coordinates and cell dimensions
-        blocks = self.data.reset_index().sort_values(['z', 'y', 'x'])
+        blocks = self.data.reset_index().sort_values(['z', 'y', 'x'])  # ensure the data is sorted F-style
         # if no dims are passed, estimate them
         if 'dx' not in blocks.columns:
             dx, dy, dz = self.common_block_size()

elphick/geomet/extras.py

@@ -3,8 +3,8 @@ _blockmodel_imports = None
 
 # Define the Extras class to encapsulate the imported modules
 class BlockmodelExtras:
-    def __init__(self, omf, omfvista, pv):
-        self.omf = omf
+    def __init__(self, omfpandas, omfvista, pv):
+        self.omfpandas = omfpandas
         self.omfvista = omfvista
         self.pv = pv
 
@@ -15,7 +15,7 @@ def import_blockmodel_packages():
 
     # Optional imports
     try:
-        import omf
+        import omfpandas
         import omfvista
         import pyvista as pv
         from pyvista import CellType
@@ -25,10 +25,10 @@ def import_blockmodel_packages():
 
     if _blockmodel_imports is None:
         try:
-            import omf
+            import omfpandas
             import omfvista
             import pyvista as pv
-            _blockmodel_imports = (omf, omfvista, pv)
+            _blockmodel_imports = (omfpandas, omfvista, pv)
         except ImportError:
             raise ImportError("Failed to import blockmodel related packages. "
                               "Consider executing: 'poetry install --extras blockmodel'")

{geometallurgy-0.4.12.dist-info → geometallurgy-0.4.14.dist-info}/METADATA

@@ -1,26 +1,27 @@
 Metadata-Version: 2.1
 Name: geometallurgy
-Version: 0.4.12
+Version: 0.4.14
 Summary: Tools for the geometallurgist
 Home-page: https://github.com/elphick/geometallurgy
 Author: Greg
 Author-email: 11791585+elphick@users.noreply.github.com
-Requires-Python: >=3.9,<3.13
+Requires-Python: >=3.10,<3.13
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Provides-Extra: all
 Provides-Extra: blockmodel
-Provides-Extra: map
+Provides-Extra: spatial
 Provides-Extra: validation
-Requires-Dist: folium (>=0.16.0,<0.17.0) ; extra == "map"
+Requires-Dist: folium (>=0.16.0,<0.17.0) ; extra == "spatial"
+Requires-Dist: omfpandas (>=0.8.1,<0.9.0) ; extra == "blockmodel"
 Requires-Dist: omfvista (>=0.3.0) ; extra == "blockmodel"
 Requires-Dist: pandas (>=1.0)
 Requires-Dist: pandera[io] (>=0.19.3,<0.21.0) ; extra == "validation"
 Requires-Dist: periodictable (>=1.7.0,<2.0.0)
 Requires-Dist: plotly (>=5.22.0,<6.0.0)
 Requires-Dist: pyarrow (>=16.1.0,<18.0.0)
+Requires-Dist: rioxarray (>=0.18.2,<0.19.0) ; extra == "spatial"
 Project-URL: Documentation, https://elphick.github.io/geometallurgy
 Project-URL: Repository, https://github.com/elphick/geometallurgy
 Description-Content-Type: text/markdown

{geometallurgy-0.4.12.dist-info → geometallurgy-0.4.14.dist-info}/RECORD

@@ -1,6 +1,6 @@
 elphick/geomet/__init__.py,sha256=gcaArz-agLsm_Tf9KNvmGznw4Jml2QTjj_CxKUC1Ejg,274
 elphick/geomet/base.py,sha256=vp0C7DEAAUDGhTdQ8_Hz9WmqZRjNGn7m5CqEGy3L_98,50603
-elphick/geomet/block_model.py,sha256=Q-LEdILajUoteO0834IXeS75k8pcPqSaMrinMcWD8R4,14639
+elphick/geomet/block_model.py,sha256=E-krPZfjQVIjTgxdDgp0RbvDTJJLFJbUMELE6dh7Jlk,12937
 elphick/geomet/config/__init__.py,sha256=F94hbxN3KzSaljbElIGVhdEwX0FKmHxST4jJ7rNohxY,35
 elphick/geomet/config/config_read.py,sha256=frRwfRwUXpgxwMNCiBVFUw1-yPbBHs3h2KjmzXImvxY,1396
 elphick/geomet/config/flowsheet_example_partition.yaml,sha256=85vrhOotQHhaKkYN-0QQA7ed03EMRkyaKZc-GtXMKro,716
@@ -13,7 +13,7 @@ elphick/geomet/datasets/datasets.py,sha256=RUqQWXZTWEA3R4S5RRdjwlosQZFy2PaMX8x32
 elphick/geomet/datasets/downloader.py,sha256=JXHQfwQYbe1X-tIfajx4kGbqkcWh0U2k5R03ur2J6E4,1622
 elphick/geomet/datasets/register.csv,sha256=-N3F6L0097C-I79axINi_ewFAxiqbT_SOSW3-XtPkI4,3046
 elphick/geomet/datasets/sample_data.py,sha256=jt5DWxdMmPbZGDuon2s8Q2wlX3cEegB0dSmRKF4pz4I,7684
-elphick/geomet/extras.py,sha256=0yDwbPMylP21EOo27juu4gUiewygSXLSjggYDrPvDcQ,1128
+elphick/geomet/extras.py,sha256=UMkAYp72X-30ckaZ-2ENffUUZ7k7JBTdtgsVdgxxYAk,1164
 elphick/geomet/flowsheet/__init__.py,sha256=-lxSLPZNQfiLXKZ2qqS5XbbhrZA2ABi3ppx0LaHnNEI,33
 elphick/geomet/flowsheet/flowsheet.py,sha256=__kgowBIyWfvXcdPWCFihoEUdOqTj7KszSbKGF1AkBo,52032
 elphick/geomet/flowsheet/loader.py,sha256=8nd9Vqbg1de35iuoc4mdRFxrUsIBZed0ivXIAu80jBk,4756
@@ -41,8 +41,8 @@ elphick/geomet/utils/size.py,sha256=EmV_sv2bOImQN3s7TWCniU_y83HNJEPtZH7fMMkYTcc,
 elphick/geomet/utils/timer.py,sha256=8WNKLFcINRsZ3IsKtOIZ77YbKtqczyOOTEWY9h9Uxxw,3112
 elphick/geomet/utils/viz.py,sha256=M0CnfDXBHtYb8aak1Sfz6XLvRSmkzX3ybIDllEmDR8A,1718
 elphick/geomet/validate.py.hide,sha256=qAWJlgq0jp19UakVV0dEU_AsqV_JctUn1QTHn8cCRw0,6738
-geometallurgy-0.4.12.dist-info/LICENSE,sha256=GrSVdcGtNbGvAYC_tIjLHBrIVPyg-Ksfe7ZGr087yCI,1069
-geometallurgy-0.4.12.dist-info/METADATA,sha256=iatuwf4Pey2ZHhaEu-p-NJ-tEVCdZAijNXZf91jhgpM,4386
-geometallurgy-0.4.12.dist-info/WHEEL,sha256=WGfLGfLX43Ei_YORXSnT54hxFygu34kMpcQdmgmEwCQ,88
-geometallurgy-0.4.12.dist-info/entry_points.txt,sha256=aQI-8kmaba_c9ZGOFkJgWl0MWBke5BQLNyPSVcbS7EU,58
-geometallurgy-0.4.12.dist-info/RECORD,,
+geometallurgy-0.4.14.dist-info/LICENSE,sha256=GrSVdcGtNbGvAYC_tIjLHBrIVPyg-Ksfe7ZGr087yCI,1069
+geometallurgy-0.4.14.dist-info/METADATA,sha256=9BuaS4pfeVHbV7H6822vaZ2nKUgGgEJ3qbgjREwlzLQ,4476
+geometallurgy-0.4.14.dist-info/WHEEL,sha256=WGfLGfLX43Ei_YORXSnT54hxFygu34kMpcQdmgmEwCQ,88
+geometallurgy-0.4.14.dist-info/entry_points.txt,sha256=aQI-8kmaba_c9ZGOFkJgWl0MWBke5BQLNyPSVcbS7EU,58
+geometallurgy-0.4.14.dist-info/RECORD,,