steer-materials 0.1.13__py3-none-any.whl → 0.1.15__py3-none-any.whl

steer_materials/CellMaterials/Base.py

@@ -207,3 +207,72 @@ class SeparatorMaterial(_Material):
         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

steer_materials/CellMaterials/Electrode.py

@@ -9,6 +9,7 @@ from steer_materials.Base import _Material
 import pandas as pd
 import numpy as np
 import plotly.express as px
+from plotly import graph_objects as go
 from typing import List, Tuple, Union, Optional
 from copy import deepcopy
 
@@ -789,6 +790,18 @@ class _ActiveMaterial(_Material, DataMixin):
     def reversible_capacity_scaling_hard_range(self) -> Tuple:
         return 0, 2
 
+    @property
+    def half_cell_curve_trace(self) -> go.Scatter:
+
+        return go.Scatter(
+            x=self.half_cell_curve["Specific Capacity (mAh/g)"],
+            y=self.half_cell_curve["Voltage (V)"],
+            name=self.name,
+            line=dict(color=self._color, width=2),
+            mode="lines",
+            hovertemplate="<b>%{fullData.name}</b><br>" + "Capacity: %{x:.2f} mAh/g<br>" + "Voltage: %{y:.3f} V<br>" + "<i>Individual Material</i><extra></extra>",
+        )
+
     @reference.setter
     def reference(self, reference: str):
         self.validate_electrochemical_reference(reference)

steer_materials/Electrolytes/Electrolytes.py

@@ -1,55 +1,16 @@
 from steer_core.Constants.Units import *
-from steer_core.Mixins.Dunder import DunderMixin
+from steer_materials.Base import _Material
 
 
-class Electrolyte(DunderMixin):
+class Electrolyte(_Material):
 
-    def __init__(self, specific_cost: float, density: float, name: str = "Electrolyte"):
-        """
-        Initialize an object that represents an electrolyte
+    def __init__(
+            self, 
+            name: str, 
+            density: float, 
+            specific_cost: float, 
+            color: str
+        ):
 
-        :param name: str: name of the material
-        :param specific_cost: float: specific cost of the material $/kg
-        :param density: float: density of the material in g/cm^3
-        """
-        self._name = name
-        self._specific_cost = specific_cost
-        self._density = density * (G_TO_KG / CM_TO_M**3)
-
-    @property
-    def name(self):
-        return self._name
-
-    @property
-    def formula(self):
-        return self._formula
-
-    @property
-    def specific_cost(self):
-        return self._specific_cost
-
-    @property
-    def mass(self):
-        try:
-            return round(self._mass * KG_TO_G, 2)
-        except AttributeError:
-            return AttributeError("Mass not calculated yet")
-
-    @property
-    def volume(self):
-        try:
-            return round(self._volume * M_TO_CM**3, 2)
-        except AttributeError:
-            return AttributeError("Volume not calculated yet")
-
-    @property
-    def cost(self):
-        try:
-            return self._cost
-        except AttributeError:
-            return AttributeError("Cost not calculated yet")
-
-    @property
-    def density(self):
-        return round(self._density * (KG_TO_G / M_TO_CM**3), 2)
+        super().__init__(name, density, specific_cost, color)
 

steer_materials/__init__.py

@@ -1 +1,6 @@
-__version__ = "0.1.13"
+__version__ = "0.1.15"
+
+# import base materials
+from .CellMaterials.Base import TapeMaterial, SeparatorMaterial, CurrentCollectorMaterial, InsulationMaterial
+from .CellMaterials.Electrode import AnodeMaterial, CathodeMaterial, ConductiveAdditive, Binder
+

steer_materials-0.1.15.dist-info/METADATA

@@ -0,0 +1,36 @@
+Metadata-Version: 2.4
+Name: steer-materials
+Version: 0.1.15
+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>
+License: MIT
+Project-URL: Homepage, https://github.com/stanford-developers/steer-materials/
+Project-URL: Repository, https://github.com/stanford-developers/steer-materials/
+Project-URL: Bug Tracker, https://github.com/stanford-developers/steer-materials/issues
+Keywords: battery,materials,simulation,electrochemistry,energy-storage
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+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.26
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"

steer_materials-0.1.15.dist-info/RECORD

