v0.4.0

Tooling Library for Notebooks Release Notes

Summary

Upgrading

New Features

• Improved MIME type detection for email attachments, with a fallback for unknown file types.
• Introduced a new alerts module for generating and formatting alert emails.
• Added basic Alert and Solar Maintenance notebooks with instructions in English and German. These notebooks are aimed for running in a Deepnote project as they contain Deepnote related UI elements but they can also run in a common jupyter environment if the Deepnote UI elements are discarded.

Bug Fixes

What's Changed

• Refactor Email Notification and Improve Attachment Handling by @cyiallou in #38
• Open source basic Alert and Solar Notebooks by @cyiallou in #30

Full Changelog: v0.3.0...v0.4.0

v0.3.0

Tooling Library for Notebooks Release Notes

Summary

Upgrading

• Made the MicrogridConfig reader tolerant to missing ctype fields, allowing collection of incomplete microgrid configs.
• Formula configs are now defined per metric to support different formulas for each metric in the same config file.
  This is a breaking change which requires updating the formula fields in the config file.
• Default formulas are defined for AC active power and battery SoC metrics.
  The default SoC calculation uses simple averages and ignore different battery capacities.
• The cids method is changed to support getting metric-specific CIDs which in this case are extracted from the formula.

New Features

Bug Fixes

What's Changed

• Allow missing ctype field in microgrid config by @cyiallou in #27
• Update repo config to v0.12.3 by @cyiallou in #29
• Bump nox from 2024.10.9 to 2025.2.9 by @dependabot in #32
• Add back mkdocstrings dependencies and add default pytest options by @cyiallou in #36
• Fix flake8 issues by @cyiallou in #37
• Bump the required group across 1 directory with 8 updates by @dependabot in #35
• Support metric dependent formulas by @cwasicki in #28

Full Changelog: v0.2.1...v0.3.0

v0.2.1

Tooling Library for Notebooks Release Notes

Summary

Renamed the "load" component type to "consumption" for clarity.

Upgrading

If your code references "load" as a component type, update it to "consumption".

New Features

Bug Fixes

What's Changed

• Bump the required group with 4 updates by @dependabot in #21
• Reset release notes after release by @cyiallou in #20
• Bump isort from 5.13.2 to 6.0.0 by @dependabot in #24
• Update black dependency to v25.1.0 by @cyiallou in #25
• Rename "load" component type to "consumption" by @cyiallou in #26

Full Changelog: v0.2.0...v0.2.1

v0.2.0

Tooling Library for Notebooks Release Notes

Summary

This release adds new capabilities to MicrogridConfig, including support for location metadata (longitude, latitude, altitude), asset configuration for tracking metadata of components like PV, wind, and battery, and the ability to retrieve component IDs by category (e.g., "meter" or "inverter").

Upgrading

New Features

• Added options to add microgrid location metadata to MicrogridConfig (longitude, latitude, altitude).
• Added support for component_category in the component_type_ids method of MicrogridConfig, allowing retrieval of IDs for specific categories (e.g., "meter", "inverter", and "component").
• Added assets config to MicrogridConfig, which can be used to track metadata for assets like pv, wind and battery.

Bug Fixes

What's Changed

• Update module docstring by @cyiallou in #12
• Create examples/ dir and move example notebook there by @cyiallou in #13
• Reset release notes by @cyiallou in #14
• Add location metadata to MicrogridConfig by @cyiallou in #15
• Support component_category in type IDs retrieval by @cyiallou in #16
• Add assets config to microgrid config by @cwasicki in #17
• Add tests for microgrid config module by @cyiallou in #18
• Add summary for release by @cyiallou in #19

Full Changelog: v0.1.0...v0.2.0

v0.1.0

Tooling Library for Notebooks Release Notes

Summary

This is the first release of the library with the Solar Maintenance App! 🎉
The repo provides tools to monitor and maintain solar energy systems with the following key features:

• Data Fetching and Processing: Retrieve and preprocess weather and solar production data from external APIs (frequenz-api-weather and frequenz-client-reporting).
• Prediction Model Preparation: Prepare basic time series models for solar power predictions.
• Visualisation Tools: Generate calendar views, rolling averages, production profiles and daily statistics available via the *Plotter classes. Control what/how much data to show and how to display it using the corresponding configuration options. Customise the plots using tools like PlotStyleStrategy and PlotManager.
• Translation Support: Enable English and German translations via the TranslationManager class, for controlling all text displayed on the plots and tables.
• Single Entry Point: Integrate data fetching, processing and visualisations into a main workflow.
• Notification Service: Send alert notifications via email with support for scheduling and retries, including a linear backoff mechanism.

This release provides tools to solar system operators to monitor performance and track trends, and lays the groundwork for identifying potential system issues.

Moreover it includes a microgrid config module that contains component configs to get component IDs and formulas for component types (e.g. PV, battery) and metadata information (e.g. gridpool ID).

What's Changed

• Set up with repo config by @cyiallou in #1
• Add missing repo config files by @cyiallou in #8
• Bump the artifacts group with 2 updates by @dependabot in #2
• Bump actions/cache from 3 to 4 by @dependabot in #3
• Bump actions/setup-python from 4 to 5 by @dependabot in #4
• Bump docker/build-push-action from 5 to 6 by @dependabot in #5
• Bump the required group with 9 updates by @dependabot in #6
• Bump types-markdown from 3.7.0.20240822 to 3.7.0.20241204 by @dependabot in #7
• Add solar maintenance project files by @cyiallou in #9
• Add module for microgrid configs by @cwasicki in #10
• Update license disclaimer by @cyiallou in #11

New Contributors

• @cyiallou made their first contribution in #1
• @dependabot made their first contribution in #2
• @cwasicki made their first contribution in #10

Full Changelog: https://github.com/frequenz-floss/frequenz-lib-notebooks/commits/v0.1.0