Skip to content

User defined experiment meta data🔗

Users can associate extra information with experiments as metadata. The data is added in the form of a dict with String, Boolean or Real values. This may be useful to include information that is not readily available through the model parameters/variables to provide a description of the experiment.

Note

There are some limitations:
- Flat list of key-value pairs
- Up to a total of 2 kB of uncompressed data per experiment

The metadata can be added through the Python client REST API, when executing the experiment.

user_data = {"Author": "John Doe", "parameterizationFrom":3.4, "dataFromMeasurement":True}
experiment = workspace.execute(experiment_definition, user_data=user_data).wait()

This affects the POST /workspaces/{workspace}/experiments, the example above will add a custom userData property to an experiment as shown below. This data is also accessible through storage_api.get_experiment_meta()

{ 
    "experiment": {
        "version": 2,
        "base": {
            "model": {
                "fmu": {
                    "id": "{{ fmu_id }}"
                }
            },
            "modifiers": {
                "variables": {
                    "inertia1.J": "range(1, 2, 10)"
                }
            },
            "analysis": {
                "type": "dynamic",
                "parameters": {
                    "start_time": 0,
                    "final_time": 1
                }
            }
        }
    },
    "userData": {
        "Author": "John Doe",
        "parameterizationFrom":3.4,
        "dataFromMeasurement":True
    }
}

Dynamic Simulation | Steady State | Cancelled Simulation | MultiExecution