################ ``ionworks.api`` ################ ``ionworks.api`` is the client for the Ionworks platform: cell testing data, simulation, and modeling. For narrative guides and tutorials, see `docs.ionworks.com `_. .. code-block:: python import ionworks as iw client = iw.api.Client() # Create a cell specification cell_spec = client.cell_spec.create({ "name": "NCM622/Graphite Coin Cell", "form_factor": "R2032", "manufacturer": "Custom Cells", }) # Create a manufacturing lot, then a cell instance in it batch = client.cell_batch.create(cell_spec.id, {"name": "BATCH-2024-001"}) cell_instance = client.cell_instance.create( cell_spec.id, {"name": "Cell-001", "batch_id": batch.id} ) .. toctree:: :maxdepth: 1 :caption: Getting Started user_guide/installation user_guide/authentication .. toctree:: :maxdepth: 1 :caption: User Guide user_guide/cell_specifications user_guide/cell_instances user_guide/cell_measurements user_guide/pipelines user_guide/simulations user_guide/error_handling .. toctree:: :maxdepth: 1 :caption: Examples — Cells examples/cells/create examples/cells/read examples/cells/update examples/cells/delete .. toctree:: :maxdepth: 1 :caption: Examples — Pipelines examples/pipeline/entry examples/pipeline/datafit examples/pipeline/calculation examples/pipeline/validation examples/pipeline/complete .. toctree:: :maxdepth: 1 :caption: Examples — Simulations examples/simulation/protocol examples/simulation/batch examples/simulation/model_id examples/simulation/pybamm examples/simulation/extra_variables .. toctree:: :maxdepth: 1 :caption: API Reference reference/client reference/models reference/errors reference/project reference/custom_model reference/parameterized_model reference/model_builder reference/study reference/protocol reference/optimization reference/cell_specification reference/cell_batch reference/cell_instance reference/cell_measurement reference/pipeline reference/simulation reference/job reference/validators reference/urls