ecm-project

Validate Ecm Endpoint

Validate a fitted ECM on held-out data (synchronous, no fit, no pipeline).

Re-simulates the fitted model forward on the held-out current using the same engine POST /ecm/fit runs internally, then returns model-vs-data traces and RMSE/MAE/Max voltage error.

post/ecm/validate

Request body

measurement_idstring nullable

Held-out cell measurement to validate against.

example_idstring nullable

Built-in example dataset id to validate against.

start_stepinteger nullable

Optional inclusive start step (measurement only).

end_stepinteger nullable

Optional inclusive end step (measurement only).

initial_socnumber nullable

Known SOC (0–1) at the start of the held-out trace. When omitted it is recovered from the trace's first voltage via the fitted OCV(SOC) curve (assumes the trace starts near rest).

capacitynumber nullable

Cell capacity [Ah] for the SOC integration. Defaults to the fit/model capacity (the SOC reference the curves were fitted against); it is never re-estimated from the held-out trace.

parameterized_model_idstring nullable

Saved ECM parameterized model to re-simulate.

Response

Successful Response

rmse_mVnumber required

Root-mean-square voltage error [mV].

mae_mVnumber required

Mean absolute voltage error [mV].

max_mVnumber required

Maximum absolute voltage error [mV].

num_rcsinteger required

RC-pair count of the validated model.

capacity_Ahnumber[] required

Capacity used for SOC integration [Ah] (single-element list).

initial_socnumber required

Initial SOC used for the held-out trace.

model_sourcestring required

Where the validated model came from.

timenumber[] required

Downsampled time grid [s].

data_voltagenumber[] required

Held-out measured voltage [V].

model_voltagenumber[] required

Re-simulated model voltage [V].

residual_mVnumber[] required

Model − data voltage residual [mV].

Changes

No recorded changes to this endpoint across all 1 revision of this API.