Skip to content

scenario

EnScenario

Bases: BaseModel

Represents an energy scenario with detailed specifications and attributes.

The EnScenario class models a scenario in an energy system setting, incorporating various attributes such as name, start date, time steps, interval, and associated energy system models. This facilitates structured handling of scenario data within an energy modeling system.

Attributes:

Name Type Description
name str

Name of the energy scenario. Must be between 1 and 100 characters.
start_date date

The starting date for the scenario. Defaults to the current date.
time_steps int | None

The number of time steps in the scenario. Can be None for no specific limit or defaults to 8760.
interval float

The interval between each time step in hours. Defaults to 1.0.
project_id int

Identifier for the project to which the scenario belongs.
energysystem_model EnEnergysystem

The associated energy system model for the scenario.
Source code in backend/app/scenario/model.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
class EnScenario(BaseModel):
    """
    Represents an energy scenario with detailed specifications and attributes.

    The EnScenario class models a scenario in an energy system setting, incorporating
    various attributes such as name, start date, time steps, interval, and associated
    energy system models. This facilitates structured handling of scenario data within
    an energy modeling system.

    :ivar name: Name of the energy scenario. Must be between 1 and 100 characters.
    :type name: Str
    :ivar start_date: The starting date for the scenario. Defaults to the current date.
    :type start_date: Date
    :ivar time_steps: The number of time steps in the scenario. Can be None for no specific
                      limit or defaults to 8760.
    :type time_steps: Int | None
    :ivar interval: The interval between each time step in hours. Defaults to 1.0.
    :type interval: Float
    :ivar project_id: Identifier for the project to which the scenario belongs.
    :type project_id: Int
    :ivar energysystem_model: The associated energy system model for the scenario.
    :type energysystem_model: EnEnergysystem
    """
    name: str = Field(min_length=1, max_length=100)
    start_date: date = Field(default=datetime.now().date()) # start
    time_steps: int | None = Field(default=8760, nullable=True) # number
    interval: float = Field(default=1.0)  # interval
    project_id: int
    energysystem_model: EnEnergysystem = Field(default={})

EnScenarioDB

Bases: SQLModel

Represents the database model for energy scenario information.

This class defines a database model for storing information about energy scenarios. It uses SQLModel with table mapping enabled to represent the corresponding table in the database. The class includes various fields that describe properties of the energy scenario, such as its name, associated project and user IDs, start date, time steps, and other relevant details.

Attributes:

Name Type Description
id int

Primary key of the scenario record.
name str

Name of the energy scenario must be between 1 and 100 characters in length.
start_date date

Start date of the energy scenario. This is a required field.
time_steps int | None

Number of time steps in the energy scenario. Defaults to 8760 if not provided and is nullable.
interval float

Time interval associated with the energy scenario. Defaults to 1.
project_id int

Foreign key referencing the associated project for the scenario.
user_id int

Foreign key referencing the user associated with the scenario.
energysystem_model EnEnergysystem

JSONB column storing the energy system model associated with the scenario. Defaults to an empty dictionary.
Source code in backend/app/scenario/model.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
class EnScenarioDB(SQLModel, table=True):
    """
    Represents the database model for energy scenario information.

    This class defines a database model for storing information about
    energy scenarios. It uses SQLModel with table mapping enabled
    to represent the corresponding table in the database. The class
    includes various fields that describe properties of the energy
    scenario, such as its name, associated project and user IDs, start
    date, time steps, and other relevant details.

    :ivar id: Primary key of the scenario record.
    :type id: Int
    :ivar name: Name of the energy scenario must be between 1 and 100
        characters in length.
    :type name: Str
    :ivar start_date: Start date of the energy scenario. This is a required
        field.
    :type start_date: Date
    :ivar time_steps: Number of time steps in the energy scenario.
        Defaults to 8760 if not provided and is nullable.
    :type time_steps: Int | None
    :ivar interval: Time interval associated with the energy scenario.
        Defaults to 1.
    :type interval: Float
    :ivar project_id: Foreign key referencing the associated project for
        the scenario.
    :type project_id: Int
    :ivar user_id: Foreign key referencing the user associated with the
        scenario.
    :type user_id: Int
    :ivar energysystem_model: JSONB column storing the energy system
        model associated with the scenario. Defaults to an empty
        dictionary.
    :type energysystem_model: EnEnergysystem
    """
    __tablename__ = "scenarios"

    id: int = Field(default=None, primary_key=True)
    name: str = Field(min_length=1, max_length=100)
    start_date: date = Field(nullable=False)
    time_steps: int | None = Field(default=8760, nullable=True)
    interval: float = Field(default=1)
    project_id: int = Field(foreign_key="projects.id")
    user_id: int = Field(foreign_key="users.id")
    energysystem_model: EnEnergysystem = Field(sa_column=Column(JSONB), default={})

EnScenarioUpdate

Bases: EnScenario

Represents an updated energy scenario with validated parameters.

This class extends the functionality of the EnScenario class to allow for scenario updates with specific attributes constrained by validation requirements. It is primarily used for defining and updating the parameters of an energy simulation scenario, ensuring proper formats and validations such as field lengths and data type constraints.

Attributes:

Name Type Description
name str | None

Optional name of the scenario, which must be a string with a minimum length of 1 character and a maximum length of 100 characters.
interval float | None

Optional interval defining the time step size, where the value is a float.
start_date date | None

Optional start date for the scenario, represented as a date object.
time_steps int | None

Optional total number of time steps in the simulation.
energysystem_model EnEnergysystem | None

Optional reference to an energy system model associated with the scenario.
project_id None

Reserved attribute for the project ID, currently none.
user_id None

Reserved attribute for the user ID, currently none.
Source code in backend/app/scenario/model.py 
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
class EnScenarioUpdate(EnScenario):
    """
    Represents an updated energy scenario with validated parameters.

    This class extends the functionality of the `EnScenario` class to allow for
    scenario updates with specific attributes constrained by validation requirements.
    It is primarily used for defining and updating the parameters of an energy simulation
    scenario, ensuring proper formats and validations such as field lengths and data type
    constraints.

    :ivar name: Optional name of the scenario, which must be a string with a
        minimum length of 1 character and a maximum length of 100 characters.
    :type name: Str | None
    :ivar interval: Optional interval defining the time step size, where the value
        is a float.
    :type interval: Float | None
    :ivar start_date: Optional start date for the scenario, represented as a date object.
    :type start_date: Date | None
    :ivar time_steps: Optional total number of time steps in the simulation.
    :type time_steps: Int | None
    :ivar energysystem_model: Optional reference to an energy system model
        associated with the scenario.
    :type energysystem_model: EnEnergysystem | None
    :ivar project_id: Reserved attribute for the project ID, currently none.
    :type project_id: None
    :ivar user_id: Reserved attribute for the user ID, currently none.
    :type user_id: None
    """
    name: str | None = Field(default=None, min_length=1, max_length=100, nullable=True)
    interval: float | None = Field(default=1, nullable=True)
    start_date: date | None = Field(default=None, nullable=True)
    time_steps: int | None = Field(default=None, nullable=True)
    energysystem_model: EnEnergysystem | None = Field(default=None, nullable=True)
    project_id: None = None
    user_id: None = None