steer-core 0.1.15__py3-none-any.whl → 0.1.17__py3-none-any.whl

steer_core/Constants/Units.py

@@ -25,8 +25,10 @@ A_TO_mA = 1e3
 mA_TO_A = 1e-3
 
 # Time units
-S_TO_H = 1/3600
+S_TO_H = 1 / 3600
 H_TO_S = 3600
+S_TO_Y = 1 / (3600 * 24 * 365)
+Y_TO_S = 3600 * 24 * 365
 
 # Energy units
 W_TO_KW = 1e-3
@@ -34,3 +36,6 @@ W_TO_KW = 1e-3
 # Angle units
 DEG_TO_RAD = 0.017453292519943295
 
+# Percentage units
+PERCENT_TO_FRACTION = 1e-2
+FRACTION_TO_PERCENT = 1e2

steer_core/DataManager.py

@@ -7,9 +7,7 @@ from steer_core.Constants.Units import *
 
 
 class DataManager:
-    
     def __init__(self):
-
         with importlib.resources.path("steer_core.Data", "database.db") as db_path:
             self._db_path = db_path
             self._connection = sql.connect(self._db_path)
@@ -22,8 +20,8 @@ class DataManager:
         :param table_name: Name of the table.
         :param columns: Dictionary of columns and their types.
         """
-        columns_str = ', '.join([f'{k} {v}' for k, v in columns.items()])
-        self._cursor.execute(f'CREATE TABLE IF NOT EXISTS {table_name} ({columns_str})')
+        columns_str = ", ".join([f"{k} {v}" for k, v in columns.items()])
+        self._cursor.execute(f"CREATE TABLE IF NOT EXISTS {table_name} ({columns_str})")
         self._connection.commit()
 
     def drop_table(self, table_name: str):
@@ -32,7 +30,7 @@ class DataManager:
 
         :param table_name: Name of the table.
         """
-        self._cursor.execute(f'DROP TABLE IF EXISTS {table_name}')
+        self._cursor.execute(f"DROP TABLE IF EXISTS {table_name}")
         self._connection.commit()
 
     def get_table_names(self):
@@ -52,9 +50,9 @@ class DataManager:
         :param data: DataFrame containing the data to insert.
         """
         for _, row in data.iterrows():
-            conditions = ' AND '.join([f"{col} = ?" for col in data.columns])
+            conditions = " AND ".join([f"{col} = ?" for col in data.columns])
             check_query = f"SELECT COUNT(*) FROM {table_name} WHERE {conditions}"
-            
+
             self._cursor.execute(check_query, tuple(row))
             if self._cursor.fetchone()[0] == 0:  # If the row does not exist, insert it
                 insert_query = f"INSERT INTO {table_name} ({', '.join(data.columns)}) VALUES ({', '.join(['?'] * len(row))})"
@@ -62,11 +60,13 @@ class DataManager:
 
         self._connection.commit()
 
-    def get_data(self, 
-                 table_name: str, 
-                 columns: list = None, 
-                 condition: str | list[str] = None, 
-                 latest_column: str = None):
+    def get_data(
+        self,
+        table_name: str,
+        columns: list = None,
+        condition: str | list[str] = None,
+        latest_column: str = None,
+    ):
         """
         Retrieve data from the database.
 
@@ -81,15 +81,17 @@ class DataManager:
             columns_info = self._cursor.fetchall()
             columns = [col[1] for col in columns_info]  # Extract column names
             if not columns:
-                raise ValueError(f"Table '{table_name}' does not exist or has no columns.")
+                raise ValueError(
+                    f"Table '{table_name}' does not exist or has no columns."
+                )
 
-        columns_str = ', '.join(columns)
+        columns_str = ", ".join(columns)
         query = f"SELECT {columns_str} FROM {table_name}"
 
         # Add condition if specified
         if condition:
             if isinstance(condition, list):
-                condition_str = ' AND '.join(condition)
+                condition_str = " AND ".join(condition)
             else:
                 condition_str = condition
             query += f" WHERE {condition_str}"
@@ -101,13 +103,13 @@ class DataManager:
         # Execute and return the result
         self._cursor.execute(query)
         data = self._cursor.fetchall()
-        
+
         return pd.DataFrame(data, columns=columns)
