steer-materials 0.1.16__tar.gz → 0.1.18__tar.gz

{steer_materials-0.1.16 → steer_materials-0.1.18}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: steer-materials
-Version: 0.1.16
+Version: 0.1.18
 Summary: Modelling energy storage from cell to site - STEER OpenCell Design
 Author-email: Nicholas Siemons <nsiemons@stanford.edu>
 Maintainer-email: Nicholas Siemons <nsiemons@stanford.edu>
@@ -22,7 +22,7 @@ Classifier: Topic :: Scientific/Engineering
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
-Requires-Dist: steer-core==0.1.27
+Requires-Dist: steer-core==0.1.33
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"

{steer_materials-0.1.16 → steer_materials-0.1.18}/pyproject.toml

@@ -31,7 +31,7 @@ classifiers = [
 ]
 
 dependencies = [
-    "steer-core==0.1.27",
+    "steer-core==0.1.33",
 ]
 
 [project.optional-dependencies]
@@ -73,4 +73,4 @@ target-version = ['py310']
 testpaths = ["test"]
 python_files = "test_*.py"
 python_classes = "Test*"
-python_functions = "test_*"
+python_functions = "test_*"

steer_materials-0.1.18/steer_materials/Base.py

@@ -0,0 +1,221 @@
+from steer_core.Constants.Units import *
+from steer_core.Mixins.TypeChecker import ValidationMixin
+from steer_core.Mixins.Serializer import SerializerMixin
+from steer_core.Mixins.Dunder import DunderMixin
+
+from datetime import datetime as dt
+
+import numpy as np
+
+
+class _Material(
+    ValidationMixin, 
+    DunderMixin,
+    SerializerMixin
+    ):
+
+    def __init__(self, name: str, density: float, specific_cost: float, color: str):
+        """
+        Metal object for encapsulation of the cell
+
+        Parameters
+        ----------
+        name : str
+            Name of the material.
+        density : float
+            Density of the material in g/cm^3.
+        specific_cost : float
+            Specific cost of the material in $/kg.
+        color : str
+            Color of the material.
+        """
+        self.density = density
+        self.specific_cost = specific_cost
+        self.name = name
+        self.color = color
+
+        self._last_updated = dt.now()
+        self._update_ranges()
+
+    def _update_ranges(self):
+        self._density_range = (self._density * 0.9, self._density * 1.1)
+        self._specific_cost_range = (self._specific_cost * 0.5, self._specific_cost * 2)
+
+    @property
+    def density(self):
+        return np.round(self._density * (KG_TO_G / M_TO_CM**3), 2)
+
+    @property
+    def density_range(self):
+        return (
+            np.round(self._density_range[0] * (KG_TO_G / M_TO_CM**3), 2),
+            np.round(self._density_range[1] * (KG_TO_G / M_TO_CM**3), 2),
+        )
+
+    @property
+    def density_hard_range(self):
+        return (0, 100)
+
+    @property
+    def specific_cost(self):
+        return np.round(self._specific_cost, 2)
+
+    @property
+    def specific_cost_range(self):
+        return (
+            np.round(self._specific_cost_range[0], 2),
+            np.round(self._specific_cost_range[1], 2),
+        )
+
+    @property
+    def specific_cost_hard_range(self):
+        return (0, 1000)
+
+    @property
+    def name(self):
+        return self._name
+
+    @property
+    def color(self):
+        return self._color
+
+    @property
+    def last_updated(self):
+        return self._last_updated.strftime("%Y-%m-%d %H:%M:%S")
+
+    @color.setter
+    def color(self, color: str) -> None:
+        self.validate_string(color, "Color")
+        self._color = color if color else "Unknown"
+
+    @density.setter
+    def density(self, density: float) -> None:
+
+        # validate input 
+        self.validate_positive_float(density, "Density")
+
+        # convert and set
+        self._density = density * G_TO_KG / CM_TO_M**3
+
+        # If this is a volumed material and volume is set, recalculate mass
+        if hasattr(self, '_volume') and self._volume is not None:
+            self._mass = self._volume * self._density
+            if hasattr(self, '_cost'):
+                self._cost = self._mass * self._specific_cost
+
+    @specific_cost.setter
+    def specific_cost(self, specific_cost: float) -> None:
+
+        # validate input
+        self.validate_positive_float(specific_cost, "Specific Cost")
+        
+        # set value
+        self._specific_cost = specific_cost
+        
+        # If this is a volumed material with mass, recalculate cost
+        if hasattr(self, '_mass') and self._mass is not None:
+            if hasattr(self, '_cost'):
+                self._cost = self._mass * self._specific_cost
+
+    @name.setter
+    def name(self, name: str) -> None:
+        self.validate_string(name, "Name")
+        self._name = name
+
+
+class Metal(_Material):
+
+    def __init__(self, name: str, density: float, specific_cost: float, color: str):
+
+        super().__init__(name, density, specific_cost, color)
+
+
+class Solvent(_Material):
+
+    def __init__(self, name: str, density: float, specific_cost: float, color: str):
+
+        super().__init__(name, density, specific_cost, color)
+
+
+class _VolumedMaterialMixin:
+    """
+    Mixin for materials that optionally track volume (cm^3) or mass (kg).
+    Cost ($) is always derived from mass and specific_cost.
+    """
+
+    def __init__(
+            self, 
+            *, 
+            volume=None, 
+            mass=None, 
+            **kwargs
+        ):
+
+        super().__init__(**kwargs)
+
+        # Check that only one of volume or mass is provided
+        provided = sum([volume is not None, mass is not None])
+        if provided > 1:
+            raise ValueError(
+                "Only one of 'volume' or 'mass' can be provided during initialization. "
+                f"Received: volume={volume}, mass={mass}"
+            )
+
+        self._volume = None
+        self._mass = None
+        self._cost = None
+
+        if volume is not None:
+            self.volume = volume
+        elif mass is not None:
+            self.mass = mass
+
+    @property
+    def volume(self):
+        if hasattr(self, '_volume') and self._volume is not None:
+            return np.round(self._volume * (M_TO_CM**3), 4)
+        else:
+            return None
+        
+    @property
+    def mass(self):
+        if hasattr(self, '_mass') and self._mass is not None:
+            return np.round(self._mass * KG_TO_G, 2)
+        else:
+            return None
+        
+    @property
+    def cost(self):
+        if hasattr(self, '_cost') and self._cost is not None:
+            return np.round(self._cost, 2)
+        else:
+            return None
+
+    
+    @volume.setter
+    def volume(self, value):
+        
+        if value is not None:
+            ValidationMixin.validate_positive_float(value, "Volume")
+            self._volume = value * CM_TO_M**3
+            self._mass = self._volume * self._density
+            self._cost = self._mass * self._specific_cost
+        else:
+            self._volume = None
+            self._mass = None
+            self._cost = None
+
+    @mass.setter
+    def mass(self, value):
+
+        if value is not None:
+            ValidationMixin.validate_positive_float(value, "Mass")
+            self._mass = value * G_TO_KG
+            self._volume = self._mass / self._density
+            self._cost = self._mass * self._specific_cost
+        else:
+            self._volume = None
+            self._mass = None
+            self._cost = None
+
+

