# Ionworks Studio

## Docs

- [Coding agents](https://docs.ionworks.com/agents.md): Install the Ionworks agentic toolkit in Claude Code, Codex, Cursor, Gemini CLI, GitHub Copilot, or any skill-compatible agent to drive Ionworks Studio.
- [Python API client](https://docs.ionworks.com/api-client.md): Install and configure the ionworks-api Python package: authentication, dataframe backend, retries, and sub-clients reference
- [Add a custom variable to an existing model](https://docs.ionworks.com/api-reference/add-a-custom-variable-to-an-existing-model.md): Append a new custom variable to a model's config (append-only).
- [Add a user to a project or update their project role](https://docs.ionworks.com/api-reference/add-a-user-to-a-project-or-update-their-project-role.md): Upsert (insert or update) a user's role for a project.
- [Create a properties-type measurement directly](https://docs.ionworks.com/api-reference/cell-instances/create-a-properties-type-measurement-directly.md): Create a properties-type measurement without the upload flow.
- [Delete a specific cell instance by id](https://docs.ionworks.com/api-reference/cell-instances/delete-a-specific-cell-instance-by-id.md): Deletes an existing cell instance identified by its ID, including: - All measurements (cascades to delete measurement steps) - All associated data files in storage bucket for all measurements - The instance itself
- [Get a specific cell instance by id](https://docs.ionworks.com/api-reference/cell-instances/get-a-specific-cell-instance-by-id.md): Retrieves a specific cell instance by its ID.
- [Initiate a signed URL upload for measurement data](https://docs.ionworks.com/api-reference/cell-instances/initiate-a-signed-url-upload-for-measurement-data.md): Initiate upload for time_series or file measurement data.
- [List cell measurements for a cell instance](https://docs.ionworks.com/api-reference/cell-instances/list-cell-measurements-for-a-cell-instance.md): List cell measurements for an instance with pagination and filtering.
- [Update a specific cell instance by id](https://docs.ionworks.com/api-reference/cell-instances/update-a-specific-cell-instance-by-id.md): Updates an existing cell instance identified by its ID. Only provided fields will be updated.
- [Confirm a signed URL upload and finalize the measurement](https://docs.ionworks.com/api-reference/cell-measurements/confirm-a-signed-url-upload-and-finalize-the-measurement.md): Confirm a signed URL upload and finalize the measurement.
- [Delete a specific cell measurement by id](https://docs.ionworks.com/api-reference/cell-measurements/delete-a-specific-cell-measurement-by-id.md): Deletes a cell measurement identified by its ID, including: - All storage files (steps.parquet, time_series.parquet) - Database record Returns 204 No Content on success or if already deleted.
- [Download a measurement file](https://docs.ionworks.com/api-reference/cell-measurements/download-a-measurement-file.md): Stream a specific file in a measurement back to the caller.
- [Download steps parquet file](https://docs.ionworks.com/api-reference/cell-measurements/download-steps-parquet-file.md): Redirect to storage for the steps parquet file.
- [Download time series parquet file](https://docs.ionworks.com/api-reference/cell-measurements/download-time-series-parquet-file.md): Redirect to storage for the time series parquet file.
- [Get a cell measurement by id](https://docs.ionworks.com/api-reference/cell-measurements/get-a-cell-measurement-by-id.md): Retrieve a cell measurement by its ID only.
- [Get all steps for a cell measurement](https://docs.ionworks.com/api-reference/cell-measurements/get-all-steps-for-a-cell-measurement.md): Retrieve ALL steps for a specific cell measurement.
- [Get cycle metrics only for a cell measurement](https://docs.ionworks.com/api-reference/cell-measurements/get-cycle-metrics-only-for-a-cell-measurement.md): Retrieve cycle metrics only (computed from ALL steps).
- [Get detailed information for a cell measurement](https://docs.ionworks.com/api-reference/cell-measurements/get-detailed-information-for-a-cell-measurement.md): Retrieves detailed information for a specific cell measurement by measurement ID.
- [Get steps and cycle metrics in one call](https://docs.ionworks.com/api-reference/cell-measurements/get-steps-and-cycle-metrics-in-one-call.md): Retrieve ALL steps and cycle metrics together.
- [Get time series data for a measurement](https://docs.ionworks.com/api-reference/cell-measurements/get-time-series-data-for-a-measurement.md): Return time series data from storage.
- [List cell measurements](https://docs.ionworks.com/api-reference/cell-measurements/list-cell-measurements.md): List cell measurements, scoped to a cell specification or a project.
- [List files in a measurement](https://docs.ionworks.com/api-reference/cell-measurements/list-files-in-a-measurement.md): Return the list of filenames stored in a file-type measurement.
- [Update a cell measurement by id](https://docs.ionworks.com/api-reference/cell-measurements/update-a-cell-measurement-by-id.md): Update an existing cell measurement's metadata.
- [Create a new cell instance for a cell specification](https://docs.ionworks.com/api-reference/cell-specifications/create-a-new-cell-instance-for-a-cell-specification.md): Creates a new cell instance under the specified cell specification (by ID). Returns the created cell instance and sets the Location header.
- [Create a new cell specification with nested component/material data](https://docs.ionworks.com/api-reference/cell-specifications/create-a-new-cell-specification-with-nested-componentmaterial-data.md): Create a new cell specification with nested component and material data.
- [Delete a cell specification by id for the current organization](https://docs.ionworks.com/api-reference/cell-specifications/delete-a-cell-specification-by-id-for-the-current-organization.md): Delete a cell specification and all its instances, measurements, and storage files.
- [Get a cell specification with nested component and material data](https://docs.ionworks.com/api-reference/cell-specifications/get-a-cell-specification-with-nested-component-and-material-data.md): Retrieve a cell specification with nested component and material information.
- [List cell instances for a cell specification](https://docs.ionworks.com/api-reference/cell-specifications/list-cell-instances-for-a-cell-specification.md): List cell instances for a specification with pagination and filtering.
- [List cell specifications for the current organization](https://docs.ionworks.com/api-reference/cell-specifications/list-cell-specifications-for-the-current-organization.md): List cell specifications with pagination and optional filtering.
- [Update a cell specification with nested component/material data](https://docs.ionworks.com/api-reference/cell-specifications/update-a-cell-specification-with-nested-componentmaterial-data.md): Update an existing cell specification with nested component and material data.
- [Create a new model within an organization](https://docs.ionworks.com/api-reference/create-a-new-model-within-an-organization.md): Create a new model in the specified organization.
- [Create a new project within an organization, assigning creator as Project Admin](https://docs.ionworks.com/api-reference/create-a-new-project-within-an-organization-assigning-creator-as-project-admin.md)
- [Delete a model from an organization](https://docs.ionworks.com/api-reference/delete-a-model-from-an-organization.md): Delete a model, validating it belongs to the organization.
- [Delete a project from an organization](https://docs.ionworks.com/api-reference/delete-a-project-from-an-organization.md)
- [Get Capabilities](https://docs.ionworks.com/api-reference/discovery/get-capabilities.md): Discover platform domain context and schema references.
- [Get Data Schema](https://docs.ionworks.com/api-reference/discovery/get-data-schema.md): Return the schema for the cell data hierarchy.
- [Get Model Schema](https://docs.ionworks.com/api-reference/discovery/get-model-schema.md): Return the schema for custom electrochemical models.
- [Get Optimization Schema](https://docs.ionworks.com/api-reference/discovery/get-optimization-schema.md): Return the schema for design optimization runs.
- [Get Parameterized Model Schema](https://docs.ionworks.com/api-reference/discovery/get-parameterized-model-schema.md): Return the schema for parameterized models.
- [Get Pipeline Schema](https://docs.ionworks.com/api-reference/discovery/get-pipeline-schema.md): Return the schema for parameterization pipelines.
- [Get Project Schema](https://docs.ionworks.com/api-reference/discovery/get-project-schema.md): Return the schema for projects.
- [Get Protocol Schema](https://docs.ionworks.com/api-reference/discovery/get-protocol-schema.md): Return the Universal Cycler Protocol (UCP) authoring guide.
- [Get Pybamm Models](https://docs.ionworks.com/api-reference/discovery/get-pybamm-models.md): List pybamm/ionworks model classes and options.
- [Get Simple Pipeline Schema](https://docs.ionworks.com/api-reference/discovery/get-simple-pipeline-schema.md): Return the schema for SimplePipelines.
- [Get Study Schema](https://docs.ionworks.com/api-reference/discovery/get-study-schema.md): Return the schema for studies.
- [Validate Pybamm Model Config](https://docs.ionworks.com/api-reference/discovery/validate-pybamm-model-config.md): Try to instantiate a pybamm/ionworks model with the given options.
- [Get a specific model by ID within an organization](https://docs.ionworks.com/api-reference/get-a-specific-model-by-id-within-an-organization.md): Get a specific model by ID with config.
- [Get a specific project by ID within an organization](https://docs.ionworks.com/api-reference/get-a-specific-project-by-id-within-an-organization.md)
- [Health Check](https://docs.ionworks.com/api-reference/health-check/health-check.md): Health check endpoint.
- [Cancel Job](https://docs.ionworks.com/api-reference/jobs/cancel-job.md): Cancel a job if it hasn't been completed yet.
- [Get Job](https://docs.ionworks.com/api-reference/jobs/get-job.md): Get details about a specific job.
- [Get Job Metadata](https://docs.ionworks.com/api-reference/jobs/get-job-metadata.md): Get the full metadata blob for a job.
- [List Jobs](https://docs.ionworks.com/api-reference/jobs/list-jobs.md): List jobs with optional filtering.
- [Submit Job](https://docs.ionworks.com/api-reference/jobs/submit-job.md): Submit a new job for processing.
- [List models for an organization](https://docs.ionworks.com/api-reference/list-models-for-an-organization.md): List models for an organization with pagination.
- [List projects for an organization](https://docs.ionworks.com/api-reference/list-projects-for-an-organization.md)
- [Get Optimization With Job](https://docs.ionworks.com/api-reference/optimization/get-optimization-with-job.md): Get an optimization and its linked job by optimization id or job_id.
- [Get Optimization With Jobs](https://docs.ionworks.com/api-reference/optimization/get-optimization-with-jobs.md): List optimization jobs and optimization records for the project.
- [Cancel Optimization](https://docs.ionworks.com/api-reference/optimizations/cancel-optimization.md): Cancel an optimization and return the refreshed resource.
- [Get Optimization Config](https://docs.ionworks.com/api-reference/optimizations/get-optimization-config.md): Return the resolved config blob for an optimization.
- [Get Optimization Metadata](https://docs.ionworks.com/api-reference/optimizations/get-optimization-metadata.md): Return the metadata blob for an optimization (server-side, sanitised).
- [Get Optimization Resource](https://docs.ionworks.com/api-reference/optimizations/get-optimization-resource.md): Get a single optimization as a job-free resource.
- [Get Optimization Resource Statuses](https://docs.ionworks.com/api-reference/optimizations/get-optimization-resource-statuses.md): Return lightweight statuses for the given optimization ids.
- [List Optimization Resources](https://docs.ionworks.com/api-reference/optimizations/list-optimization-resources.md): List optimizations as job-free resources for the project.
- [List Optimization Runs](https://docs.ionworks.com/api-reference/optimizations/list-optimization-runs.md): List the multistart runs of an optimization in one call.
- [Resubmit Optimization](https://docs.ionworks.com/api-reference/optimizations/resubmit-optimization.md): Resubmit an optimization's failed job; return the refreshed resource.
- [Submit Optimization](https://docs.ionworks.com/api-reference/optimizations/submit-optimization.md): Submit a battery design optimization job using JSON input.
- [Update Optimization](https://docs.ionworks.com/api-reference/optimizations/update-optimization.md): Update an optimization's name and/or description.
- [Create a new parameterized model for the current cell specification](https://docs.ionworks.com/api-reference/parameterized_models/create-a-new-parameterized-model-for-the-current-cell-specification.md)
- [Create a new parameterized model for the current cell specification](https://docs.ionworks.com/api-reference/parameterized_models/create-a-new-parameterized-model-for-the-current-cell-specification-1.md)
- [Delete a parameterized model](https://docs.ionworks.com/api-reference/parameterized_models/delete-a-parameterized-model.md): Delete a parameterized model by its ID for a given cell specification.
- [Delete a parameterized model](https://docs.ionworks.com/api-reference/parameterized_models/delete-a-parameterized-model-1.md): Delete a parameterized model by its ID for a given cell specification.
- [Get a parameterized model by id](https://docs.ionworks.com/api-reference/parameterized_models/get-a-parameterized-model-by-id.md): Get a single parameterized model (with its model info) by id.
- [Get a parameterized model by id](https://docs.ionworks.com/api-reference/parameterized_models/get-a-parameterized-model-by-id-1.md): Get a single parameterized model (with its model info) by id.
- [Get Parameterized Model Parameter Values](https://docs.ionworks.com/api-reference/parameterized_models/get-parameterized-model-parameter-values.md): Get all parameter values from a parameterized model as JSON.
- [Get Parameterized Model Parameter Values](https://docs.ionworks.com/api-reference/parameterized_models/get-parameterized-model-parameter-values-1.md): Get all parameter values from a parameterized model as JSON.
- [Get Parameterized Model Variable Names](https://docs.ionworks.com/api-reference/parameterized_models/get-parameterized-model-variable-names.md): Get variable names where domain is empty or current collector.
- [Get Parameterized Model Variable Names](https://docs.ionworks.com/api-reference/parameterized_models/get-parameterized-model-variable-names-1.md): Get variable names where domain is empty or current collector.
- [List parameterized models for a cell specification or project](https://docs.ionworks.com/api-reference/parameterized_models/list-parameterized-models-for-a-cell-specification-or-project.md): List parameterized models with pagination, scoped by cell spec or project.
- [List parameterized models for a cell specification or project](https://docs.ionworks.com/api-reference/parameterized_models/list-parameterized-models-for-a-cell-specification-or-project-1.md): List parameterized models with pagination, scoped by cell spec or project.
- [Update a parameterized model](https://docs.ionworks.com/api-reference/parameterized_models/update-a-parameterized-model.md): Update a parameterized model's name and/or description.
- [Update a parameterized model](https://docs.ionworks.com/api-reference/parameterized_models/update-a-parameterized-model-1.md): Update a parameterized model's name and/or description.
- [Cancel a pipeline](https://docs.ionworks.com/api-reference/pipeline/cancel-a-pipeline.md): Cancel a running pipeline and all its non-terminal elements.
- [Create a new pipeline](https://docs.ionworks.com/api-reference/pipeline/create-a-new-pipeline.md): Creates a new pipeline definition with its associated steps. This endpoint defines the sequence of jobs but does not start execution immediately. Use the 'start' endpoint to begin the pipeline execution.
- [Get pipeline metadata](https://docs.ionworks.com/api-reference/pipeline/get-pipeline-metadata.md): Retrieves pipeline metadata only (no elements).
- [Get pipeline result](https://docs.ionworks.com/api-reference/pipeline/get-pipeline-result.md): Retrieves the details of a specific pipeline, including its steps and their status.
- [List user's pipelines](https://docs.ionworks.com/api-reference/pipeline/list-users-pipelines.md): Retrieves a list of pipelines for the current user, optionally filtered by project and other criteria.
- [Convert Protocol Endpoint](https://docs.ionworks.com/api-reference/protocols/convert-protocol-endpoint.md): Convert a UCP to a vendor-native protocol file.
- [Find Input References Endpoint](https://docs.ionworks.com/api-reference/protocols/find-input-references-endpoint.md): Find all input references from a protocol.
- [Validate Protocol Endpoint](https://docs.ionworks.com/api-reference/protocols/validate-protocol-endpoint.md): Validate a protocol dictionary.
- [Remove a user from a project](https://docs.ionworks.com/api-reference/remove-a-user-from-a-project.md): Remove a user from a project.
- [Cancel a running SimplePipeline](https://docs.ionworks.com/api-reference/simple_pipeline/cancel-a-running-simplepipeline.md): Cancel a running SimplePipeline.
- [Create and submit a SimplePipeline](https://docs.ionworks.com/api-reference/simple_pipeline/create-and-submit-a-simplepipeline.md): Create a new SimplePipeline and submit it for processing.
- [Delete a SimplePipeline](https://docs.ionworks.com/api-reference/simple_pipeline/delete-a-simplepipeline.md): Delete a SimplePipeline and its associated job.
- [Get SimplePipeline by ID](https://docs.ionworks.com/api-reference/simple_pipeline/get-simplepipeline-by-id.md): Get a SimplePipeline by ID.
- [List SimplePipelines](https://docs.ionworks.com/api-reference/simple_pipeline/list-simplepipelines.md): List SimplePipelines for a project with pagination, filters, and ordering.
- [Update SimplePipeline name/description](https://docs.ionworks.com/api-reference/simple_pipeline/update-simplepipeline-namedescription.md): Partially update a SimplePipeline's name and/or description.
- [Create Simulation Batch With Template](https://docs.ionworks.com/api-reference/simulations/create-simulation-batch-with-template.md): Optimized batch simulation creation with template-based experiments.
- [Get Simulation](https://docs.ionworks.com/api-reference/simulations/get-simulation.md)
- [Get Simulation Cycles](https://docs.ionworks.com/api-reference/simulations/get-simulation-cycles.md): Get cycle-level metrics for a simulation.
- [Get Simulation Result](https://docs.ionworks.com/api-reference/simulations/get-simulation-result.md): Get stored results for a simulation.
- [Get Simulation Summary](https://docs.ionworks.com/api-reference/simulations/get-simulation-summary.md): Fetch a simulation summary without simulation_data. Suitable for list view refresh.
- [List Simulations](https://docs.ionworks.com/api-reference/simulations/list-simulations.md): List simulations filtered by either a parameterized model or a study.
- [Assign a measurement to a study](https://docs.ionworks.com/api-reference/studies/assign-a-measurement-to-a-study.md): Assign a measurement to a study.
- [Assign a simulation to a study](https://docs.ionworks.com/api-reference/studies/assign-a-simulation-to-a-study.md): Assign a simulation to a study.
- [Create a new study](https://docs.ionworks.com/api-reference/studies/create-a-new-study.md): Create a new study associated with a specific project.
- [Delete a study](https://docs.ionworks.com/api-reference/studies/delete-a-study.md): Delete a study by its ID.
- [Get a specific study by ID](https://docs.ionworks.com/api-reference/studies/get-a-specific-study-by-id.md): Retrieve a specific study by its unique ID.
- [List measurements assigned to a study](https://docs.ionworks.com/api-reference/studies/list-measurements-assigned-to-a-study.md): Retrieve measurements assigned to a study with pagination.
- [List studies for a project](https://docs.ionworks.com/api-reference/studies/list-studies-for-a-project.md): Retrieve studies associated with a specific project with pagination.
- [Remove a measurement from a study](https://docs.ionworks.com/api-reference/studies/remove-a-measurement-from-a-study.md): Remove a measurement assignment from a study.
- [Remove a simulation from a study](https://docs.ionworks.com/api-reference/studies/remove-a-simulation-from-a-study.md): Remove a simulation assignment from a study.
- [Update a study](https://docs.ionworks.com/api-reference/studies/update-a-study.md): Update an existing study.
- [Update a model within an organization](https://docs.ionworks.com/api-reference/update-a-model-within-an-organization.md): Update a model, validating it belongs to the organization.
- [Update a project within an organization](https://docs.ionworks.com/api-reference/update-a-project-within-an-organization.md)
- [Update a user's project role](https://docs.ionworks.com/api-reference/update-a-users-project-role.md): Update the project role for an existing member.
- [Get Current User Profile](https://docs.ionworks.com/api-reference/users/get-current-user-profile.md)
- [Python API](https://docs.ionworks.com/build/api.md): Create, list, and manage models and parameterized models programmatically with the ionworks-api Python client
- [ECM parameterization](https://docs.ionworks.com/build/ecm-parameterization.md): Fit OCV, R0, and RC-pair parameters of an equivalent circuit model from experimental cycling data, in-browser
- [Models](https://docs.ionworks.com/build/models.md): Create reusable PyBaMM model configurations (SPM, SPMe, DFN) with options and version pinning for battery simulations
- [Parameterized Models](https://docs.ionworks.com/build/parameterized-models.md): Combine a model with validated parameter values to create a ready-to-run simulation engine for a specific cell
- [Python API](https://docs.ionworks.com/core-concepts/api.md): Create, list, filter, update, and delete projects programmatically with the ionworks-api Python sub-client
- [Cells](https://docs.ionworks.com/core-concepts/cells.md): Define cell specifications with chemistry, capacity, voltage limits, electrode materials, and provenance metadata as the blueprint for your batteries
- [Organizations](https://docs.ionworks.com/core-concepts/organizations.md): Top-level Ionworks workspace containing projects, cells, models, and members with shared organization-level resources and roles
- [Projects](https://docs.ionworks.com/core-concepts/projects-studies.md): Group studies, simulations, parameterized models, and optimizations into focused research initiatives within an organization
- [Search](https://docs.ionworks.com/core-concepts/search.md): Find projects, studies, simulations, models, optimizations, and cells across your organization with a single API call
- [Data format](https://docs.ionworks.com/data/format.md): Recognized time series columns, units, current sign convention, EIS columns, and quantity format for battery cycling data
- [Materials & property datasets](https://docs.ionworks.com/data/materials.md): Manage electrode, electrolyte, and other materials and attach measured property datasets like OCP, diffusivity, and conductivity curves
- [Measurements](https://docs.ionworks.com/data/measurements.md): The three measurement types — time series, properties, and file — with fields, creation examples, and when to use each
- [Data overview](https://docs.ionworks.com/data/overview.md): Organize, upload, and explore experimental battery cycling data in Ionworks Studio
- [Preparing data](https://docs.ionworks.com/data/preparing-data.md): Read cycler files, BDF, and EIS data into the Ionworks format with the ionworksdata library
- [Reading data](https://docs.ionworks.com/data/reading.md): List, filter, paginate, and retrieve cell specs, instances, and measurements with the Python API
- [Uploading data](https://docs.ionworks.com/data/uploading.md): Upload cell specifications, instances, and measurements to Ionworks Studio via the Python API
- [Visualizing data](https://docs.ionworks.com/data/visualizing.md): Plot battery cycling data in Ionworks Studio with stack-cycles, Nyquist EIS, cycle metrics, and AI-powered SQL step filters
- [Battery Capacity](https://docs.ionworks.com/guide/batteries-101/battery-capacity.md): Nominal capacity, C-rate specific capacity, and usable capacity explained, with how each is measured in ampere-hours.
- [Battery Management Systems](https://docs.ionworks.com/guide/batteries-101/battery-management-systems.md): What a BMS does: protection, SoC and SoH estimation, and cell balancing for safe and optimized battery pack operation.
- [Battery Packs](https://docs.ionworks.com/guide/batteries-101/battery-packs.md): How cells are combined in series and parallel into modules and packs to deliver target voltage and capacity for EVs and storage.
- [Degradation Overview](https://docs.ionworks.com/guide/batteries-101/degradation.md): The main battery degradation mechanisms (SEI growth, lithium plating, loss of active material) and modes of capacity and resistance loss.
- [Electrode Essentials](https://docs.ionworks.com/guide/batteries-101/electrode-essentials.md): What battery electrodes are made of, the difference between cathode and anode, and why positive/negative terminology can be confusing.
- [How Do Batteries Work?](https://docs.ionworks.com/guide/batteries-101/how-do-batteries-work.md): How lithium-ion batteries work: cathode, anode, separator, and electrolyte, and how ions move during charge and discharge.
- [Internal Resistance](https://docs.ionworks.com/guide/batteries-101/internal-resistance.md): How internal resistance causes voltage drop, power loss, and heat generation, and how it changes with SoC and aging.
- [Lithium Plating](https://docs.ionworks.com/guide/batteries-101/lithium-plating.md): Why lithium plates as metal instead of intercalating, the conditions that cause it, and its impact on safety and life.
- [Mechanical Degradation](https://docs.ionworks.com/guide/batteries-101/mechanical-degradation.md): How particle expansion, cracking, and silicon swelling cause mechanical degradation and accelerate capacity fade.
- [Open-Circuit Voltage and Potential](https://docs.ionworks.com/guide/batteries-101/open-circuit-voltage.md): What open-circuit voltage (OCV) and open-circuit potential (OCP) mean, how they differ, and how they change with lithiation.
- [Reaction Kinetics](https://docs.ionworks.com/guide/batteries-101/reaction-kinetics.md): How Butler-Volmer, Tafel, and Marcus-Hush-Chidsey equations describe electrochemical reaction rates in batteries.
- [SEI Growth](https://docs.ionworks.com/guide/batteries-101/sei.md): What the solid electrolyte interphase (SEI) is, why it forms during formation cycles, and how its growth drives battery aging.
- [State of Charge](https://docs.ionworks.com/guide/batteries-101/state-of-charge.md): What state of charge (SoC) means and how to estimate it using coulomb counting and voltage-based methods.
- [State of Health](https://docs.ionworks.com/guide/batteries-101/state-of-health.md): What state of health (SoH) measures, how cycling and calendar aging cause degradation, and how SoH is calculated.
- [Thermal Modelling](https://docs.ionworks.com/guide/batteries-101/thermal-modelling.md): Heat sources in batteries (ohmic, reaction, entropic), lumped vs distributed thermal models, and thermal runaway risk.
- [Geometry & Capacity](https://docs.ionworks.com/guide/calculations/geometry-capacity.md): Compute electrode capacity, cyclable lithium, active material loading, and electrode mass from cell geometry and material properties.
- [Piecewise Interpolants](https://docs.ionworks.com/guide/calculations/piecewise.md): Build smooth, differentiable piecewise interpolants for OCP, diffusivity, and SOC- or temperature-dependent battery parameters.
- [Thermal Calculations](https://docs.ionworks.com/guide/calculations/thermal.md): Model Arrhenius temperature dependence, heat capacity, and heat generation for lithium-ion battery thermal simulations.
- [Objective Functions](https://docs.ionworks.com/guide/data-fitting/objective-functions.md): Cost function formulations for parameter fitting, including SSE, MSE, RMSE, and maximum likelihood estimation
- [Introduction to Data Fitting](https://docs.ionworks.com/guide/data-fitting/overview.md): Estimate battery model parameters from voltage and current measurements using least-squares optimization.
- [Regularized Optimization](https://docs.ionworks.com/guide/data-fitting/regularization.md): Stabilize battery parameter fitting with ridge regression, L2 penalties, and MAP estimation to address overfitting and ill-conditioning.
- [Sensitivity Analysis](https://docs.ionworks.com/guide/data-fitting/sensitivity-analysis.md): Quantify how input parameters influence model outputs using variance-based SOBOL indices and the SALib library
- [Voltage and Stoichiometry Limits](https://docs.ionworks.com/guide/data-fitting/voltage-stoichiometry-limits.md): Distinguish cut-off voltages, OCV endpoints, and stoichiometry ranges used as simulation bounds and parameterization references.
- [Introduction](https://docs.ionworks.com/guide/introduction.md): Technical guide to battery electrochemistry, PyBaMM modeling, parameterization, data fitting, and design optimization.
- [Electrolyte transport properties](https://docs.ionworks.com/guide/modeling/electrolyte-transport.md): The four transport properties that close a binary-electrolyte DFN model, their role in the equations, and how they are measured experimentally
- [The Finite Volume Method](https://docs.ionworks.com/guide/modeling/finite-volume-method.md): How PyBaMM uses the finite volume method to discretize battery PDEs into ODEs and DAEs for numerical solution.
- [Initialization & Electrode State of Health](https://docs.ionworks.com/guide/modeling/initialization-esoh.md): Set initial lithium distributions and use the ESOH algorithm to find stoichiometry windows mapping cell SOC to electrode lithiation.
- [Ionworks DAE Solver](https://docs.ionworks.com/guide/modeling/ionworks-solver.md): The fast default solver behind ionworkspipeline.Simulation, with automatic fallback to IDAKLU.
- [Multi-Species Multi-Reaction (MSMR) Model](https://docs.ionworks.com/guide/modeling/msmr-model.md): Theoretical foundations and application of the MSMR model for thermodynamically consistent lithium insertion electrode characterization.
- [Design Optimization](https://docs.ionworks.com/guide/optimize/design-optimization.md): Mathematical formulation of battery design optimization: parameters, metrics, actions, penalty constraints, and multi-objective tradeoffs
- [Electrolyte direct entries](https://docs.ionworks.com/guide/pipelines/direct-entries/electrolyte.md): Direct entries that set the four electrolyte transport properties for a DFN model from literature values or as fit unknowns.
- [Introduction to Pipelines](https://docs.ionworks.com/guide/pipelines/overview.md): Chain DirectEntry, Calculation, DataFit, and Validation elements to transform battery parameters and fit models to experimental data.
- [SimplePipeline](https://docs.ionworks.com/guide/pipelines/simple-pipelines.md): Submit single-element pipelines for fire-and-forget data fitting or validation
- [Terminology & Standards](https://docs.ionworks.com/guide/reference/terminology.md): Battery modeling terms and PyBaMM sign conventions: anode/cathode, lithiation, capacity, current direction, stoichiometry, and SOC
- [Introduction](https://docs.ionworks.com/introduction.md): Overview of Ionworks Studio: a web platform for electrochemical modeling, simulation, and optimization of lithium-ion battery cells
- [Python API](https://docs.ionworks.com/optimize/api.md): Run, monitor, list, update, and cancel optimizations programmatically with the ionworks-api Python client
- [Optimization Overview](https://docs.ionworks.com/optimize/overview.md): Automatically find optimal battery design and charging parameters with multistart Bayesian and evolutionary optimizers
- [Parallelization](https://docs.ionworks.com/optimize/parallelization.md): How Ionworks distributes multistart and population-based optimizations across CPUs using Ray actors and Anyscale autoscaling
- [Running an Optimization](https://docs.ionworks.com/optimize/running-optimization.md): Step-by-step workflow to configure cells, parameters, objectives, constraints, and algorithms, then run and review an optimization
- [Optimization Templates](https://docs.ionworks.com/optimize/templates.md): Pre-configured Design and Charge templates with parameters, objectives, and constraints for cell design and fast-charging optimization
- [Python API](https://docs.ionworks.com/pipelines/api.md): Submit, monitor, list, and retrieve results for pipeline jobs with the ionworks-api Python client.
- [Geometry & Capacity](https://docs.ionworks.com/pipelines/calculations/geometry-capacity.md): Compute electrode capacity, cell mass, cyclable lithium, and stoichiometry windows with ionworks-schema calculations.
- [Piecewise Interpolants](https://docs.ionworks.com/pipelines/calculations/piecewise.md): Build smooth piecewise interpolants for SOC- and temperature-dependent parameters with ionworks-schema.
- [Thermal Properties](https://docs.ionworks.com/pipelines/calculations/thermal.md): Configure Arrhenius temperature dependence and heat-capacity calculations with ionworks-schema.
- [Objective Functions](https://docs.ionworks.com/pipelines/data-fitting/objective-functions.md): Configure objectives and cost functions for data fitting with iws.objectives and iws.costs.
- [Data Fitting Overview](https://docs.ionworks.com/pipelines/data-fitting/overview.md): Estimate battery model parameters by fitting to experimental data with iws.DataFit.
- [Regularization](https://docs.ionworks.com/pipelines/data-fitting/regularization.md): Stabilise parameter fits with Gaussian priors using iws.priors and iws.stats distributions.
- [Sensitivity Analysis](https://docs.ionworks.com/pipelines/data-fitting/sensitivity-analysis.md): Quantify which parameters a data fit actually constrains.
- [Direct Entries](https://docs.ionworks.com/pipelines/direct-entries.md): Drop coherent literature parameter sets into a pipeline with ionworks-schema direct entries.
- [Pipelines Overview](https://docs.ionworks.com/pipelines/overview.md): Build a parameterization pipeline with ionworks-schema and submit it through ionworks-api.
- [Validation](https://docs.ionworks.com/pipelines/validation.md): Check fitted parameters against held-out experimental data with iws.Validation.
- [Quickstart](https://docs.ionworks.com/quickstart.md): Step-by-step guide to creating a project, cell spec, parameterized model, and running your first battery simulation in Ionworks Studio
- [Python API](https://docs.ionworks.com/simulate/api.md): Run UCP simulations and submit parameterization pipelines programmatically with the ionworks-api Python client
- [Experiment Templates](https://docs.ionworks.com/simulate/experiment-templates.md): Reference for the 9 built-in UCP experiment templates with adjustable parameters and computed metrics
- [Protocol Builder](https://docs.ionworks.com/simulate/protocol-builder.md): Visually create UCP cycling protocols with steps, safety limits, and live YAML preview—no hand-written YAML required
- [Protocols](https://docs.ionworks.com/simulate/protocols.md): Create, upload, and reuse cycling protocols in UCP, Arbin, Maccor, Neware, BioLogic, and Novonix formats for battery simulations
- [Simulating Commercial Protocols](https://docs.ionworks.com/simulate/simulating-commercial-protocols.md): Upload protocol files from Maccor, Neware, Arbin, BioLogic, and Novonix cyclers and run physics-based simulations
- [Simulations](https://docs.ionworks.com/simulate/simulations.md): Run single simulations or sweeps with parameterized models, configure protocols and design parameters, and visualize results
- [Studies](https://docs.ionworks.com/simulate/studies.md): Group related simulations into focused investigations to compare results and validate models against experimental data
- [Universal Cycler Protocol](https://docs.ionworks.com/simulate/universal-cycler-protocol.md): Full reference for UCP, Ionworks' YAML-based language for defining battery cycling experiments and protocol steps

## OpenAPI Specs

- [openapi](https://api.ionworks.com/openapi.json)

## Optional

- [Blog](https://ionworks.com/blog)
- [ionworks-schema](https://schema.docs.ionworks.com/)
- [Python API](https://api.docs.ionworks.com/)
- [ionworksdata](https://data.docs.ionworks.com/)
- [ionworkspipeline](https://pipeline.docs.ionworks.com/)
- [PyBaMM](https://docs.pybamm.org/en/latest/index.html)