-    
+
     def get_unique_values(self, table_name: str, column_name: str):
         """
         Retrieves all unique values from a specified column.
-        
+
         :param table_name: The name of the table.
         :param column_name: The column to retrieve unique values from.
         :return: A list of unique values.
@@ -115,7 +117,7 @@ class DataManager:
         query = f"SELECT DISTINCT {column_name} FROM {table_name}"
         self._cursor.execute(query)
         return [row[0] for row in self._cursor.fetchall()]
-    
+
     def get_current_collector_materials(self, most_recent: bool = True) -> pd.DataFrame:
         """
         Retrieves current collector materials from the database.
@@ -123,15 +125,19 @@ class DataManager:
         :param most_recent: If True, returns only the most recent entry.
         :return: DataFrame with current collector materials.
         """
-        data = (self
-                .get_data(table_name='current_collector_materials')
-                .groupby('name', group_keys=False)
-                .apply(lambda x: x.sort_values('date', ascending=False).head(1) if most_recent else x)
-                .reset_index(drop=True)
-                ) 
-        
+        data = (
+            self.get_data(table_name="current_collector_materials")
+            .groupby("name", group_keys=False)
+            .apply(
+                lambda x: x.sort_values("date", ascending=False).head(1)
+                if most_recent
+                else x
+            )
+            .reset_index(drop=True)
+        )
+
         return data
-    
+
     def get_insulation_materials(self, most_recent: bool = True) -> pd.DataFrame:
         """
         Retrieves insulation materials from the database.
@@ -140,18 +146,16 @@ class DataManager:
         :return: DataFrame with insulation materials.
         """
         data = (
-            self
-            .get_data(
-                table_name='insulation_materials'
-            ).groupby(
-                'name', group_keys=False
-            ).apply(
-                lambda x: x.sort_values('date', ascending=False).head(1) if most_recent else x
-            ).reset_index(
-                drop=True
+            self.get_data(table_name="insulation_materials")
+            .groupby("name", group_keys=False)
+            .apply(
+                lambda x: x.sort_values("date", ascending=False).head(1)
+                if most_recent
+                else x
             )
-        ) 
-        
+            .reset_index(drop=True)
+        )
+
         return data
 
     def get_cathode_materials(self, most_recent: bool = True) -> pd.DataFrame:
@@ -162,21 +166,18 @@ class DataManager:
         :return: DataFrame with cathode materials.
         """
         data = (
-            self
-            .get_data(
-                table_name='cathode_materials'
-            ).groupby(
-                'name', 
-                group_keys=False
-            ).apply(
-                lambda x: x.sort_values('date', ascending=False).head(1) if most_recent else x
-            ).reset_index(
-                drop=True
+            self.get_data(table_name="cathode_materials")
+            .groupby("name", group_keys=False)
+            .apply(
+                lambda x: x.sort_values("date", ascending=False).head(1)
+                if most_recent
+                else x
             )
-        ) 
-        
+            .reset_index(drop=True)
+        )
+
         return data
-    
+
     def get_anode_materials(self, most_recent: bool = True) -> pd.DataFrame:
         """
         Retrieves anode materials from the database.
@@ -185,21 +186,18 @@ class DataManager:
         :return: DataFrame with anode materials.
         """
         data = (
-            self
-            .get_data(
-                table_name='anode_materials'
-            ).groupby(
-                'name', 
-                group_keys=False
-            ).apply(
-                lambda x: x.sort_values('date', ascending=False).head(1) if most_recent else x
-            ).reset_index(
-                drop=True
+            self.get_data(table_name="anode_materials")
+            .groupby("name", group_keys=False)
+            .apply(
+                lambda x: x.sort_values("date", ascending=False).head(1)
+                if most_recent
+                else x
             )
-        ) 
-        
+            .reset_index(drop=True)
+        )
+
         return data
-    
+
     def get_binder_materials(self, most_recent: bool = True) -> pd.DataFrame:
         """
         Retrieves binder materials from the database.
@@ -208,22 +206,21 @@ class DataManager:
         :return: DataFrame with binder materials.
         """
         data = (
-            self
-            .get_data(
-                table_name='binder_materials'
-            ).groupby(
-                'name', 
-                group_keys=False
-            ).apply(
-                lambda x: x.sort_values('date', ascending=False).head(1) if most_recent else x
-            ).reset_index(
-                drop=True
+            self.get_data(table_name="binder_materials")
+            .groupby("name", group_keys=False)
+            .apply(
+                lambda x: x.sort_values("date", ascending=False).head(1)
+                if most_recent
+                else x
             )
-        ) 
-        
+            .reset_index(drop=True)
+        )
+
         return data
