Pipeline Elements
The basic building block is a pipeline element. Any pipeline element accepts a set of parameter values (possibly empty) and returns another set of parameter values. The full pipeline is built by calling each element in series to yield the complete parameter set. There are four types of pipeline element:| Type | Description |
|---|---|
| DirectEntry | The simplest type—ignores input parameters and returns pre-defined values (e.g., from literature or direct measurements) |
| Calculation | Computes new parameters based on provided inputs (e.g., calculating maximum particle concentration from capacity, volume fraction, and thickness) |
| DataFit | Estimates parameters by fitting a model to experimental data |
| Validation | Checks fitted parameters against held-out data |
- Takes input parameters from the parameter dictionary
- Performs computation
- Returns output parameters that become available to subsequent elements
To assemble and submit a pipeline programmatically, see Pipelines → Overview in the Documentation tab.
Naming conventions
Clear Naming
Use descriptive parameter names with units:
"Electrode capacity [A.h]" not "cap"Unit Consistency
Be explicit about unit conversions; use SI units internally
Built-in Calculations
Geometry & Capacity
Electrode geometry, mass, capacity, cyclable lithium, and microstructure
Thermal Properties
Heat capacity, Arrhenius temperature dependence, and thermal modeling
Piecewise Interpolants
Smooth piecewise functions for SOC and temperature-dependent parameters
Data Fitting
The pipeline abstraction also powers data fitting—estimating unknown parameters by comparing model predictions to experimental data. ADataFit element wraps a pipeline with an optimization loop:
- The optimizer proposes parameter values
- The pipeline runs the model with those values
- The objective computes how well predictions match data
- This repeats until the best-fit parameters are found
Data Fitting (theory)
Cost functions, identifiability, regularization, and other theory.
Data Fitting (how-to)
Configure and submit data fits with
ionworks-schema + ionworks-api.