IOionworks

Add a custom variable to an existing model

Changed on

Append a new custom variable to a model's config (append-only).

Validates the expression, serializes it to JSON, and stores it. Custom variables cannot be edited or deleted after creation because evaluated values are persisted in simulation result files.

post/models/{model_id}/custom-variables

Request

  • Base URL
    https://api.ionworks.com
  • URL
    https://api.ionworks.com/models/{model_id}/custom-variables
  • Auth
    none declared

Path parameters

model_idstring uuid required

Request body

namestring required

Display name of the custom variable.

expressionstring required

PyBaMM expression string (e.g. CoupledVariable('Voltage [V]') - Parameter('Offset')).

Response

Successful Response

namestring required

The name of the model.

descriptionstring nullable

An optional description for the model.

pybamm_versionstring nullable

PyBaMM version used for this model. If not provided, will be read from pybamm.version.

chemistry'lithium_ion' | 'lithium_sulfur' | 'ecm' | 'generic'

Model chemistry kind: 'lithium_ion' (default — assumes pybamm lithium-ion conventions), 'lithium_sulfur', 'ecm', or 'generic' (no chemistry-specific enrichment).

simulation_settingsobject nullable

Optional persistent simulation kwargs (var_pts / submesh_types / spatial_methods / geometry / solver) in the flat canonical form, re-applied at simulation time. None uses the model defaults.

project_idstring nullable

Project this model belongs to. None only for the shared system catalog.

idstring required

The unique identifier for the model.

user_idstring nullable

The ID of the user who created the model. None once that account is deleted.

organization_idstring required

The ID of the organization this model belongs to.

source_model_idstring nullable

For a project's copy of a system model, the system model it was copied from. None for a model the project made itself.

created_by_emailstring nullable

Email of the user who created the model.

created_atstring date-time required

Timestamp of when the model was created.

updated_atstring date-time required

Timestamp of when the model was last updated.

configobject required

Model configuration stored as JSON.

is_custom_modelboolean required

Check if this is a custom model (has compressed model data).

Changes

  • 4185f624bbb8Revision changes
    • breaking

      the response property became optional for the status

    • breaking

      response property user_id list-of-types was widened by adding types null to media type application/json of response 201

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • ea3d377fec1aRevision changes
    • breaking

      for the path request parameter model_id, the format changed from no format to uuid