Model

Introduction

After creating a dataset, you can create a energy model based on it. The energy model allows you to create multiple simulations based on one dataset with different parameters. Therefore you need to specify model parameters, that overrides the default values provided within the dataset.

Create a new Model

To create a new model, the API REST interface POST /models/ is addressed. The following parameters should be provided:

• name: Name of the model

• description: Description of the model

• ref_dataset: ID of the reference dataset on which the model is based on.

• model_parameters: The model parameters, that overrides the default values provided within the dataset.

The endpoint returns the id of the newly created model.

A full documentation of the API is available as redoc documentation.

GET /models/

Get Energy Model By Dataset

Get all energy models of a dataset.

Query Parameters:

• dataset_id (integer) – (Required)

• skip (integer) –

• limit (integer) –

Status Codes:

• 200 OK – Successful Response

• 422 Unprocessable Entity – Validation Error

POST /models/

Create Model

Create a new energy model.

Status Codes:

• 200 OK – Successful Response

• 409 Conflict – EnergyModel with same name already exists.

• 422 Unprocessable Entity – Validation Error

Get Model information

To get model information, the API REST interface GET /models/ is addressed. Requires the model_id. The endpoint returns the corresponding model information.