Preview Experiment Backend

curl --request POST \
  --url https://api.ionworks.com/optimize/preview-experiment-backend \
  --header 'Content-Type: application/json' \
  --data '
{
  "experiment": "<string>"
}
'

{
  "pybamm_compatible": true,
  "error": "<string>"
}

curl --request POST \
  --url https://api.ionworks.com/optimize/preview-experiment-backend \
  --header 'Content-Type: application/json' \
  --data '
{
  "experiment": "<string>"
}
'

{
  "pybamm_compatible": true,
  "error": "<string>"
}

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

⌘I