Skip to content

Comments

Simplify install instructions and add plotting example#267

Merged
Marenz merged 3 commits intofrequenz-floss:v0.x.xfrom
Marenz:readme-updates
Feb 17, 2026
Merged

Simplify install instructions and add plotting example#267
Marenz merged 3 commits intofrequenz-floss:v0.x.xfrom
Marenz:readme-updates

Conversation

@Marenz
Copy link
Contributor

@Marenz Marenz commented Feb 16, 2026

Remove the hardcoded version from the pip install command — users should just install the latest by default.

Add a matplotlib plotting example at the end of the README showing how to visualize fetched data.

Remove hardcoded version from pip install command and add a
matplotlib plotting example at the end of the README.

Signed-off-by: Mathias L. Baumann <mathias.baumann@frequenz.com>
@github-actions github-actions bot added the part:docs Affects the documentation label Feb 16, 2026
Signed-off-by: Mathias L. Baumann <mathias.baumann@frequenz.com>
cwasicki
cwasicki previously approved these changes Feb 16, 2026
Copy link
Contributor

@cwasicki cwasicki left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some optional comments.

README.md Outdated
import matplotlib.dates as mdates

# Fetch data (see examples above)
data = [
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wouldn't repeat this here but only refer to above.

```
In addition to the default CSV format, individual samples can also be output using the `--format iter` option.

## Plotting data with matplotlib
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe append it directly to the other python sections, i.e. before the CLI tool section.

values = [s.value for s in data]

fig, ax = plt.subplots(figsize=(14, 5))
ax.plot(timestamps, values)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would add a comment here that all of the following customization instructions are optional.

…ional comment

Signed-off-by: Mathias L. Baumann <mathias.baumann@frequenz.com>
@Marenz Marenz added this pull request to the merge queue Feb 17, 2026
Merged via the queue into frequenz-floss:v0.x.x with commit a1d123b Feb 17, 2026
6 checks passed
@Marenz Marenz deleted the readme-updates branch February 17, 2026 12:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

part:docs Affects the documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants