general Section
Scope and overview
The general block contains meta-information governing the simulation setup, project structure, and global profiles shared across users.
Example:
general:
init_step: 1
final_step: 1152
d_rate: 0.03
project_lifetime: 20
user_set: [user1, user2, user3]
profile:
time_res: time_res
energy_weight: energy_weight
reward_price: reward_price
peak_categories: peak_categories
optional_datasets:
- input_resource.csv
- market_data.csv
- flexibility_resource.csvThe example showcase the use of the tool for the simulation of 3 users (user1, user2, user3) over a project lifetime of 20 years, with an initial step of 1 and a final step of 1152. The discount rate is set to 3%. The profiles for time resolution, energy weight, reward price, and peak categories are defined under the profile section. Additionally, optional datasets such as input_resource.csv, market_data.csv, and flexibility_resource.csv are specified for inclusion in the simulation.
Note: The
optional_datasetssection contains a list of additional CSV files that can be included in the simulation for enhanced data input. The string entries in allprofilefields are interpreted as column names from the CSV files listed in theoptional_datasetsfield.
Parameters in general Section
| Parameter | Unit | Example | Description |
|---|---|---|---|
| init_step | - | 1 | Initial time step index |
| final_step | - | 1152 | Final time step index |
| d_rate | - | 0.03 | Discount rate applied to yearly cash flows |
| project_lifetime | years | 20 | Total project lifetime |
| user_set | list | [user1, user2, user3] | List of users included in the simulation |
| profile | |||
| –time_res | str or float or list | time_res | Time resolution of the simulation. When a string is provided, the time resolution profile is loaded from the optional_datasets; alternatively, a float or list of floats can be provided directly |
| –energy_weight | str or float or list | energy_weight | Weight of each time step over the year |
| –reward_price | str or float or list | reward_price | Column containing the reward value for shared energy |
| –peak_categories | str or float or list | peak_categories | Peak-category label for each time step |
| optional_datasets | list | [input_resource.csv,...] | List of datasets from where to load the profile quantities when string entries values are provided |