Validate Pybamm Model Config

curl --request POST \
  --url https://api.ionworks.com/discovery/pybamm_models/validate \
  --header 'Content-Type: application/json' \
  --data '
{
  "pybamm_model": "<string>",
  "module": "lithium_ion",
  "options": {}
}
'

{}

discovery

Validate Pybamm Model Config

Try to instantiate a pybamm/ionworks model with the given options.

Lightweight check that catches bad combinations of model name + options before a record is persisted. Builds the model in-process — same code path ModelService.get_pybamm_model_from_config uses at simulation time — and reports whether construction succeeded.

On failure the response carries the underlying exception’s message verbatim (typically a pybamm OptionError / ValueError) so the caller can act on it.

The model is built and dropped; nothing is written to the database.

curl --request POST \
  --url https://api.ionworks.com/discovery/pybamm_models/validate \
  --header 'Content-Type: application/json' \
  --data '
{
  "pybamm_model": "<string>",
  "module": "lithium_ion",
  "options": {}
}
'

{}

Body

application/json

Body for POST /discovery/pybamm_models/validate.

pybamm_model

string

required

Class name to instantiate, e.g. 'DFN', 'SPM', 'ECM'. Must be one of the names returned by GET /discovery/pybamm_models.

module

string

default:lithium_ion

PyBaMM submodule the class lives under ('lithium_ion' or 'lead_acid'). Ignored for ionworks-specific models.

options

Options · object

Options dict to pass to the model constructor.

Response

Successful Response

The response is of type Response Validate Pybamm Model Config Discovery Pybamm Models Validate Post · object.

Get Pybamm Models Get Parameterized Model Schema

⌘I