Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ionworks.com/llms.txt

Use this file to discover all available pages before exploring further.

​
December 8, 2025
Data management for cells, silicon design optimization, and UCP solution save/load

​
Comprehensive data management

Studio now provides a full data management experience for cell specifications, cell instances, and measurements. You can define cell specs, track individual cell instances, and associate measurements — all from a redesigned UI with streamlined navigation.Find out more →

​
Silicon design optimization

The pipeline now supports silicon-based electrode design optimization, including cell mass calculations. This enables end-to-end design studies for cells with silicon anodes.

​
UCP solution save and load

Protocol simulation results can now be saved to disk and reloaded later with lazy variable evaluation. This makes it practical to work with large simulation outputs without keeping everything in memory.Find out more →
Fixes
  • Fixed a bug where data was not reverse-parsed in calculations.
  • Improved MSMR objective error handling with proper NumericalError support.
  • Silenced sundials solver warnings for cleaner output.
​
December 1, 2025
EIS simulations, child job status, and saved validation plot config

​
EIS simulations

EIS (Electrochemical Impedance Spectroscopy) simulations now work out of the box — default double-layer capacity parameters are automatically included so you no longer need to manually specify them.Find out more →

​
Child job status visibility

Pipeline and optimization pages now display the status of individual child jobs, making it easy to monitor progress and identify which steps have completed or failed.

​
Saved validation plot configuration

Validation plot settings are now persisted, so you no longer need to reconfigure plots each time you revisit a validation result. This also avoids unnecessary recomputation.
Fixes
  • Fixed JWT secret configuration and error handling; improved metric display.
  • Fixed datafit parameter bounds format (now uses [lower, upper]).
  • Fixed model selection in optimization, charge time display, and cycler protocol metrics.
Improvements
  • OCP data loading now gracefully ignores steps instead of erroring.
  • Reverse parsing support added for costs.
  • Added current to the lumped SPMR model.
Fixes
  • Fixed a bug with custom parameters in pipeline evaluation.
Fixes
  • Fixed step label casing to match ionworksdata conventions.
​
November 24, 2025
Models management, data fit performance, and parallel DifferentialEvolution

​
Models management

Studio now has dedicated pages for managing models — browse a list of available models, view model details, and create new models. Parameterized model details are also viewable from the model pages.Find out more →

​
Data fit performance improvements

The data fit UI is now significantly more responsive. React memoization and element collapsing prevent unnecessary re-renders, and RPC payload sizes have been reduced for batch job updates.
Fixes
  • Fixed batch payload format for nested dictionaries.
  • Fixed pipeline data fit element fetching.
Improvements
  • Penalties and constraints refactored to use PyBaMM expressions for greater flexibility.
  • SciPy DifferentialEvolution optimizer now supports parallelization.
Fixes
  • Fixed MSMR validation plot range clipping and a type-conversion bug with large integers.
  • Fixed bugs with lumped model and ECM compatibility.
  • Fixed parameter reverse-parsing.
​
November 17, 2025
Live pipeline loading, simpler simulation API, and current variable support

​
Live pipeline loading

Pipeline pages now load progressively — only the next pending element is fetched at a time, with live updates as elements complete. This makes working with long pipelines much more responsive.

​
Simpler simulation API

The simulation API has been simplified from a two-step process to a single step. UCP input parameters are also now supported directly in simulation protocols, making it easier to configure and run simulations.Find out more →

​
Current variable support in pipeline

Pipeline objectives now support current as a variable, expanding the set of quantities that can be used in fitting and optimization workflows.
Improvements
  • Data loading on optimization pages improved with proper cleanup on navigation.
  • Job compute time is now logged for performance monitoring.
  • Renamed “model” to “parameterized model” and “equations” to “model” for clarity.
Fixes
  • Fixed optimization v1 data conversion error that caused the optimization list to appear empty.
  • Fixed design optimization bugs.
  • Fixed pipeline multistart plots consistency.
Improvements
  • Reverse parser now handles design objectives and metrics.
  • DesignObjective updated to use a metric dictionary format.
  • Sensitivity analysis improvements: fixed second-order calculation and added log-transform support.
  • Initial guess distributions (Log, Uniform) added for simpler configuration.
  • Output variables now available with SimulationObjective.
  • Multiple statistics supported in validation reports.
  • V_init can now be loaded from the dataloader when evaluating custom parameters.
  • Parameter dependencies made optional for simpler objective definitions.