-    
-    def get_conductive_additive_materials(self, most_recent: bool = True) -> pd.DataFrame:
+
+    def get_conductive_additive_materials(
+        self, most_recent: bool = True
+    ) -> pd.DataFrame:
         """
         Retrieves conductive additives from the database.
 
@@ -231,19 +228,16 @@ class DataManager:
         :return: DataFrame with conductive additives.
         """
         data = (
-            self
-            .get_data(
-                table_name='conductive_additive_materials'
-            ).groupby(
-                'name', 
-                group_keys=False
-            ).apply(
-                lambda x: x.sort_values('date', ascending=False).head(1) if most_recent else x
-            ).reset_index(
-                drop=True
+            self.get_data(table_name="conductive_additive_materials")
+            .groupby("name", group_keys=False)
+            .apply(
+                lambda x: x.sort_values("date", ascending=False).head(1)
+                if most_recent
+                else x
             )
-        ) 
-        
+            .reset_index(drop=True)
+        )
+
         return data
 
     def get_separator_materials(self, most_recent: bool = True) -> pd.DataFrame:
@@ -254,19 +248,16 @@ class DataManager:
         :return: DataFrame with separator materials.
         """
         data = (
-            self
-            .get_data(
-                table_name='separator_materials'
-            ).groupby(
-                'name', 
-                group_keys=False
-            ).apply(
-                lambda x: x.sort_values('date', ascending=False).head(1) if most_recent else x
-            ).reset_index(
-                drop=True
+            self.get_data(table_name="separator_materials")
+            .groupby("name", group_keys=False)
+            .apply(
+                lambda x: x.sort_values("date", ascending=False).head(1)
+                if most_recent
+                else x
             )
-        ) 
-        
+            .reset_index(drop=True)
+        )
+
         return data
 
     @staticmethod
@@ -281,27 +272,39 @@ class DataManager:
             data = pd.read_csv(half_cell_path)
         except:
             raise FileNotFoundError(f"Could not find the file at {half_cell_path}")
-        
-        if 'Specific Capacity (mAh/g)' not in data.columns:
-            raise ValueError("The file must have a column named 'Specific Capacity (mAh/g)'")
-        
-        if 'Voltage (V)' not in data.columns:
+
+        if "Specific Capacity (mAh/g)" not in data.columns:
+            raise ValueError(
+                "The file must have a column named 'Specific Capacity (mAh/g)'"
+            )
+
+        if "Voltage (V)" not in data.columns:
             raise ValueError("The file must have a column named 'Voltage (V)'")
-        
-        if 'Step_ID' not in data.columns:
+
+        if "Step_ID" not in data.columns:
             raise ValueError("The file must have a column named 'Step_ID'")
-        
-        data = (data
-                .rename(columns={'Specific Capacity (mAh/g)': 'specific_capacity', 'Voltage (V)': 'voltage', 'Step_ID': 'step_id'})
-                .assign(specific_capacity=lambda x: x['specific_capacity'] * (H_TO_S * mA_TO_A / G_TO_KG))
-                .filter(['specific_capacity', 'voltage', 'step_id'])
-                .groupby(['specific_capacity', 'step_id'], group_keys=False)['voltage'].max()
-                .reset_index()
-                .sort_values(['step_id', 'specific_capacity'])
-                )
+
+        data = (
+            data.rename(
+                columns={
+                    "Specific Capacity (mAh/g)": "specific_capacity",
+                    "Voltage (V)": "voltage",
+                    "Step_ID": "step_id",
+                }
+            )
+            .assign(
+                specific_capacity=lambda x: x["specific_capacity"]
+                * (H_TO_S * mA_TO_A / G_TO_KG)
+            )
+            .filter(["specific_capacity", "voltage", "step_id"])
+            .groupby(["specific_capacity", "step_id"], group_keys=False)["voltage"]
+            .max()
+            .reset_index()
+            .sort_values(["step_id", "specific_capacity"])
+        )
 
         return data
-    
+
     def remove_data(self, table_name: str, condition: str):
         """
         Function to remove data from the database.
@@ -311,8 +314,6 @@ class DataManager:
         """
         self._cursor.execute(f"DELETE FROM {table_name} WHERE {condition}")
         self._connection.commit()
-        
+
     def __del__(self):
         self._connection.close()
-
-

steer_core/Decorators/Coordinates.py

@@ -6,12 +6,14 @@ def calculate_coordinates(func):
     Decorator to recalculate spatial properties after a method call.
     This is useful for methods that modify the geometry of a component.
     """
