Skip to main content
Preview Experiment Backend

Body

application/json

Request body for previewing simulation backend compatibility.

experiment
string
required

UCP protocol YAML string

Response

Successful Response

Compatibility report for a UCP protocol against the PyBaMM backend.

The PyBaMM backend converts UCP protocols to pybamm.Experiment objects. Some UCP features (loops, conditionals, EIS, expression-driven values) are not representable in a PyBaMM experiment, in which case the user must run on the UCP backend instead.

pybamm_compatible
boolean
required
error
string | null