Serialize Ionworks Model

Build an ionworks model and return its pybamm Serialise JSON.

Lets callers without the licensed ionworkspipeline package use ionworks models (ECM, LumpedSPMR, GITTModel, …): the JSON loads with plain pybamm via Serialise.load_custom_model. Standard pybamm models are already usable directly, so requesting one returns 400.

Returned verbatim because the JSON may contain Infinity/NaN literals; Python’s json (and the SDK) parse these fine.

Serialize Ionworks Model

cURL

curl --request POST \
  --url https://api.ionworks.com/discovery/ionworks_models/serialize \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "options": {}
}
'

422

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Body

application/json

Body for POST /discovery/ionworks_models/serialize.

name · string · required

Ionworks model class name to build and serialize, e.g. 'ECM', 'LumpedSPMR', 'MSMRFullCellModel', 'GITTModel'. Must be one of the names returned under 'ionworks_models' by GET /discovery/pybamm_models.

options · Options · object

Options dict to pass to the model constructor.

Response

200

application/json

Successful Response