geometallurgy 0.4.4__tar.gz → 0.4.6__tar.gz

{geometallurgy-0.4.4 → geometallurgy-0.4.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: geometallurgy
-Version: 0.4.4
+Version: 0.4.6
 Summary: Tools for the geometallurgist
 Home-page: https://github.com/elphick/geometallurgy
 Author: Greg

{geometallurgy-0.4.4 → geometallurgy-0.4.6}/elphick/geomet/base.py

@@ -213,6 +213,61 @@ 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 set_moisture(self, moisture: Union[pd.Series, float, int], mass_to_adjust: Literal['wet', 'dry'] = 'wet') -> MC:
+        """Set the moisture to the specified value
+
+        A convenience method for an mc object that modifies the concrete mass to deliver the specified moisture.
+
+        Args:
+            moisture: The moisture value to set.  Can be a constant or series.
+            mass_to_adjust: The mass to adjust, either 'wet' or 'dry'.
+
+        Returns:
+
+        """
+
+        if not self.moisture_in_scope:
+            raise AssertionError("This method is not applicable unless moisture_in_scope property is True.")
+
+        if isinstance(moisture, float) or isinstance(moisture, int):
+            # create a series with the same index as the mass data
+            moisture = pd.Series(float(moisture), index=self._mass_data.index)
+        elif not isinstance(moisture, pd.Series):
+            raise TypeError(f"moisture must be a float or a pd.Series, not {type(moisture)}")
+
+        if mass_to_adjust == 'wet':
+            self._mass_data[self.mass_wet_var] = solve_mass_moisture(mass_dry=self._mass_data[self.mass_dry_var],
+                                                                     moisture=moisture)
+        elif mass_to_adjust == 'dry':
+            self._mass_data[self.mass_dry_var] = solve_mass_moisture(mass_wet=self._mass_data[self.mass_wet_var],
+                                                                     moisture=moisture)
+        else:
+            raise ValueError(f"mass_to_adjust must be 'wet' or 'dry', not {mass_to_adjust}")
+
+        return self
+
     def plot_parallel(self, color: Optional[str] = None,
                       vars_include: Optional[list[str]] = None,
                       vars_exclude: Optional[list[str]] = None,
@@ -696,7 +751,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.4 → geometallurgy-0.4.6}/pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "geometallurgy"
 packages = [{ include = "elphick/geomet" }]
-version = "0.4.4"
+version = "0.4.6"
 description = "Tools for the geometallurgist"
 authors = ["Greg <11791585+elphick@users.noreply.github.com>"]
 repository = "https://github.com/elphick/geometallurgy"