+
     @wraps(func)
     def wrapper(self, *args, **kwargs):
         result = func(self, *args, **kwargs)
-        if hasattr(self, '_update_properties') and self._update_properties:
+        if hasattr(self, "_update_properties") and self._update_properties:
             self._calculate_coordinates()
         return result
+
     return wrapper
 
 
@@ -20,13 +22,15 @@ def calculate_areas(func):
     Decorator to recalculate areas after a method call.
     This is useful for methods that modify the geometry of a component.
     """
+
     @wraps(func)
     def wrapper(self, *args, **kwargs):
         result = func(self, *args, **kwargs)
-        if hasattr(self, '_update_properties') and self._update_properties:
+        if hasattr(self, "_update_properties") and self._update_properties:
             self._calculate_coordinates()
             self._calculate_areas()
         return result
+
     return wrapper
 
 
@@ -35,12 +39,13 @@ def calculate_volumes(func):
     Decorator to recalculate volumes after a method call.
     This is useful for methods that modify the geometry of a component.
     """
+
     @wraps(func)
     def wrapper(self, *args, **kwargs):
         result = func(self, *args, **kwargs)
-        if hasattr(self, '_update_properties') and self._update_properties:
+        if hasattr(self, "_update_properties") and self._update_properties:
             self._calculate_bulk_properties()
             self._calculate_coordinates()
         return result
-    return wrapper
 
+    return wrapper

steer_core/Decorators/Electrochemical.py

@@ -1,16 +1,19 @@
 from functools import wraps
 
+
 def calculate_half_cell_curve(func):
     """
     Decorator to recalculate half-cell curve properties after a method call.
     This is useful for methods that modify the half-cell curve data.
     """
+
     @wraps(func)
     def wrapper(self, *args, **kwargs):
         result = func(self, *args, **kwargs)
-        if hasattr(self, '_update_properties') and self._update_properties:
+        if hasattr(self, "_update_properties") and self._update_properties:
             self._calculate_half_cell_curve()
         return result
+
     return wrapper
 
 
@@ -19,10 +22,12 @@ def calculate_half_cell_curves_properties(func):
     Decorator to recalculate half-cell curves properties after a method call.
     This is useful for methods that modify the half-cell curves data.
     """
+
     @wraps(func)
     def wrapper(self, *args, **kwargs):
         result = func(self, *args, **kwargs)
-        if hasattr(self, '_update_properties') and self._update_properties:
+        if hasattr(self, "_update_properties") and self._update_properties:
             self._calculate_half_cell_curves_properties()
         return result
+
     return wrapper

steer_core/Decorators/General.py

@@ -1,16 +1,19 @@
 from functools import wraps
 
+
 def calculate_bulk_properties(func):
     """
     Decorator to recalculate bulk properties after a method call.
     This is useful for methods that modify the material properties.
     """
+
     @wraps(func)
     def wrapper(self, *args, **kwargs):
         result = func(self, *args, **kwargs)
-        if hasattr(self, '_update_properties') and self._update_properties:
+        if hasattr(self, "_update_properties") and self._update_properties:
             self._calculate_bulk_properties()
         return result
+
     return wrapper
 
 
@@ -19,12 +22,12 @@ def calculate_all_properties(func):
     Decorator to recalculate both spatial and bulk properties after a method call.
     This is useful for methods that modify both geometry and material properties.
     """
+
     @wraps(func)
     def wrapper(self, *args, **kwargs):
         result = func(self, *args, **kwargs)
-        if hasattr(self, '_update_properties') and self._update_properties:
+        if hasattr(self, "_update_properties") and self._update_properties:
             self._calculate_all_properties()
         return result
-    return wrapper
-
 
+    return wrapper

steer_core/Decorators/Objects.py

@@ -1,14 +1,17 @@
 from functools import wraps
 
+
 def calculate_weld_tab_properties(func):
     """
     Decorator to recalculate weld tab properties after a method call.
     This is useful for methods that modify the weld tab geometry or material.
     """
+
     @wraps(func)
     def wrapper(self, *args, **kwargs):
         result = func(self, *args, **kwargs)
-        if hasattr(self, '_update_properties') and self._update_properties:
+        if hasattr(self, "_update_properties") and self._update_properties:
             self._calculate_weld_tab_properties()
         return result
+
     return wrapper