geometallurgy 0.4.3__tar.gz → 0.4.5__tar.gz

{geometallurgy-0.4.3 → geometallurgy-0.4.5}/PKG-INFO

@@ -1,26 +1,26 @@
 Metadata-Version: 2.1
 Name: geometallurgy
-Version: 0.4.3
+Version: 0.4.5
 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.11
+Requires-Python: >=3.9,<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: validation
 Requires-Dist: folium (>=0.16.0,<0.17.0) ; extra == "map"
-Requires-Dist: geoh5py (>=0.8.0,<0.9.0)
 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,<17.0.0)
+Requires-Dist: pyarrow (>=16.1.0,<18.0.0)
 Project-URL: Documentation, https://elphick.github.io/geometallurgy
 Project-URL: Repository, https://github.com/elphick/geometallurgy
 Description-Content-Type: text/markdown

{geometallurgy-0.4.3 → geometallurgy-0.4.5}/elphick/geomet/base.py

@@ -213,6 +213,28 @@ class MassComposition(ABC):
                 (self.mass_columns + [self.moisture_column] + self.composition_columns + self.supplementary_columns) if
                 col is not None]
 
+    def balance_composition(self) -> MC:
+        """Balance the composition data
+
+        For records where the component mass exceeds the dry mass, the component masses are reduced proportionally
+        to equal the dry mass.  Records where the component mass is less than the dry mass are left unchanged.
+
+        """
+        if self._mass_data is not None:
+            # calculate the ratio of the sum of the components to the dry mass
+            ratio = self._mass_data[self.composition_columns].sum(axis=1) / self._mass_data[self.mass_dry_var]
+            if ratio.max() <= 1.0:
+                return self
+            epsilon = 1e-6
+            # add a small value to the ratio to avoid component sums marginally over 100.0
+            ratio[ratio > 1.0] = ratio[ratio > 1.0] + epsilon
+            # to avoid reducing compliant records, clip the ratio at the lower side to 1.0
+            ratio = ratio.clip(lower=1.0)
+            # apply the ratio to the components
+            self._mass_data[self.composition_columns] = self._mass_data[self.composition_columns].div(ratio, axis=0)
+
+        return self
+
     def plot_parallel(self, color: Optional[str] = None,
                       vars_include: Optional[list[str]] = None,
                       vars_exclude: Optional[list[str]] = None,
@@ -696,7 +718,7 @@ class MassComposition(ABC):
                             moisture_column_name: Optional[str] = None,
                             component_columns: Optional[list[str]] = None,
                             composition_units: Literal['%', 'ppm', 'ppb'] = '%',
-                            **kwargs):
+                            **kwargs) -> MC:
         """
         Class method to create a MassComposition object from a mass dataframe.
 

{geometallurgy-0.4.3 → geometallurgy-0.4.5}/pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "geometallurgy"
 packages = [{ include = "elphick/geomet" }]
-version = "0.4.3"
+version = "0.4.5"
 description = "Tools for the geometallurgist"
 authors = ["Greg <11791585+elphick@users.noreply.github.com>"]
 repository = "https://github.com/elphick/geometallurgy"
@@ -31,12 +31,12 @@ name = "Other Tasks"
 showcontent = true
 
 [tool.poetry.dependencies]
-python = ">=3.9,<3.11"
+python = ">=3.9,<3.13"
 plotly = "^5.22.0"
 pandas = ">=1.0"
 periodictable = "^1.7.0"
-geoh5py = "^0.8.0"
-pyarrow = "^16.1.0"
+#geoh5py = ">=0.8.0,<10.0.0"
+pyarrow = ">=16.1.0,<18.0.0"
 folium = { version = "^0.16.0", optional = true }
 pandera = { version = ">=0.19.3,<0.21.0", extras = ['io'], optional = true }
 omfvista = { version = ">=0.3.0", optional = true }