steer-core 0.1.10__tar.gz → 0.1.12__tar.gz

{steer_core-0.1.10 → steer_core-0.1.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: steer-core
-Version: 0.1.10
+Version: 0.1.12
 Summary: Modelling energy storage from cell to site - STEER OpenCell Design
 Home-page: https://github.com/nicholas9182/steer-core/
 Author: Nicholas Siemons

{steer_core-0.1.10 → steer_core-0.1.12}/steer_core/Apps/Components/SliderComponents.py

@@ -36,12 +36,12 @@ class SliderWithTextInput:
     Example:
         >>> slider_component = SliderWithTextInput(
         ...     id_base={'type': 'parameter', 'index': 0},
+        ...     property_name='temperature',
+        ...     title='Temperature (°C)',
         ...     min_val=0.0,
         ...     max_val=100.0,
         ...     step=1.0,
-        ...     mark_interval=10.0,
-        ...     property_name='temperature',
-        ...     title='Temperature (°C)',
+        ...     mark_interval=50.0,
         ...     default_val=25.0,
         ...     message='Optimal range is 20-30°C'  # Optional message
         ... )
@@ -51,12 +51,12 @@ class SliderWithTextInput:
     def __init__(
         self,
         id_base: dict,
-        min_val: float,
-        max_val: float,
-        step: float,
-        mark_interval: float,
         property_name: str,
         title: str,
+        min_val: float = 0.0,
+        max_val: float = 100.0,
+        step: float = 1.0,
+        mark_interval: float = 50.0,
         default_val: Union[float, list[float]] = None,
         with_slider_titles: bool = True,
         slider_disable: bool = False,
@@ -71,17 +71,17 @@ class SliderWithTextInput:
             id_base (dict): Base dictionary for generating component IDs. Should contain
                            identifying information that will be extended with component-specific
                            subtypes and properties.
-            min_val (float): Minimum value that can be selected on the slider or entered
-                           in the text input.
-            max_val (float): Maximum value that can be selected on the slider or entered
-                           in the text input.
-            step (float): The granularity of value changes. Determines the smallest
-                         increment/decrement possible.
-            mark_interval (float): The spacing between tick marks displayed on the slider.
-                                 Should be a multiple of step for best visual alignment.
             property_name (str): A string identifier for this specific property, used
                                in ID generation and callbacks.
             title (str): Human-readable title displayed above the component.
+            min_val (float, optional): Minimum value that can be selected on the slider or entered
+                           in the text input. Defaults to 0.0.
+            max_val (float, optional): Maximum value that can be selected on the slider or entered
+                           in the text input. Defaults to 100.0.
+            step (float, optional): The granularity of value changes. Determines the smallest
+                         increment/decrement possible. Defaults to 1.0.
+            mark_interval (float, optional): The spacing between tick marks displayed on the slider.
+                                 Should be a multiple of step for best visual alignment. Defaults to 50.0.
             default_val (Union[float, list[float]], optional): Initial value to display.
                         If None, defaults to min_val. Can be a single float or list
                         for compatibility with range sliders.
@@ -439,14 +439,14 @@ class SliderWithTextInputAndCheckbox(SliderWithTextInput):
     Example:
         >>> slider_component = SliderWithTextInputAndCheckbox(
         ...     id_base={'type': 'parameter', 'index': 0},
+        ...     property_name='temperature',
+        ...     title='Temperature (°C)',
+        ...     checkbox_message='Use automatic temperature control',
         ...     min_val=0.0,
         ...     max_val=100.0,
         ...     step=1.0,
-        ...     mark_interval=10.0,
-        ...     property_name='temperature',
-        ...     title='Temperature (°C)',
+        ...     mark_interval=50.0,
         ...     default_val=25.0,
-        ...     checkbox_message='Use automatic temperature control',
         ...     checkbox_default=True
         ... )
         >>> layout_element = slider_component()  # Returns Dash HTML Div component
@@ -455,13 +455,13 @@ class SliderWithTextInputAndCheckbox(SliderWithTextInput):
     def __init__(
         self,
         id_base: dict,
-        min_val: float,
-        max_val: float,
-        step: float,
-        mark_interval: float,
         property_name: str,
         title: str,
         checkbox_message: str,
+        min_val: float = 0.0,
+        max_val: float = 100.0,
+        step: float = 1.0,
+        mark_interval: float = 50.0,
         default_val: Union[float, list[float]] = None,
         checkbox_default: bool = False,
         with_slider_titles: bool = True,
@@ -474,13 +474,13 @@ class SliderWithTextInputAndCheckbox(SliderWithTextInput):
         
         Args:
             id_base (dict): Base dictionary for generating component IDs.
-            min_val (float): Minimum value for the slider and input.
-            max_val (float): Maximum value for the slider and input.
-            step (float): Step size for value increments/decrements.
-            mark_interval (float): Interval between tick marks on the slider.
             property_name (str): String identifier for this property.
             title (str): Title displayed above the component.
             checkbox_message (str): Message displayed next to the checkbox.
+            min_val (float, optional): Minimum value for the slider and input. Defaults to 0.0.
+            max_val (float, optional): Maximum value for the slider and input. Defaults to 100.0.
+            step (float, optional): Step size for value increments/decrements. Defaults to 1.0.
+            mark_interval (float, optional): Interval between tick marks on the slider. Defaults to 50.0.
             default_val (Union[float, list[float]], optional): Initial value for slider/input.
             checkbox_default (bool, optional): Initial checked state of checkbox. Defaults to False.
             with_slider_titles (bool, optional): Whether to show title. Defaults to True.
@@ -491,12 +491,12 @@ class SliderWithTextInputAndCheckbox(SliderWithTextInput):
         # Initialize parent class
         super().__init__(
             id_base=id_base,
+            property_name=property_name,
+            title=title,
             min_val=min_val,
             max_val=max_val,
             step=step,
             mark_interval=mark_interval,
-            property_name=property_name,
-            title=title,
             default_val=default_val,
             with_slider_titles=with_slider_titles,
             slider_disable=slider_disable,

{steer_core-0.1.10 → steer_core-0.1.12}/steer_core/Mixins/Coordinates.py

@@ -280,10 +280,10 @@ class CoordinateMixin:
         Returns
         -------
         Tuple[np.ndarray, np.ndarray]
-            Modified x and y coordinate arrays with None separators between segments
+            Modified x and y coordinate arrays with np.nan separators between segments
         """
         if len(x_coords) == 0 or len(y_coords) == 0:
-            return np.array([]), np.array([])
+            return np.array([], dtype=float), np.array([], dtype=float)
         
         x_min, x_max = np.min(x_coords), np.max(x_coords)
         y_min, y_max = np.min(y_coords), np.max(y_coords)
@@ -297,7 +297,7 @@ class CoordinateMixin:
         if len(valid_positions) == 0:
             rect_x = [x_min, x_max, x_max, x_min, x_min]
             rect_y = [y_min, y_min, y_max, y_max, y_min]
-            return np.array(rect_x, dtype=object), np.array(rect_y, dtype=object)
+            return np.array(rect_x, dtype=float), np.array(rect_y, dtype=float)
         
         # Sort weld tab cut positions
         cuts = np.sort(valid_positions)
@@ -317,7 +317,7 @@ class CoordinateMixin:
         if start < x_max:
             segments.append((start, x_max))
         
-        # Build rectangles for each kept segment with None separators
+        # Build rectangles for each kept segment with np.nan separators
         x_result = []
         y_result = []
         
@@ -329,10 +329,10 @@ class CoordinateMixin:
             x_result.extend(rect_x)
             y_result.extend(rect_y)
             
-            # Add None separator (except for the last segment)
+            # Add np.nan separator (except for the last segment)
             if i < len(segments) - 1:  # Fixed: use index comparison
-                x_result.append(None)
-                y_result.append(None)
+                x_result.append(np.nan)
+                y_result.append(np.nan)
         
-        return np.array(x_result, dtype=object), np.array(y_result, dtype=object)
+        return np.array(x_result, dtype=float), np.array(y_result, dtype=float)
 

steer_core-0.1.10/steer_core/Mixins/Validators.py → steer_core-0.1.12/steer_core/Mixins/validators.py

@@ -14,124 +14,26 @@ ALLOWED_REFERENCE = [
 class ValidationMixin:
 
     @staticmethod
-    def validate_formulations(value: Type) -> None:
+    def validate_type(value: Type, expected_type: Type, name: str) -> None:
         """
-        Validate that a value is an instance of _ElectrodeFormulation.
+        Validate that a value is of the expected type.
 
         Parameters
         ----------
         value : Type
             The value to validate.
+        expected_type : Type
+            The expected type of the value.
+        name : str
+            The name of the parameter for error messages.
 
         Raises
         ------
         TypeError
-            If the value is not an instance of _ElectrodeFormulation.
-        """
-        from steer_opencell_design.Formulations.ElectrodeFormulations import _ElectrodeFormulation
-
-        if not isinstance(value, _ElectrodeFormulation):
-            raise TypeError(f"Expected an instance of _ElectrodeFormulation. Provided: {type(value)}.")
-
-    @staticmethod
-    def validate_insulation_material(value: Type) -> None:
-        """
-        Validate that a value is an instance of InsulationMaterial.
-
-        Parameters
-        ----------
-        value : Type
-            The value to validate.
-
-        Raises
-        ------
-        TypeError
-            If the value is not an instance of InsulationMaterial.
-        """
-        from steer_materials.CellMaterials.Base import InsulationMaterial
-
-        if not isinstance(value, InsulationMaterial):
-            raise TypeError(f"Expected an instance of InsulationMaterial. Provided: {type(value)}.")
-
-    @staticmethod
-    def validate_current_collector(value: Type) -> None:
-        """
-        Validate that a value is an instance of _CurrentCollector.
-        
-        Parameters
-        ----------
-        value : Type
-            The value to validate.
-
-        Raises
-        ------
-        TypeError
-            If the value is not an instance of _CurrentCollector.
-        """
-        from steer_opencell_design.Components.CurrentCollectors import _CurrentCollector
-
-        if not isinstance(value, _CurrentCollector):
-            raise TypeError(f"Expected an instance of _CurrentCollector. Provided: {type(value)}.")
-
-    @staticmethod
-    def validate_active_material(value: Type) -> None:
-        """
-        Validate that a value is an instance of _ActiveMaterial.
-        
-        Parameters
-        ----------
-        value : Type
-            The value to validate.
-
-        Raises
-        ------
-        TypeError
-            If the value is not an instance of _ActiveMaterial.
-        """
-        from steer_materials.CellMaterials.Electrode import _ActiveMaterial
-
-        if not isinstance(value, _ActiveMaterial):
-            raise TypeError(f"Expected an instance of _ActiveMaterial. Provided: {type(value)}.")
-
-    @staticmethod
-    def validate_binder(value: Type) -> None:
-        """
-        Validate that a value is an instance of Binder.
-        
-        Parameters
-        ----------
-        value : Type
-            The value to validate.
-
-        Raises
-        ------
-        TypeError
-            If the value is not an instance of Binder.
-        """
-        from steer_materials.CellMaterials.Electrode import Binder
-
-        if not isinstance(value, Binder):
-            raise TypeError(f"Expected an instance of Binder. Provided: {type(value)}.")
-        
-    @staticmethod
-    def validate_conductive_additive(value: Type) -> None:
-        """
-        Validate that a value is an instance of ConductiveAdditive.
-        
-        Parameters
-        ----------
-        value : Type
-            The value to validate.
-
-        Raises
-        ------
-        TypeError
-            If the value is not an instance of ConductiveAdditive.
+            If the value is not of the expected type.
         """
-        from steer_materials.CellMaterials.Electrode import ConductiveAdditive
-
-        if not isinstance(value, ConductiveAdditive):
-            raise TypeError(f"Expected an instance of ConductiveAdditive. Provided: {type(value)}.")
+        if not isinstance(value, expected_type):
+            raise TypeError(f"{name} must be of type {expected_type.__name__}. Provided: {type(value).__name__}.")
 
     @staticmethod
     def validate_percentage(value: float, name: str) -> None:
@@ -248,48 +150,6 @@ class ValidationMixin:
         if not all(isinstance(coord, (int, float)) for coord in datum):
             raise TypeError("All coordinates in datum must be numbers.")
     
-    @staticmethod
-    def validate_current_collector_material(material: Type) -> None:
-        """
-        Validate the current collector material.
-
-        Parameters
-        ----------
-        material : str
-            The material to validate.
-
-        Raises
-        ------
-        ValueError
-            If the material is not a valid current collector material.
-        """
-        from steer_materials.CellMaterials.Base import CurrentCollectorMaterial
-
-        if type(material) is not CurrentCollectorMaterial:
-
-            raise ValueError(f"Invalid current collector material: {material}. "
-                             "Must be an instance of CurrentCollectorMaterial.")
-
-    @staticmethod
-    def validate_weld_tab(tab) -> None:
-        """
-        Validate the weld tab.
-
-        Parameters
-        ----------
-        tab : WeldTab
-            The weld tab to validate.
-
-        Raises
-        ------
-        ValueError
-            If the weld tab is not valid.
-        """
-        from steer_opencell_design.Components.CurrentCollectors import WeldTab
-        
-        if not isinstance(tab, WeldTab):
-            raise ValueError(f"Invalid weld tab: {tab}. Must be an instance of WeldTab.")
-
     @staticmethod
     def validate_positive_float(value: float, name: str) -> None:
         """
@@ -382,39 +242,3 @@ class ValidationMixin:
         if len(value) == 0:
             raise ValueError(f"{name} must not be an empty list. Provided: {value}.")
         
-
-class DataMixin:
-    """
-    A mixin class to handle data processing and validation for electrode materials.
-    Provides methods to calculate properties, check curve directions, and process half-cell curves.
-    """
-    @staticmethod
-    def enforce_monotonicity(array: np.ndarray) -> np.ndarray:
-        """
-        Enforces a monotonic version of the input array.
-        If the array is not monotonic, it is smoothed using cumulative max/min.
-        """
-        x = np.arange(len(array))
-        diff = np.diff(array)
-
-        if np.all(diff >= 0):
-            return array  # Already monotonic increasing
-
-        if np.all(diff <= 0):
-            return array  # Already monotonic decreasing, reverse it
-
-        # Determine general trend (ascending or descending)
-        ascending = array[-1] >= array[0]
-
-        # Sort by x so that PCHIP works (PCHIP requires increasing x)
-        # We'll smooth the array using PCHIP, then enforce monotonicity
-        interpolator = PchipInterpolator(x, array, extrapolate=False)
-        new_array = interpolator(x)
-
-        # Enforce strict monotonicity post-smoothing
-        if ascending:
-            new_array = np.maximum.accumulate(new_array)
-        else:
-            new_array = np.minimum.accumulate(new_array)
-
-        return new_array

steer_core-0.1.12/steer_core/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.12"

{steer_core-0.1.10 → steer_core-0.1.12}/steer_core.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: steer-core
-Version: 0.1.10
+Version: 0.1.12
 Summary: Modelling energy storage from cell to site - STEER OpenCell Design
 Home-page: https://github.com/nicholas9182/steer-core/
 Author: Nicholas Siemons

{steer_core-0.1.10 → steer_core-0.1.12}/steer_core.egg-info/SOURCES.txt

@@ -34,6 +34,7 @@ steer_core/Mixins/Data.py
 steer_core/Mixins/Serializer.py
 steer_core/Mixins/Validators.py
 steer_core/Mixins/__init__.py
+steer_core/Mixins/validators.py
 test/test_compound_components.py
 test/test_compound_components_clean.py
 test/test_slider_controls.py

steer_core-0.1.10/steer_core/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.1.10"