steer_materials-0.1.18/steer_materials/__init__.py

@@ -0,0 +1,2 @@
+__version__ = "0.1.18"
+

{steer_materials-0.1.16 → steer_materials-0.1.18}/steer_materials.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: steer-materials
-Version: 0.1.16
+Version: 0.1.18
 Summary: Modelling energy storage from cell to site - STEER OpenCell Design
 Author-email: Nicholas Siemons <nsiemons@stanford.edu>
 Maintainer-email: Nicholas Siemons <nsiemons@stanford.edu>
@@ -22,7 +22,7 @@ Classifier: Topic :: Scientific/Engineering
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
-Requires-Dist: steer-core==0.1.27
+Requires-Dist: steer-core==0.1.33
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"

steer_materials-0.1.18/steer_materials.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+README.md
+pyproject.toml
+./steer_materials/Base.py
+./steer_materials/__init__.py
+steer_materials/Base.py
+steer_materials/__init__.py
+steer_materials.egg-info/PKG-INFO
+steer_materials.egg-info/SOURCES.txt
+steer_materials.egg-info/dependency_links.txt
+steer_materials.egg-info/requires.txt
+steer_materials.egg-info/top_level.txt

{steer_materials-0.1.16 → steer_materials-0.1.18}/steer_materials.egg-info/requires.txt

@@ -1,4 +1,4 @@
-steer-core==0.1.27
+steer-core==0.1.33
 
 [dev]
 pytest

steer_materials-0.1.16/steer_materials/Base.py

