Ionworks API#

The Ionworks API client (ionworks) is a Python library for interacting with the Ionworks platform for battery cell testing, simulation, and modeling.

For any questions or feedback, please contact info@ionworks.com.

Quick Start#

Installation#

Install the package using pip:

pip install ionworks-api

Basic Usage#

from ionworks import Ionworks

# Initialize the client
client = Ionworks()

# Create a cell specification
cell_spec = client.cell_spec.create({
    "name": "NCM622/Graphite Coin Cell",
    "form_factor": "R2032",
    "manufacturer": "Custom Cells",
})

# Create a cell instance
cell_instance = client.cell_instance.create(
    cell_spec.id,
    {"name": "Cell-001", "batch": "BATCH-2024-001"}
)