API Reference¶

Auto-generated from source docstrings.

Base module¶

Classes¶

Metal ¶

Metal(name: str, density: float, specific_cost: float, color: str)

Bases: _Material

A metallic material (e.g. aluminum, steel, copper).

Inherits all behavior from _Material. Use this class for metals used in cell enclosures, current collectors, and structural components.

Examples:

from steer_materials.Base import Metal

aluminum = Metal(
    name="Aluminum",
    density=2.7,        # g/cm³
    specific_cost=2.50, # $/kg
    color="silver",
)

Source code in steer_materials/Base.py

def __init__(self, name: str, density: float, specific_cost: float, color: str):

    super().__init__(name, density, specific_cost, color)

Solvent ¶

Solvent(name: str, density: float, specific_cost: float, color: str)

Bases: _Material

A solvent material (e.g. water, electrolyte solvents).

Inherits all behavior from _Material. Use this class for liquid solvents used in electrolyte formulations and processing.

Examples:

from steer_materials.Base import Solvent

water = Solvent(
    name="Water",
    density=1.0,        # g/cm³
    specific_cost=0.01, # $/kg
    color="clear",
)

Source code in steer_materials/Base.py

def __init__(self, name: str, density: float, specific_cost: float, color: str):

    super().__init__(name, density, specific_cost, color)