@@ -1,119 +0,0 @@
-from steer_core.Constants.Units import *
-from steer_core.Mixins.TypeChecker import ValidationMixin
-from steer_core.Mixins.Serializer import SerializerMixin
-from steer_core.Mixins.Dunder import DunderMixin
-
-from datetime import datetime as dt
-
-import numpy as np
-
-
-class _Material(
-    ValidationMixin, 
-    SerializerMixin,
-    DunderMixin
-    ):
-
-    def __init__(self, name: str, density: float, specific_cost: float, color: str):
-        """
-        Metal object for encapsulation of the cell
-
-        Parameters
-        ----------
-        name : str
-            Name of the material.
-        density : float
-            Density of the material in g/cm^3.
-        specific_cost : float
-            Specific cost of the material in $/kg.
-        color : str
-            Color of the material.
-        """
-        self.density = density
-        self.specific_cost = specific_cost
-        self.name = name
-        self.color = color
-
-        self._last_updated = dt.now()
-        self._update_ranges()
-
-    def _update_ranges(self):
-        self._density_range = (self._density * 0.9, self._density * 1.1)
-        self._specific_cost_range = (self._specific_cost * 0.5, self._specific_cost * 2)
-
-    @property
-    def density(self):
-        return round(self._density * (KG_TO_G / M_TO_CM**3), 2)
-
-    @property
-    def density_range(self):
-        return (
-            round(self._density_range[0] * (KG_TO_G / M_TO_CM**3), 2),
-            round(self._density_range[1] * (KG_TO_G / M_TO_CM**3), 2),
-        )
-
-    @property
-    def density_hard_range(self):
-        return (0, 100)
-
-    @property
-    def specific_cost(self):
-        return round(self._specific_cost, 2)
-
-    @property
-    def specific_cost_range(self):
-        return (
-            round(self._specific_cost_range[0], 2),
-            round(self._specific_cost_range[1], 2),
-        )
-
-    @property
-    def specific_cost_hard_range(self):
-        return (0, 1000)
-
-    @property
-    def name(self):
-        return self._name
-
-    @property
-    def color(self):
-        return self._color
-
-    @property
-    def last_updated(self):
-        return self._last_updated.strftime("%Y-%m-%d %H:%M:%S")
-
-    @color.setter
-    def color(self, color: str) -> None:
-        self.validate_string(color, "Color")
-        self._color = color if color else "Unknown"
-
-    @density.setter
-    def density(self, density: float) -> None:
-        self.validate_positive_float(density, "Density")
-        self._density = density * G_TO_KG / CM_TO_M**3
-
-    @specific_cost.setter
-    def specific_cost(self, specific_cost: float) -> None:
-        self.validate_positive_float(specific_cost, "Specific Cost")
-        self._specific_cost = specific_cost
-
-    @name.setter
-    def name(self, name: str) -> None:
-        self.validate_string(name, "Name")
-        self._name = name
-
-
-class Metal(_Material):
-
-    def __init__(self, name: str, density: float, specific_cost: float, color: str):
-
-        super().__init__(name, density, specific_cost, color)
-
-
-class Solvent(_Material):
-
-    def __init__(self, name: str, density: float, specific_cost: float, color: str):
-
-        super().__init__(name, density, specific_cost, color)
-

steer_materials-0.1.16/steer_materials/CellMaterials/Base.py

