plotter_data_preparer
frequenz.lib.notebooks.solar.maintenance.plotter_data_preparer ¤
Module for preparing data for various plot types.
This module provides classes for preparing the data for plotting as well as
generating production statistics. Each class is designed to work with a specific
plot type from the plotter
module and uses configurations defined in the
plotter_config
module.
CLASS | DESCRIPTION |
---|---|
- `BasePreparer` |
Abstract base class for data preparers. |
- `CalendarPreparer` |
Prepares data for calendar view plots. |
- `RollingPreparer` |
Prepares data for rolling view plots. |
- `ProfilePreparer` |
Prepares data for statistical profile plots. |
- `DailyPreparer` |
Prepares data for daily production plots. |
- `StatsPreparer` |
Generates production statistics. |
Classes¤
frequenz.lib.notebooks.solar.maintenance.plotter_data_preparer.BasePreparer ¤
Bases: ABC
Abstract base class for preparing data for plotting.
Source code in frequenz/lib/notebooks/solar/maintenance/plotter_data_preparer.py
Functions¤
__init__ ¤
__init__(config: Any)
Initialise the data preparer with the configuration.
PARAMETER | DESCRIPTION |
---|---|
config
|
The data preparation configuration.
TYPE:
|
Source code in frequenz/lib/notebooks/solar/maintenance/plotter_data_preparer.py
prepare
abstractmethod
¤
Prepare the data for plotting.
PARAMETER | DESCRIPTION |
---|---|
df
|
The input data to prepare.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
DataFrame | dict[str, DataFrame]
|
A DataFrame with the prepared data. |
RAISES | DESCRIPTION |
---|---|
NotImplementedError
|
If the method is not implemented by the subclass. |
Source code in frequenz/lib/notebooks/solar/maintenance/plotter_data_preparer.py
frequenz.lib.notebooks.solar.maintenance.plotter_data_preparer.CalendarPreparer ¤
Bases: BasePreparer
Data preparer for calendar view plots.
Source code in frequenz/lib/notebooks/solar/maintenance/plotter_data_preparer.py
Functions¤
__init__ ¤
__init__(config: CalendarViewConfig) -> None
Initialise the data preparer with the configuration.
PARAMETER | DESCRIPTION |
---|---|
config
|
The data preparation configuration for calendar view plots.
TYPE:
|
Source code in frequenz/lib/notebooks/solar/maintenance/plotter_data_preparer.py
prepare ¤
Prepare data for calendar view plots.
PARAMETER | DESCRIPTION |
---|---|
df
|
DataFrame with solar power production data and a datetime index.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
DataFrame
|
A DataFrame with the prepared data for the calendar view plot. |
Source code in frequenz/lib/notebooks/solar/maintenance/plotter_data_preparer.py
frequenz.lib.notebooks.solar.maintenance.plotter_data_preparer.DailyPreparer ¤
Bases: BasePreparer
Data preparer for daily production plots.
Source code in frequenz/lib/notebooks/solar/maintenance/plotter_data_preparer.py
Functions¤
__init__ ¤
__init__(config: DailyViewConfig) -> None
Initialise the data preparer with the configuration.
PARAMETER | DESCRIPTION |
---|---|
config
|
The data preparation configuration for daily view plots.
TYPE:
|
Source code in frequenz/lib/notebooks/solar/maintenance/plotter_data_preparer.py
prepare ¤
Prepare data for daily production plots.
PARAMETER | DESCRIPTION |
---|---|
df
|
DataFrame with solar power production data and a datetime index.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
DataFrame
|
A DataFrame with the prepared data for the daily production plot. |
Source code in frequenz/lib/notebooks/solar/maintenance/plotter_data_preparer.py
frequenz.lib.notebooks.solar.maintenance.plotter_data_preparer.ProfilePreparer ¤
Bases: BasePreparer
Data preparer for statistical production profile plots.
Source code in frequenz/lib/notebooks/solar/maintenance/plotter_data_preparer.py
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 |
|
Functions¤
__init__ ¤
__init__(config: ProfileViewConfig) -> None
Initialise the data preparer with the configuration.
PARAMETER | DESCRIPTION |
---|---|
config
|
The data preparation configuration for statistical view plots.
TYPE:
|
Source code in frequenz/lib/notebooks/solar/maintenance/plotter_data_preparer.py
prepare ¤
Prepare data for statistical production profile plots.
PARAMETER | DESCRIPTION |
---|---|
df
|
DataFrame with solar power production data and a datetime index.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
dict[str, DataFrame]
|
A dictionary containing the prepared data for the statistical |
dict[str, DataFrame]
|
production profile plots. |
Source code in frequenz/lib/notebooks/solar/maintenance/plotter_data_preparer.py
frequenz.lib.notebooks.solar.maintenance.plotter_data_preparer.RollingPreparer ¤
Bases: BasePreparer
Data preparer for rolling view plots.
Source code in frequenz/lib/notebooks/solar/maintenance/plotter_data_preparer.py
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 |
|
Functions¤
__init__ ¤
__init__(config: RollingViewConfig) -> None
Initialise the data preparer with the configuration.
PARAMETER | DESCRIPTION |
---|---|
config
|
The data preparation configuration for rolling view plots.
TYPE:
|
Source code in frequenz/lib/notebooks/solar/maintenance/plotter_data_preparer.py
prepare ¤
Prepare data for rolling view plots.
PARAMETER | DESCRIPTION |
---|---|
df
|
DataFrame with solar power production data and a datetime index.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
DataFrame
|
A DataFrame with the prepared data for the rolling view plot. |
Source code in frequenz/lib/notebooks/solar/maintenance/plotter_data_preparer.py
frequenz.lib.notebooks.solar.maintenance.plotter_data_preparer.StatsPreparer ¤
Bases: BasePreparer
Data preparer for production statistics.
Source code in frequenz/lib/notebooks/solar/maintenance/plotter_data_preparer.py
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 |
|
Functions¤
__init__ ¤
__init__(config: StatsViewConfig) -> None
Initialise the data preparer with the configuration.
PARAMETER | DESCRIPTION |
---|---|
config
|
The data preparation configuration for production statistics.
TYPE:
|
Source code in frequenz/lib/notebooks/solar/maintenance/plotter_data_preparer.py
prepare ¤
Prepare data for production statistics.
PARAMETER | DESCRIPTION |
---|---|
df
|
DataFrame with solar power production data and a datetime index.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
DataFrame
|
A DataFrame with the prepared data for the production statistics. |