geometallurgy 0.4.5__tar.gz → 0.4.7__tar.gz

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

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

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

@@ -235,6 +235,78 @@ class MassComposition(ABC):
 
         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 clip_composition(self, ranges: Optional[dict[str, list[float]]] = None) -> MC:
+        """Clip the components
+
+        Clip to the components to within the range provided or the default range for each component.
+        This method does not clip moisture - see set_moisture and solve_moisture for that.
+
+        Args:
+            ranges: An optional dict defining a list of [lo, hi] floats for each component.  If not provided,
+            the default range from the config file will be used.
+
+        Returns:
+            The object with clipped composition.
+        """
+
+        # load the default ranges from the config file
+        component_ranges: dict = self._get_component_ranges(ranges)
+
+        # define a small value to ensure the clipped values lie marginally inside the specified range.
+        epsilon: float = 0.0  # 1.0e-05
+        # clip the components
+        affected_indexes = set()
+        for component, component_range in component_ranges.items():
+            before_clip = self._mass_data[component].copy()
+            # define the component mass that aligns with the lower and upper bounds
+            component_mass_limits = self._mass_data[self.mass_dry_var].values[:, np.newaxis] * np.array(
+                component_range) / self.composition_factor
+            # apply the clip to the mass data
+            self._mass_data[component] = self._mass_data[component].clip(lower=component_mass_limits[:, 0] + epsilon,
+                                                                         upper=component_mass_limits[:, 1] - epsilon)
+            affected_indexes.update(self._mass_data.index[before_clip != self._mass_data[component]])
+
+        # log the action, including the first 50 indexes affected
+        affected_indexes_list = sorted(affected_indexes)[:50]
+        self._logger.info(
+            f"{len(affected_indexes)} records where composition has been clipped to the range: {component_ranges}."
+            f" Affected indexes (first 50): {affected_indexes_list}")
+
+        return self
+
     def plot_parallel(self, color: Optional[str] = None,
                       vars_include: Optional[list[str]] = None,
                       vars_exclude: Optional[list[str]] = None,
@@ -771,6 +843,20 @@ class MassComposition(ABC):
 
         return res
 
+    def _get_component_ranges(self, ranges: dict[str, list]) -> dict[str, list]:
+
+        d_ranges: dict = get_column_config(config_dict=self.config, var_map=self.variable_map,
+                                           config_key='range')
+        # filter to include only components
+        d_ranges = {k: v for k, v in d_ranges.items() if k in self.composition_columns}
+
+        # modify the default dict based on any user passed constraints
+        if ranges:
+            for k, v in ranges.items():
+                d_ranges[k] = v
+
+        return d_ranges
+
 
 class OutOfRangeStatus:
     """A class to check and report out-of-range records in an MC object."""

{geometallurgy-0.4.5 → geometallurgy-0.4.7}/elphick/geomet/config/mc_config.yml

@@ -27,6 +27,7 @@ MC:
       - [from, to]
       - [retained, passing]
       - [sink, float]
+      - [lo, hi]
   comparisons:
     recovery: 'rec'
     difference: 'diff'

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

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