Fixes
  • Fixed a validation issue with objective inputs.
  • Fixed symbol evaluation in MSMR models.
  • Fixed time_series and steps key validation.
​
November 10, 2025
Simpler data API, large JSON offloaded to storage, and Sobol sensitivity analysis

​
Simpler data API

The data handling API has been simplified with improved validation, making it easier to upload and work with experimental data. Custom fields are now supported via an additional data column, so you can attach arbitrary metadata to your measurements.Find out more →

​
Large payloads moved to storage

Large JSON payloads (such as simulation solutions and pipeline results) have been migrated from the database to object storage. This significantly improves page load times and reduces memory pressure when working with large datasets.

​
Sobol sensitivity analysis

The pipeline now supports Sobol-based sensitivity analysis, enabling global sensitivity studies that quantify how each parameter contributes to output variance — including second-order interaction effects.
Improvements
  • Pipeline data format updated to use dictionaries instead of lists for elements, improving consistency with the pipeline API.
  • Metadata handling improvements across the data layer.
  • Pipeline elements now store cumulative parameters, reducing memory usage by eliminating duplicated parameter values.
  • Optimization v2 refactored to use the DataFit engine for a more consistent workflow.
  • Old datafit and validation jobs migrated to the new request format.
Fixes
  • Fixed a bug where initial conditions that violate events caused errors.
  • Fixed user permissions at the organization level.
  • Fixed a frontend race condition when navigating between projects.
Improvements
  • Reverse parser now supports additional capabilities with updated key names.
  • ECM and lumped models are now compatible with the pipeline.
  • Interpolant numerical stability improved using smooth-step functions.
  • Optimiser architecture refactored with Pints optimisers supporting Ray and multiprocessing.
  • Pipeline configuration now uses a dictionary format instead of a list.
Fixes
  • Fixed entry/create serialization issues.
  • Fixed experiment reverse parser.
  • Fixed a bug with non-parametric inputs to the MSMR objective.
  • Improved interpolant error messages and numerical stability.
​
November 3, 2025
Create model from pipeline, reusable data grid, and ECM with arbitrary RC pairs

​
Create model from pipeline

You can now create a model directly from a pipeline, opening the model creator pre-filled with the pipeline’s parameters in read-only mode. This streamlines the workflow from fitting to simulation.Find out more →

​
Reusable data grid across Studio

All tables in Studio now use a shared StandardDataGrid component with built-in search, filtering, and configurable columns — delivering a more consistent and powerful browsing experience.

​
ECM with arbitrary RC pairs

The pipeline now supports equivalent circuit models with an arbitrary number of RC pairs, integrated with the lumped single electrode SPMR. This enables more flexible impedance-based modeling.
Improvements
  • Pipeline UI improvements — “New” tag for outputs, calculation metadata display, and smoother API requests.
  • Added pipeline attributes: name, description, and project association.
  • Copy parameters and view config details in pipelines.
  • Added pipeline created-by info showing creator email.
  • Organization creation and invitation for admin users.
  • Added documentation button with updated docs links.
Fixes
  • Fixed Maccor protocol C-rate capacity termination.
  • Fixed query for existing users by email.
  • Fixed minor admin page bugs.
  • Fixed pipeline parameter output display — filter constants and fix nested function parameters.
Improvements
  • Added support for parsing custom models.
  • Updated for PyBaMM 25.10 — composite electrodes and EIS handling.
  • Improved clean_parameters for nested function parameters.
Fixes
  • Fixed bug with pybamm.Scalar in get_initial_soc_from_voltage.
  • Fixed to_source for nested function parameters.
  • Fixed calculation input/output parameter names.
​
October 27, 2025
Multi-dimensional interpolant editor, 2D data upload, and piecewise interpolation

​
Multi-dimensional interpolant editor

The parameter interpolant editor now supports multi-dimensional x values, making it possible to view and edit parameters that depend on more than one variable — such as temperature and SOC — directly in Studio.Find out more →

​
2D interpolant data upload

Users can now upload 2D interpolant data, with the backend automatically interpolating to a regular grid. This simplifies working with experimentally measured parameter surfaces.Find out more →

​
Piecewise interpolation

