frequenz-floss / frequenz-api-reporting Goto Github PK

The python client should be located in its own repository, which needs to be set up:

• Create new repo frequenz-client-reporting-python (according to https://github.com/frequenz-floss/frequenz-sdk-python/wiki/APIs-stack-and-repositories-structure)
• Configure the repo using repo config as described here: https://frequenz-floss.github.io/frequenz-repo-config-python/

Currently, each metric in _types.py in PR #14 is transformed as follows:
AC_FREQUENCY = metric_sample_pb2.Metric.METRIC_AC_FREQUENCY

Can we automate this based on the .proto files so it is less verbose?

What's needed?

The frequenz-api-common dependency should be updated to v0.6.0

Proposed solution

No response

Use cases

No response

Alternatives and workarounds

No response

Additional context

No response

What's needed?

Users could get more control about resampling:

• aggregation: how to aggregate the data points in the interval, e.g. mean, sum, min/max, interpolation (upsampling)
• closed: left or right closed interval, i.e. ts1 <= ts < ts2 or ts1 < ts <= ts2
• label: which timestamp is assigned to the resampled interval, e.g. oldest, newest, average
• resolution (update): the resolution parameter currently does not support resampling periods smaller than 1s.

Proposed solution

Support corresponding parameters in ResamplingOptions.

Use cases

Different aggregations make sense if metrics like energy (sum) or peak values (min/max) are of interest.

Different closed options could be helpful if data is compared with external data that could use another interval definition (e.g. DSO, clients).

label is required if the closed option is changed to avoid weird timestamps.

Resolutions below 1s could be interesting if faster reaction is needed or very short-term forecasts. Since we plan to make resampling mandatory when aggregating components, the shortest resolution would be 1s for component aggregations.

Alternatives and workarounds

No response

Additional context

Related to:

• https://github.com/frequenz-floss/frequenz-api-reporting/pull/6/files#r1406818990
• https://github.com/frequenz-floss/frequenz-api-reporting/pull/6/files#r1406683395
• https://github.com/frequenz-floss/frequenz-api-reporting/pull/6/files#r1406864775

Example for resampling options in pandas: https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.resample.html