Ionworks Studio provides an end-to-end toolkit for experimental battery data — from ingesting raw cycler files, to organizing measurements against cell specifications, to exploring results in the browser or via the Python API.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.
Data hierarchy
Your experimental data is organized hierarchically within your organization:Cell Specification
The blueprint defining cell properties — materials, capacity, voltage
limits. Shared across cells with identical specifications.
Cell Instance
A specific physical cell you’re testing. Each instance has a unique
identifier within your organization.
Cell Measurement
A single experiment or test run on a cell instance. Each measurement has
a type that determines what data it stores.
Data files
Raw time-series data and computed summaries stored in optimized formats
for fast visualization and analysis.
Measurement types
Every cell measurement has ameasurement_type that determines what data it
stores. See measurements for a deeper dive on each
type, their fields, and creation examples.
| Type | Stores | Typical use |
|---|---|---|
time_series | High-resolution cycling data with voltage, current, and time columns. Includes auto-generated step and cycle summaries. | Battery cycling tests, EIS measurements, charge/discharge experiments |
properties | Key-value pairs with optional units. No file upload. | Manual measurements like thickness, weight, internal resistance |
file | One or more uploaded files. | Microscopy images, SEM photos, post-mortem analysis documents |
Data workflow
Prepare your data
Convert raw cycler files into the Ionworks format using the
ionworksdata library. See
preparing data.Upload
Create cell specs, instances, and measurements via the Python API. See
uploading data.
Read and analyze
Retrieve data back, filter, and plot with the Python client — see
reading data — or explore interactively in the browser
via visualizing data.
Browsing data tables
When you navigate to a cell specification or cell instance in Ionworks Studio, data is displayed in sortable tables. Click any column header to sort — once for ascending, again for descending, a third time to clear. This works across cell measurement tables and pipeline tables alike.Next steps
Data format
Recognized columns, units, and sign conventions.
Preparing data
Read cycler files with the ionworksdata library.
Uploading data
Upload cell specs, instances, and measurements via the Python API.
Visualizing data
Explore uploaded data with the interactive viewer.