@@ -0,0 +1,14 @@
+steer_materials/Base.py,sha256=JY2zDuFInbOKsgfEmGFGGnlpiBGxhK7A22pKYeakEr0,3169
+steer_materials/__init__.py,sha256=bhUdCgOYQYVfHQb5EEt7RtjVjZW7Z6iC4-KA207x0RE,255
+steer_materials/CellMaterials/Base.py,sha256=PElTtN_l2VkwLVwmlDzLWfaB38-49PsQCdM23xTyM0U,7361
+steer_materials/CellMaterials/Electrode.py,sha256=afeIEe0mbH-BS5GTms5Na5sjcrzliMV2Qdj21Jnqfxw,45332
+steer_materials/CellMaterials/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+steer_materials/Electrolytes/Electrolytes.py,sha256=6NOJ4wqgd1WKSMQ_ROupnRg6cqLi0hUHOKL57gj5O6I,340
+steer_materials/Electrolytes/Ions.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+steer_materials/Electrolytes/Salts.py,sha256=izZPekYqFkCdNDXOyn2TUR7l5SBxwnnN00sm1G_jaRs,769
+steer_materials/Electrolytes/Solvents.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+steer_materials/Electrolytes/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+steer_materials-0.1.15.dist-info/METADATA,sha256=oSRHjwt6j3EsPiNkhb34_9xybxQ9NnsAPVis0yoDrzk,1622
+steer_materials-0.1.15.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+steer_materials-0.1.15.dist-info/top_level.txt,sha256=vlZIS_XS59tP1rltDORHZbwi6KZ99QjnPoPN46hpsP0,16
+steer_materials-0.1.15.dist-info/RECORD,,

{steer_materials-0.1.13.dist-info → steer_materials-0.1.15.dist-info}/top_level.txt

@@ -1,2 +1 @@
-data_scripts
 steer_materials

steer_materials-0.1.13.dist-info/METADATA

@@ -1,24 +0,0 @@
-Metadata-Version: 2.4
-Name: steer-materials
-Version: 0.1.13
-Summary: Modelling energy storage from cell to site - STEER OpenCell Design
-Home-page: https://github.com/stanford-developers/steer-materials/
-Author: Nicholas Siemons
-Author-email: nsiemons@stanford.edu
-Classifier: Programming Language :: Python :: 3
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.10
-Requires-Dist: pandas==2.1.4
-Requires-Dist: numpy==1.26.4
-Requires-Dist: datetime==5.5
-Requires-Dist: plotly==6.2.0
-Requires-Dist: dash==3.1.1
-Requires-Dist: dash_bootstrap_components==2.0.3
-Requires-Dist: flask_caching==2.3.1
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: home-page
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary

steer_materials-0.1.13.dist-info/RECORD

@@ -1,15 +0,0 @@
-data_scripts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-steer_materials/Base.py,sha256=JY2zDuFInbOKsgfEmGFGGnlpiBGxhK7A22pKYeakEr0,3169
-steer_materials/__init__.py,sha256=khDKUuWafURKVs5EAZkpOMiUHI2-V7axlqrWLPUpuZo,23
-steer_materials/CellMaterials/Base.py,sha256=Kb1C420CaaB5asT0Quh4d8ThfX8z8lWnzqU_xGmP4Xc,5674
-steer_materials/CellMaterials/Electrode.py,sha256=ABju7kmCaaR7P7XfIYQOy3mn7OOVsrZMfNpcu0FqOSc,44804
-steer_materials/CellMaterials/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-steer_materials/Electrolytes/Electrolytes.py,sha256=CVL6HVij8Hpi4pDtwJT5t3-7e7Mwx6QwRprCLidM7GY,1479
-steer_materials/Electrolytes/Ions.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-steer_materials/Electrolytes/Salts.py,sha256=izZPekYqFkCdNDXOyn2TUR7l5SBxwnnN00sm1G_jaRs,769
-steer_materials/Electrolytes/Solvents.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-steer_materials/Electrolytes/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-steer_materials-0.1.13.dist-info/METADATA,sha256=E155hbu2n5J0_Vvrm1cwUHFqZ5L58FNzuYKUHdJd7uY,752
-steer_materials-0.1.13.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-steer_materials-0.1.13.dist-info/top_level.txt,sha256=KY6YPTcgpQ6A55y83JjGZlE-VcUHU6dQHOj18KNUkTA,29
-steer_materials-0.1.13.dist-info/RECORD,,