The pipeline adds piecewise interpolation with both 1D and 2D support, giving more flexibility when fitting parameters with distinct regions of behavior.Find out more →
Improvements
  • Added MSMR validation plots for pipelines from the API.
  • Improved data fit UI with loading state and timeout handling.
Fixes
  • Fixed error handling for model creation with duplicated names.
Improvements
  • Added design objective custom parameters for evaluating by SOC or concentration.
  • Added initial_concentration_from_soc for SOC-based initialization.
  • Added initialization for lumped SPM with SOC calculation from voltage.
  • Allow additional arguments in data fit for cost logger and initial guess override.
  • MSMR diffusion dUdx tolerance — clip diffusivity in low dUdx regions.
  • Refactored Pints optimizers with lighter wrappers and parallel functionality.
  • Removed Identity as the default transform in the parameter parser.
​
October 20, 2025
Activity log, interactive protocol graphs, and MSMR validation

​
Activity log

Studio now tracks optimization and data fit usage in a new activity log, giving teams visibility into how resources are being used across the organization.

​
Interactive protocol visualization

Protocols can now be visualized as interactive graphs using Plotly and NetworkX, making it easier to understand complex multi-step protocols at a glance.

​
MSMR validation framework

The pipeline introduces an MSMR OCP validation framework with JSON export, enabling validation plots to be rendered directly in Studio.
Improvements
  • Updated data fit UI with parameter progress plots in an accordion and a smoother loading experience.
  • Added UCP time series upsampling with linear interpolation.
  • Adaptive time steps for UCP simulations to prevent timeout issues.
  • Improved error messages in pipelines with more detailed error handling.
  • Improved checkpoint serialization for numpy results.
Fixes
  • Fixed simulations not rerunning when the cached job had failed.
  • Fixed EIS step causing all subsequent Time values to be NaN.
  • Fixed parameterization validation plot and various UI issues.
  • Fixed duplicate time value handling using new PyBaMM solvers.
Improvements
  • Refactored validation so objectives own their validations.
  • CostLoggerJob now passes the best log with the lowest cost to Studio.
  • Added parser schema with Pydantic validation and standardized field naming.
  • Added HighSide/LowSide constraint metrics and Maximum aggregation.
  • Generalized the multi-step fast charge example.
  • Cleaned up CostLogger properties and added as a top-level import.
Fixes
  • Fixed sign errors in SingleElectrodeLumpedSPMR.
  • Changed lumped SPMR sign convention to be more intuitive.
​
October 13, 2025
Charge optimization UI

​
Charge optimization UI

A new dedicated UI for charge optimization makes it easy to configure, launch, and monitor optimization runs. The interface includes improved logging, real-time metric extraction, and clearer result display.Find out more →
Fixes
  • Fixed a bug that caused job updates to be ignored.
Fixes
  • Fixed design notebook compatibility with normalized parameter changes.
​
October 6, 2025
AI-powered protocol errors, design DOE refactor, and design optimization

​
AI-powered error handling for protocols

Protocol generation now uses AI to interpret and surface errors, making it easier to diagnose and fix issues without digging through raw logs. The overall protocol creation UX has also been streamlined.

​
Design parameter DOE refactor

The design parameter screen has been reworked to deliver a more classical design-of-experiments experience, making it easier to set up and manage parameter sweeps.Find out more →

​
Design optimization framework

The pipeline now includes a full design optimization framework with validation, error handling, and penalty mechanisms. Three example notebooks — fast charging, thickness-constrained capacity, and discharge capacity — are available to get started quickly.Find out more →
Improvements
  • Updated SQL experiment templates with improved error handling.
  • Switched parameterizations routing from v1 to v2.
Fixes
  • Fixed local database reset — restored missing permissions, roles, and templates data.
Improvements
  • Added design optimization parser for pipeline configurations.
  • Added cross-validated regression methods.
  • Added parse_experiment() for converting experiment configs into PyBaMM Experiment objects with parameter kwargs.
  • Added scalar_output and array_output properties to the Interactive optimizer.
  • Added phase option to InitialSOCHalfCell.
  • Added support for the “lumped” electrode type in interpolant calculations.
  • Improved initial stoichiometry calculations to use T_init.
  • Removed parameter scaling from CostLogger for cleaner cost tracking.
  • Simplified parameter normalization by removing normalized parameters.
Fixes
  • Fixed entropic change export bug in OCP interpolant.
← Newer updates