Skip to content

ESS-2234-2: Improvements to fetching aggregate data#122

Merged
branislav-jenco-4ss merged 6 commits intomasterfrom
ESS-2234-improvements
Jan 19, 2024
Merged

ESS-2234-2: Improvements to fetching aggregate data#122
branislav-jenco-4ss merged 6 commits intomasterfrom
ESS-2234-improvements

Conversation

@branislav-jenco-4ss
Copy link
Copy Markdown
Contributor

@branislav-jenco-4ss branislav-jenco-4ss commented Jan 18, 2024

This PR is related to user story ESS-2234

Description

A couple improvements to the work done on making a method to get aggregate data using the client.

  • allowing an aggregation period input like "min" or "h", with meaning "1min", "1h"
  • specifying the more familiar pandas abbreviations in doc strings
  • adding a progress bar when paging (more like progress "information", as we don't know the total number of samples we're going to fetch"
  • increased the default max_page_size because using 3600 is too low - the overhead for each requests then makes fetching the data overall a lot slower
paging.mp4
paging_jupyter.mp4

Checklist

  • PR title is descriptive and fit for injection into release notes (see tips below)
  • Correct label(s) are used

PR title tips:

  • Use imperative mood
  • Describe the motivation for change, issue that has been solved or what has been improved - not how
  • Examples:
    • Add functionality for Allan variance to sensor_4s.simulate
    • Upgrade to support Python 9.10
    • Remove MacOS from CI

Copy link
Copy Markdown
Contributor

@bjorn-einar-bjartnes-4ss bjorn-einar-bjartnes-4ss left a comment

Choose a reason for hiding this comment

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

Excellent

Copy link
Copy Markdown
Contributor

@heidi-holm-4ss heidi-holm-4ss left a comment

Choose a reason for hiding this comment

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

minor comment - example of usage in documentation uses "Avg", while docstring now only lists the pandas syntax. Besides that - nice work!

another thought - should example be from 2024 or something so that at least right now its within the last 90 days?

@branislav-jenco-4ss
Copy link
Copy Markdown
Contributor Author

minor comment - example of usage in documentation uses "Avg", while docstring now only lists the pandas syntax. Besides that - nice work!

another thought - should example be from 2024 or something so that at least right now its within the last 90 days?

Good points, fixed :)

@branislav-jenco-4ss branislav-jenco-4ss merged commit 32f6528 into master Jan 19, 2024
@branislav-jenco-4ss branislav-jenco-4ss deleted the ESS-2234-improvements branch January 19, 2024 12:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants