Index
frequenz.data.microgrid ¤
Initialize the microgrid data module.
Classes¤
frequenz.data.microgrid.MicrogridConfig ¤
Configuration of a microgrid.
Source code in frequenz/gridpool/config/_microgrid.py
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 | |
Attributes¤
altitude
class-attribute
instance-attribute
¤
altitude: float | None = None
Geographic altitude of the microgrid.
battery
class-attribute
instance-attribute
¤
Configuration of the batteries.
ctype
class-attribute
instance-attribute
¤
Mapping of component category types to ac power component config.
end_time
class-attribute
instance-attribute
¤
End time of the microgrid operation.
enterprise_id
class-attribute
instance-attribute
¤
enterprise_id: int | None = None
Enterprise ID of the microgrid.
gid
class-attribute
instance-attribute
¤
gid: int | None = None
Legacy ID; if set, all gridpool relations must name it.
latitude
class-attribute
instance-attribute
¤
latitude: float | None = None
Geographic latitude of the microgrid.
longitude
class-attribute
instance-attribute
¤
longitude: float | None = None
Geographic longitude of the microgrid.
pv
class-attribute
instance-attribute
¤
Configuration of the PV system.
start_time
class-attribute
instance-attribute
¤
Start time of the microgrid operation.
wind
class-attribute
instance-attribute
¤
Configuration of the wind turbines.
Methods:¤
component_type_ids ¤
component_type_ids(
component_type: str,
component_category: str | None = None,
metric: str = "",
) -> list[int]
Get a list of all component IDs for a component type.
| PARAMETER | DESCRIPTION |
|---|---|
component_type
|
Component type to be aggregated.
TYPE:
|
component_category
|
Specific category of component IDs to retrieve (e.g., "meter", "inverter", or "component"). If not provided, the default logic is used.
TYPE:
|
metric
|
Metric name of the formula if CIDs should be extracted from the formula.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
list[int]
|
List of component IDs for this component type. |
| RAISES | DESCRIPTION |
|---|---|
ValueError
|
If the component type is unknown. |
KeyError
|
If |
Source code in frequenz/gridpool/config/_microgrid.py
component_types ¤
formula ¤
Get the formula for a component type.
| PARAMETER | DESCRIPTION |
|---|---|
component_type
|
Component type to be aggregated.
TYPE:
|
metric
|
Metric to be aggregated.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
str
|
Formula to be used for this aggregated component as string. |
| RAISES | DESCRIPTION |
|---|---|
ValueError
|
If the component type is unknown or formula is missing. |
Source code in frequenz/gridpool/config/_microgrid.py
frequenz.data.microgrid.MicrogridData ¤
Fetch metric data for component types of a microgrid.
Source code in src/frequenz/data/microgrid/component_data.py
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 87 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 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 | |
Attributes¤
microgrid_configs
property
¤
microgrid_configs: dict[int, MicrogridConfig] | None
Return the microgrid configurations.
microgrid_ids
property
¤
Methods:¤
__init__ ¤
__init__(
server_url: str,
auth_key: str,
sign_secret: str,
microgrid_configs: (
_MicrogridConfigMapping
| _MicrogridConfigsContainer
| None
) = None,
assets_client: AssetsApiClient | None = None,
) -> None
Initialize microgrid data.
| PARAMETER | DESCRIPTION |
|---|---|
server_url
|
URL of the reporting service.
TYPE:
|
auth_key
|
Authentication key to the service.
TYPE:
|
sign_secret
|
Secret for signing requests.
TYPE:
|
microgrid_configs
|
A mapping of microgrid IDs to configurations, or a gridpool configuration document containing that mapping.
TYPE:
|
assets_client
|
Optional Assets API client used to fetch static battery SOC rated bounds.
TYPE:
|
Source code in src/frequenz/data/microgrid/component_data.py
ac_active_energy
async
¤
ac_active_energy(
*,
microgrid_id: int,
start: datetime,
end: datetime,
component_types: tuple[str, ...] = (
"grid",
"pv",
"wind",
"battery",
"chp",
"consumption",
),
resampling_period: timedelta = timedelta(seconds=10),
keep_components: bool = False,
unit: str = "Wh",
direction: Literal[
"net", "consumed", "delivered"
] = "net"
) -> DataFrame | None
Fetch AC active energy, optionally for one direction only.
direction="net" fetches the net cumulative-energy metric. The raw readings are cumulative meter values.
Source code in src/frequenz/data/microgrid/component_data.py
ac_active_power
async
¤
ac_active_power(
*,
microgrid_id: int | str,
start: datetime,
end: datetime,
component_types: tuple[str, ...] = (
"grid",
"pv",
"wind",
"battery",
"chp",
"consumption",
),
resampling_period: timedelta = timedelta(seconds=10),
keep_components: bool = False,
splits: bool = False,
unit: str = "kW",
from_energy: bool = False
) -> DataFrame | None
Power data for component types of a microgrid.
Set from_energy to derive power from net AC active energy instead of
fetching the instantaneous power metric.
Source code in src/frequenz/data/microgrid/component_data.py
metric_data
async
¤
metric_data(
*,
microgrid_id: int | str,
start: datetime,
end: datetime,
component_types: tuple[str, ...] = (
"grid",
"pv",
"battery",
"wind",
"chp",
"consumption",
),
resampling_period: timedelta = timedelta(seconds=10),
metric: str = "AC_POWER_ACTIVE",
keep_components: bool = False,
splits: bool = False
) -> DataFrame | None
Fetch aggregated data for an arbitrary metric across component types.
| PARAMETER | DESCRIPTION |
|---|---|
microgrid_id
|
Microgrid ID. Numeric strings are accepted for notebook compatibility. |
start
|
Start timestamp.
TYPE:
|
end
|
End timestamp.
TYPE:
|
component_types
|
Component types whose aggregation formulas should be queried for the requested metric.
TYPE:
|
resampling_period
|
Sampling period used for the reporting query. |
metric
|
Reporting metric name to fetch.
TYPE:
|
keep_components
|
Whether to include individual component IDs alongside the aggregated component-type columns.
TYPE:
|
splits
|
Whether to append positive and negative split columns for each returned column.
TYPE:
|
Returns: DataFrame with power data of aggregated components or None if no data is available
| RAISES | DESCRIPTION |
|---|---|
ValueError
|
If microgrid configurations are not loaded. |
Source code in src/frequenz/data/microgrid/component_data.py
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 | |
soc
async
¤
soc(
*,
microgrid_id: int | str,
start: datetime,
end: datetime,
resampling_period: timedelta = timedelta(seconds=10),
keep_components: bool = False
) -> DataFrame | None
Fetch and aggregate SOC for the configured battery components.
Battery component IDs are read from the microgrid configuration. Their SOC and capacity values are fetched directly per component, without requiring aggregation formulas in the microgrid configuration. The aggregate SOC is a capacity-weighted average, using each component's own capacity reading at each timestamp so that capacity changes are reflected over time. SOC bounds are aggregated using those same capacity weights.
| PARAMETER | DESCRIPTION |
|---|---|
microgrid_id
|
The ID of the microgrid. |
start
|
The start time for the data fetch.
TYPE:
|
end
|
The end time for the data fetch.
TYPE:
|
resampling_period
|
The period for resampling the data. |
keep_components
|
Whether to keep individual component data.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
DataFrame | None
|
A DataFrame containing the aggregated SOC data, or None if no data is available. |
| RAISES | DESCRIPTION |
|---|---|
ValueError
|
If microgrid configurations are not loaded. |
Source code in src/frequenz/data/microgrid/component_data.py
343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 | |
frequenz.data.microgrid.StatefulDataFetcher ¤
A helper class to handle fetching of microgrid component data.
This class provides methods to query new data for a specific microgrid and its components, and to write the updated data to a temporary file. The file is written only temporarily and needs to be committed or rolled back in case of success or failure, respectively.
Source code in src/frequenz/data/microgrid/_stateful_data_fetcher.py
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 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 | |
Methods:¤
__init__ ¤
__init__(
microgrid_data: MicrogridData,
data_buffer_dir: Path,
resampling_period: timedelta,
end_time_delta: timedelta = END_TIME_DELTA,
initial_period: timedelta = timedelta(hours=1),
) -> None
Initialize the TransactionalDataExport class.
| PARAMETER | DESCRIPTION |
|---|---|
microgrid_data
|
An instance of MicrogridData to query data from.
TYPE:
|
data_buffer_dir
|
The path to the directory for buffering data.
TYPE:
|
resampling_period
|
The period to resample the data.
TYPE:
|
end_time_delta
|
The time subtracted from now to be passed as end_time to the API.
TYPE:
|
initial_period
|
The initial period to use for the first data fetch. |
Source code in src/frequenz/data/microgrid/_stateful_data_fetcher.py
commit ¤
Commit the temporary files to their final locations.
Source code in src/frequenz/data/microgrid/_stateful_data_fetcher.py
receive_microgrid_data
async
¤
receive_microgrid_data(
microgrid_id: int,
components: tuple[str, ...],
metric: str,
) -> DataFrame | None
Query new microgrid data and write the updated buffer to a temp file.
Reads the last timestamp from the main buffer file, queries for new data, and writes the combined data to a new temporary buffer file.
| PARAMETER | DESCRIPTION |
|---|---|
microgrid_id
|
The ID of the microgrid to query.
TYPE:
|
components
|
The component types to include in the query. |
metric
|
The metric to query.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
DataFrame | None
|
A pandas DataFrame with only the new data points, or None. |
Source code in src/frequenz/data/microgrid/_stateful_data_fetcher.py
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 | |
rollback ¤
Rollback the temporary files if the transaction fails.
Source code in src/frequenz/data/microgrid/_stateful_data_fetcher.py
Functions:¤
frequenz.data.microgrid.load_configs
async
¤
load_configs(
default_files: (
str | Path | list[str | Path] | None
) = None,
assets_client: AssetsApiClient | None = None,
override_files: (
str | Path | list[str | Path] | None
) = None,
microgrid_ids: list[int] | None = None,
component_graph_config: (
ComponentGraphConfig | None
) = None,
) -> AssetsConfig
Load configs from up to three sources and merge them in layers.
Combines up to three sources, listed here from lowest to highest precedence: a default config file layer, the Assets API, and an override config file layer. Higher layers win on conflicts, while lower layers fill in anything the higher ones leave unset. This lets callers pick a strategy by choosing which sources to pass, for example:
default_files+assets_client: files provide defaults that the Assets API overrides.assets_client+override_files: the Assets API provides the base that files override.- all three: the Assets API sits between a default and an override file layer.
The microgrid IDs fetched from the Assets API are microgrid_ids when
given, otherwise the IDs found in the default and override files. This
lets the Assets API layer be used even when no files are given.
| PARAMETER | DESCRIPTION |
|---|---|
default_files
|
Optional path or list of paths to config files forming the lowest-precedence layer. |
assets_client
|
Optional Assets API client. When given, microgrid metadata and formulas are fetched and layered above the default files.
TYPE:
|
override_files
|
Optional path or list of paths to config files forming the highest-precedence layer. |
microgrid_ids
|
Optional explicit microgrid IDs to fetch from the Assets API. When given, these replace the IDs derived from the files, so the Assets API layer can be used without any files. |
component_graph_config
|
How to build the component graph and generate its formulas. See
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
AssetsConfig
|
The merged document. Use |
AssetsConfig
|
file layers may also contribute |
AssetsConfig
|
which the Assets API layer does not provide. |
| RAISES | DESCRIPTION |
|---|---|
ValueError
|
If none of the three sources is provided, if |
Source code in frequenz/gridpool/config/_load.py
37 38 39 40 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 87 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 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 | |