v0.12.1

Frequenz Weather API Release Notes

Summary

Upgrading

New Features

Bug Fixes

This release relaxes the API common dependency so it can work up to v1.0.0, as all v0.x versions should be compatible from v0.8.0 on.

What's Changed

• Relax API common dependency to work up to v1.0.0 by @shsms in #209

Full Changelog: v0.12.0...v0.12.1

v0.14.0

Frequenz Weather API Release Notes

Summary

This release contains several updated dependencies.

Upgrading

• Updated protobuf dependency to >= 6.31.1 and < 8. Ensure that the generated code is compatible with the new range to
  avoid cross-version incompatibilities.
• Updated frequenz-api-common package to >= 0.8.0 and < 0.9.0.

New Features

Bug Fixes

What's Changed

• Reset RELEASE_NOTES.md by @TalweSingh in #183
• Update protobuf dependency by @TalweSingh in #184
• Bump pydoclint from 0.6.5 to 0.6.6 by @dependabot[bot] in #177
• Bump the minor group across 1 directory with 10 updates by @dependabot[bot] in #186
• Bump grpc-stubs from 1.53.0.5 to 1.53.0.6 by @dependabot[bot] in #174
• Bump black from 24.4.2 to 25.1.0 by @dependabot[bot] in #175
• Bump the patch group with 3 updates by @dependabot[bot] in #172
• Bump isort from 5.12.0 to 6.0.1 by @dependabot[bot] in #165
• Bump setuptools from 68.1.0 to 80.1.0 by @dependabot[bot] in #176
• Prepare RELEASE_NOTES.md for release by @TalweSingh in #188

Full Changelog: v0.13.0...v0.14.0

v0.13.0

Frequenz Weather API Release Notes

Summary

The package and some fields in the protobuf definitions are renamed.
Aditionally, the historical RPC returns a stream now and forecasts can be
filtered by the forecast horizon.

Upgrading

The weather client and CLI tool are no longer included in this package. To
continue using them, migrate to frequenz-client-weather-python. Follow
the installation and usage instructions provided in the new repository.

• The parameters for the historical RPC changed from creation_start_ts to start_create_time
  and from creation_end_ts to end_create_time.

• Renamed valid_at_ts field to valid_time.

• Renamed creation_ts field to create_time.

• The historical RPC replaced pagination with streaming.

• Instead of forecast_horizon_min and forecast_horizon_max parameter in
  StreamLiveWeatherForecastRequest a new message ForecastHorizon is introduced.

• The package name changed from frequenz.api.weatherforecast.v1 to
  frequenz.api.weather.v1.

New Features

• Added optional ForecastHorizonparameter to StreamHistoricalWeatherForecastRequest
  that allows limiting the forecast horizon of returned forecasts.

Bug Fixes

What's Changed

• Update repo-config to v0.13.1 by @TalweSingh in #157
• Bump pytest-asyncio from 0.25.3 to 0.26.0 by @dependabot[bot] in #167
• Bump pydoclint from 0.3.2 to 0.6.5 by @dependabot[bot] in #169
• Bump the mkdocstrings group with 2 updates by @dependabot[bot] in #163
• Bump setuptools-scm[toml] from 7.1.0 to 8.2.0 by @dependabot[bot] in #164
• Bump nox from 2024.4.15 to 2025.2.9 by @dependabot[bot] in #166
• Bump the patch group with 2 updates by @dependabot[bot] in #161
• Bump actions/checkout from 3 to 4 by @dependabot[bot] in #160
• Replace pagination in historical RPC with streaming and update naming by @TalweSingh in #156
• Add forecast_horizon range to historical RPC by @TalweSingh in #158
• Update protobuf definitions to adhere to AIP-142 standards by @TalweSingh in #171
• Prepare RELEASE_NOTES.md for release by @TalweSingh in #178

Full Changelog: v0.12.0...v0.13.0

v0.12.0

Frequenz Weather API Release Notes

Summary

Moves the client tofrequenz-client-weather-python.

Upgrading

The weather client and CLI tool are no longer included in this package. To
continue using them, migrate to frequenz-client-weather-python. Follow
the installation and usage instructions provided in the new repository.

New Features

Bug Fixes

What's Changed

• Add upsampling to the client by @TalweSingh in #145
• Remove client package from repository by @TalweSingh in #153
• Prepare RELEASE_NOTES.md for new release by @TalweSingh in #154

Full Changelog: v0.11.0...v0.12.0

v0.11.1

Frequenz Weather API Release Notes

Summary

Adds the ability to upsample the forecast data through the client.

New Features

• Add a function to the client to upsample forecast data.

What's Changed

• Add upsampling to the client by @TalweSingh in #145

Full Changelog: v0.11.0...v0.11.1

v0.11.0

Frequenz Weather API Release Notes

Summary

This release updates the repo-config and adds a new field to the request message of the live RPC.

Upgrading

New Features

• Added optional forecast_horizon_min and forecast_horizon_max parameter
  to ReceiveLiveWeatherForecastRequest that allows limiting the forecast
  horizon of returned forecasts. When not specified, forecasts with their
  minimum/maximum available horizon will be returned.

Bug Fixes

What's Changed

• Clear release notes by @shsms in #150
• Update repo-config to v0.10.0 by @TalweSingh in #146
• Fix CI by @TalweSingh in #151
• Add forecast_horizon range to the protobuf definitions by @TalweSingh in #148

Full Changelog: v0.10.0...v0.11.0

v0.10.0

Frequenz Weather API Release Notes

Summary

This release introduces the trading-cli and updates the base-client.

Upgrading

• The minimum required version of frequenz-client-base is now v0.9.0.

• The minimum required version of frequenz-channels is now v1.6.1.

New Features

• Add a new tool to request historical weather data from the command
  line. After installing the package, the trading-cli command can be
  used to request historical weather data for user-defined parameters.
  Replaces the historical forecast example.

What's Changed

• Add CLI tool to request historical weather forecast data by @cwasicki in #142
• Move CLI tool to dedicated folder by @cwasicki in #143
• Upgrade to newest base client by @shsms in #149

Full Changelog: v0.9.0...v0.10.0

v0.9.0

Frequenz Weather API Release Notes

Summary

Upgrading

• The minimum required version of frequenz-client-base is now v0.8.0.

• The Client now expects gRPC URLs to be this format required by the BaseApiClient.

New Features

Bug Fixes

What's Changed

• Clear release notes by @shsms in #136
• Update doc for radiation parameters by @cwasicki in #129
• Update to frequenz-client-base v0.8.0 by @shsms in #140

Full Changelog: v0.8.0...v0.9.0

v0.8.0

Frequenz Weather API Release Notes

Upgrading

• The minimum required version of frequenz-api-common is now v0.6.0.

What's Changed

• Bump docker/build-push-action from 5 to 6 by @dependabot in #122
• Bump pytest from 8.3.2 to 8.3.3 by @dependabot in #134
• Bump brettcannon/check-for-changed-files from 1.2.0 to 1.2.1 by @dependabot in #123
• Clear release notes by @shsms in #133
• Upgrade common API version to v0.6.0 by @shsms in #135

Full Changelog: v0.7.0...v0.8.0

v0.7.0

Frequenz Weather API Release Notes

Upgrading

• The to_array_vlf method now returns an array with the requested shape
  where missing data is set to NaN. This is a change in behavior and
  might require adjustments in the calling code, whereby the previous
  behavior could not be used in a reliable way.

What's Changed

• Change handling of missing data in to_array_vlf method by @cwasicki in #132

Full Changelog: v0.6.0...v0.7.0