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.
This page is a detailed reference for built-in templates. See Protocols for the full guide on creating, managing, and using protocols.
Experiment Templates
Ionworks provides 9 built-in experiment templates — pre-configured battery testing protocols that can be customized with different parameters. Each template defines a protocol using the Universal Cycler Protocol (UCP) format with adjustable variables to suit your needs.Template metrics
Some experiment templates include built-in metrics — summary values automatically computed from simulation results. When you run a simulation using one of these templates, the metrics are calculated and displayed in the Data View alongside the simulation inputs. Metrics use a declarative configuration format with these types:| Category | Types | Description |
|---|---|---|
| Aggregation | First, Last, Mean, Minimum, Maximum, Sum | Compute a single value from a time series variable |
| Crossing | SOC, Voltage, Time | Find the value of a variable at a specific state of charge, voltage, or time |
| Composed | ComposedMetric | Combine metrics with arithmetic operations (add, sub, mul, div, abs) |
step field (0-indexed), which is useful for multi-step experiments like pulse resistance tests.
Available Templates
1. Constant Current Discharge
Description: Discharges the battery at a constant C-rate until a voltage cutoff is reached. Adjustable Parameters:- Temperature [°C] - Operating temperature (default: 25°C)
- Initial SOC [%] - Starting state of charge (default: 100%)
- C-rate - Discharge rate relative to nominal capacity (default: 1C)
- Cut-off voltage [V] - Minimum voltage to stop discharge (default: V_MIN)
UCP Protocol
UCP Protocol
| Metric | Description |
|---|---|
| Capacity [A.h] | Final discharge capacity |
| Energy [W.h] | Final discharge energy |
| Mean internal resistance [mΩ] | Average internal resistance over the discharge |
| Mean current [A] | Absolute average current |
| Mean power [W] | Absolute average power |
| Min/Max anode potential [V] | Anode potential range during discharge |
| Min/Max cathode potential [V] | Cathode potential range during discharge |
2. Constant Current Charge
Description: Charges the battery using a constant current (CC) phase followed by a constant voltage (CV) hold. This is the standard CC-CV charging protocol. Adjustable Parameters:- Temperature [°C] - Operating temperature (default: 25°C)
- Initial SOC [%] - Starting state of charge (default: 0%)
- C-rate - Charge rate during CC phase (default: 1C)
- Cut-off voltage [V] - Maximum voltage for CC/CV phases (default: V_MAX)
- CV cut-off C-rate - C-rate threshold to end CV phase (default: 0.02C)
UCP Protocol
UCP Protocol
| Metric | Description |
|---|---|
| Charge capacity [A.h] | Final charge capacity |
| Energy [W.h] | Final charge energy |
| Mean internal resistance [mΩ] | Average internal resistance |
| Mean current [A] | Average charging current |
| Mean power [W] | Absolute average power |
| Min/Max anode potential [V] | Anode potential range during charge |
| Min/Max cathode potential [V] | Cathode potential range during charge |
| Charge time (10-80% SOC) [min] | Time to charge from 10% to 80% state of charge, in minutes |
3. GITT (Galvanostatic Intermittent Titration Technique)
Description: Alternates between current pulses and rest periods to measure quasi-equilibrium voltage as a function of state of charge. This technique separates kinetic and thermodynamic contributions to the cell voltage. This experiment will run until the voltage reaches the upper or lower voltage cut-off during the pulse phase. Adjustable Parameters:- Temperature [°C] - Operating temperature (default: 25°C)
- Direction - ‘Charge’ or ‘Discharge’ (default: ‘Discharge’)
- Pulse C-rate - Current rate during active pulses (default: 0.1C)
- Pulse duration [s] - Length of each current pulse (default: 1800s / 30 min)
- Rest duration [s] - Length of each rest period (default: 1800s / 30 min)
UCP Protocol
UCP Protocol
4. PITT (Potentiostatic Intermittent Titration Technique)
Description: Steps the voltage in small increments with rest periods between steps. Measures current response to voltage changes to study electrode kinetics. Adjustable Parameters:- Temperature [°C] - Operating temperature (default: 25°C)
- Starting voltage [V] - Initial cell voltage (default: V_MIN)
- Final voltage [V] - Target cell voltage (default: V_MAX)
- Voltage step [V] - Size of voltage increments (default: 0.1V)
- Pulse duration [s] - Hold time at each voltage (default: 900s / 15 min)
- Rest duration [s] - Rest time between voltage steps (default: 900s / 15 min)
UCP Protocol
UCP Protocol
5. Pulse Resistance
Description: Measures DC internal resistance (DCIR) using a rest-pulse-rest sequence. Quantifies the instantaneous voltage response to a current pulse. Adjustable Parameters:- Temperature [°C] - Operating temperature (default: 25°C)
- Initial SOC [%] - State of charge for test (default: 50%)
- C-rate - Magnitude of current pulse (default: 1C)
- Direction - ‘Charge’ or ‘Discharge’ (default: ‘Discharge’)
- Duration [s] - Total pulse duration (default: 10s)
UCP Protocol
UCP Protocol
| Metric | Description |
|---|---|
| Pulse overpotential [mV] | Voltage difference between rest and pulse end, in millivolts |
| Pulse resistance [mΩ] | DC internal resistance calculated as overpotential divided by mean pulse current |
Pulse resistance metrics use step-level filtering to compare the voltage at the end of the initial rest period (step 0) with the voltage at the end of the current pulse (step 1).
6. Pseudo-OCV
Description: Measures the voltage profile at a very low C-rate to approximate the open-circuit voltage (OCV) vs. SOC relationship. The slow rate minimizes polarization effects. Adjustable Parameters:- Temperature [°C] - Operating temperature (default: 25°C)
- Direction - ‘Charge’ or ‘Discharge’ (default: ‘Discharge’)
- C-rate - Very slow rate to minimize polarization (default: 0.05C)
UCP Protocol
UCP Protocol
| Metric | Description |
|---|---|
| Capacity [A.h] | Absolute step capacity |
| Mean internal resistance [mΩ] | Absolute average internal resistance |
| Mean current [A] | Absolute average current |
7. EIS (Electrochemical Impedance Spectroscopy)
Description: Applies small AC voltage perturbations across a range of frequencies to measure the complex impedance of the cell. Maps out kinetic and transport processes. Adjustable Parameters:- Temperature [°C] - Operating temperature (default: 25°C)
- SOC [%] - State of charge for measurement (default: 50%)
- Lower frequency [Hz] - Minimum frequency (default: 0.0001 Hz)
- Upper frequency [Hz] - Maximum frequency (default: 10000 Hz)
UCP Protocol
UCP Protocol
8. Cyclic Voltammetry
Description: Sweeps the cell voltage linearly between upper and lower limits at a controlled scan rate. Measures current response to identify redox reactions. Adjustable Parameters:- Temperature [°C] - Operating temperature (default: 25°C)
- Scan rate [mV/s] - Rate of voltage sweep (default: 0.1 mV/s)
UCP Protocol
UCP Protocol
9. Cycle Aging
Description: Repeated charge/discharge cycles with capacity fade monitoring. Uses CCCV charge (constant current to voltage limit, then constant voltage to C-rate cutoff) and CC discharge with dual termination (voltage cutoff or depth-of-discharge capacity limit). Tracks capacity retention and can stop early when capacity falls below a specified percentage of nominal. Adjustable Parameters:- Temperature [°C] - Operating temperature (default: 25°C)
- Nominal capacity [A.h] - Cell capacity for C-rate and DOD calculations (default: 5.0 A.h)
- Charge C-rate - C-rate during CC charge phase (default: 1C)
- Discharge C-rate - C-rate during discharge (default: 1C)
- Depth of discharge [%] - Target DOD per cycle as % of nominal capacity (default: 100%)
- Discharge voltage cutoff [V] - Minimum voltage to stop discharge (default: V_MIN)
- Charge voltage [V] - Maximum voltage for CC/CV charge (default: V_MAX)
- Charge C-rate cutoff - C-rate threshold to end CV phase (default: 0.05C)
- Post charge rest time [s] - Rest after charge (default: 600 s)
- Post discharge rest time [s] - Rest after discharge (default: 600 s)
- Number of cycles - Maximum charge/discharge cycles (default: 100)
- End capacity [%] - Stop cycling when capacity falls below this % of nominal (default: 80%)
UCP Protocol
UCP Protocol
| Metric | Description |
|---|---|
| Total cycles | Number of completed charge/discharge cycles |
| Initial capacity [A.h] | Absolute discharge capacity from the first cycle |
| Final capacity [A.h] | Absolute discharge capacity from the last cycle |
| Capacity retention [%] | Ratio of final to initial capacity, expressed as a percentage |
| Total energy throughput [W.h] | Sum of discharge and charge energy over all cycles |
| Total charge throughput [A.h] | Sum of discharge and charge capacity over all cycles |
Parameter Types
Standard Parameters
Most templates accept these common parameters:- Temperature [°C]: Operating temperature
- Initial SOC [%]: Starting state of charge (0-100%)
- C-rate: Current normalized by nominal capacity (e.g., 1C = full capacity in 1 hour)
Voltage References
Some parameters can reference cell-specific voltages:- V_MIN: Minimum safe voltage for the cell model
- V_MAX: Maximum safe voltage for the cell model
Direction
For bidirectional tests, specify ‘Charge’ or ‘Discharge’ to set the current direction.Using Experiment Templates
In Simulations
- Select a cell and model
- Choose an experiment template from the “Start from existing protocol” dropdown
- Adjust parameters as needed
- Run the simulation
Creating Studies
You can run multiple experiments with different parameters in a study to:- Compare performance at different temperatures
- Evaluate different C-rates
- Map out behavior across SOC range
Next Steps
- Create your own protocols with custom parameters
- Learn more about Projects and Studies
- Explore Simulations
- Understand the Universal Cycler Protocol format