IOionworks
discovery

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.

post/discovery/ionworks_models/serialize

Request

  • Base URL
    https://api.ionworks.com
  • URL
    https://api.ionworks.com/discovery/ionworks_models/serialize
  • Auth
    none declared

Request body

namestring 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.

optionsobject

Options dict to pass to the model constructor.

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 25 revisions of this API.