@@ -1,278 +0,0 @@
-from steer_core.DataManager import DataManager
-from steer_core.Mixins.Serializer import SerializerMixin
-from steer_materials.Base import Metal, _Material
-
-
-class CurrentCollectorMaterial(Metal):
-    """
-    Materials from which current collectors are made.
-    """
-
-    def __init__(self, name: str, density: float, specific_cost: float, color: str):
-        """
-        Current collector material for encapsulation of the cell
-
-        Parameters
-        ----------
-        name : str
-            Name of the current collector material.
-        density : float
-            Density of the material in g/cm^3.
-        specific_cost : float
-            Specific cost of the material in $/kg.
-        color : str
-            Color of the material.
-        """
-        super().__init__(name, density, specific_cost, color)
-
-    @staticmethod
-    def from_database(name) -> "CurrentCollectorMaterial":
-        """
-        Pull object from the database.
-
-        Parameters
-        ----------
-        name : str
-            Name of the current collector material.
-
-        Returns
-        -------
-        CurrentCollectorMaterial: Instance of the class.
-
-        Raises
-        ------
-        ValueError: If the material is not found in the database.
-        """
-        database = DataManager()
-
-        available_materials = database.get_unique_values(
-            "current_collector_materials", "name"
-        )
-
-        if name not in available_materials:
-            raise ValueError(
-                f"Material '{name}' not found in the database. Available materials: {available_materials}"
-            )
-
-        data = database.get_current_collector_materials(most_recent=True).query(
-            f"name == '{name}'"
-        )
-
-        string_rep = data["object"].iloc[0]
-
-        material = SerializerMixin.deserialize(string_rep)
-
-        return material
-
-
-class InsulationMaterial(_Material):
-    """
-    Materials from which insulation is made.
-    """
-
-    def __init__(self, name: str, density: float, specific_cost: float, color: str):
-        """
-        Insulation material for encapsulation of the cell
-
-        Parameters
-        ----------
-        name : str
-            Name of the insulation material.
-        density : float
-            Density of the material in g/cm^3.
-        specific_cost : float
-            Specific cost of the material in $/kg.
-        color : str
-            Color of the material.
-        """
-        super().__init__(name, density, specific_cost, color)
-
-    @staticmethod
-    def from_database(name) -> "InsulationMaterial":
-        """
-        Pull object from the database.
-
-        Parameters
-        ----------
-        name : str
-            Name of the insulation material.
-
-        Returns
-        -------
-        InsulationMaterial: Instance of the class.
-
-        Raises
-        ------
-        ValueError: If the material is not found in the database.
-        """
-        database = DataManager()
-        available_materials = database.get_unique_values("insulation_materials", "name")
-
-        if name not in available_materials:
-            raise ValueError(
-                f"Material '{name}' not found in the database. Available materials: {available_materials}"
-            )
-
-        data = database.get_data(table_name="insulation_materials").query(
-            f"name == '{name}'"
-        )
-
-        string_data = data["object"].iloc[0]
-        material = SerializerMixin.deserialize(string_data)
-        return material
-
-
-class SeparatorMaterial(_Material):
-    """
-    Materials from which separators are made.
-    """
-
-    def __init__(
-        self,
-        name: str,
-        density: float,
-        specific_cost: float,
-        porosity: float,
-        color: str,
-    ):
-        """
-        Separator material for encapsulation of the cell
-
-        Parameters
-        ----------
-        name : str
-            Name of the separator material.
-        density : float
-            Density of the material in g/cm^3.
-        specific_cost : float
-            Specific cost of the material in $/kg.
-        porosity : float
-            Porosity of the separator material in %.
-        color : str
-            Color of the material.
-        """
-        super().__init__(
-            name, 
-            density, 
-            specific_cost, 
-            color
-        )
-
-        self.porosity = porosity
-
-    @property
-    def porosity(self):
-        return round(self._porosity * 100, 2)
-    
-    @property
-    def porosity_range(self):
-        return (0, 100)
-
-    @porosity.setter
-    def porosity(self, porosity: float) -> None:
-        self.validate_percentage(porosity, "Porosity")
-        self._porosity = porosity / 100.0
-
-    @staticmethod
-    def from_database(name) -> "SeparatorMaterial":
-        """
-        Pull object from the database.
-
-        Parameters
-        ----------
-        name : str
-            Name of the separator material.
-
-        Returns
-        -------
-        SeparatorMaterial: Instance of the class.
-
-        Raises
-        ------
-        ValueError: If the material is not found in the database.
-        """
-        database = DataManager()
-
-        available_materials = database.get_unique_values("separator_materials", "name")
-
-        if name not in available_materials:
-            raise ValueError(
-                f"Material '{name}' not found in the database. Available materials: {available_materials}"
-            )
-
-        data = database.get_data(table_name="separator_materials").query(
-            f"name == '{name}'"
-        )
-
-        string_data = data["object"].iloc[0]
-        material = SerializerMixin.deserialize(string_data)
-        return material
-
-
-
-class TapeMaterial(_Material):
-    """
-    Materials from which tapes are made.
-    """
-
-    def __init__(
-        self,
-        name: str,
-        density: float,
-        specific_cost: float,
-        color: str,
-    ):
-        """
-        Separator material for encapsulation of the cell
-
-        Parameters
-        ----------
-        name : str
-            Name of the tape material.
-        density : float
-            Density of the material in g/cm^3.
-        specific_cost : float
-            Specific cost of the material in $/kg.
-        color : str
-            Color of the material.
-        """
-        super().__init__(
-            name, 
-            density, 
-            specific_cost, 
-            color
-        )
-
-    @staticmethod
-    def from_database(name) -> "TapeMaterial":
-        """
-        Pull object from the database.
-
-        Parameters
-        ----------
-        name : str
-            Name of the tape material.
-
-        Returns
-        -------
-        TapeMaterial: Instance of the class.
-        Raises
-        ------
-        ValueError: If the material is not found in the database.
-        """
-        database = DataManager()
-
-        available_materials = database.get_unique_values("tape_materials", "name")
-
-        if name not in available_materials:
-            raise ValueError(
-                f"Material '{name}' not found in the database. Available materials: {available_materials}"
-            )
-
-        data = database.get_data(table_name="tape_materials").query(
-            f"name == '{name}'"
-        )
-
-        string_data = data["object"].iloc[0]
-        material = SerializerMixin.deserialize(string_data)
-        return material