search

geoglows / pygeoglows

A python package of tools coming from the GEOGloWS initiative
https://geoglows.org
BSD 3-Clause "New" or "Revised" License
16 stars 8 forks source link

Time zone index #39

Closed rileyhales closed 4 months ago

rileyhales commented 4 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The update to the geoglows package includes a version increment to 1.7.0, indicating new features and improvements. Enhancements include improved datetime handling in dataframes, expanded function aliases for better usability, and additional functionality in plotting functions, such as dynamically setting timezone labels and calculating decade averages for flow data. These changes refine data integrity, usability, and analytical capabilities of the package.

Changes

Files Change Summaries
geoglows/__init__.py Version update from 1.6.3 to 1.7.0.
geoglows/_download_decorators.py Enhanced datetime handling, ensuring consistent timezone management across functions.
geoglows/_plots/__init__.py Added alias plotly_figure_to_html_plot for plotly_figure_to_html.
geoglows/_plots/format_tools.py Introduced timezone_label function for formatted timezone strings.
geoglows/_plots/plotly_forecasts.py Improved x-axis timezone labels and hover formats for forecast-related plots.
geoglows/_plots/plotly_retrospective.py Renamed parameters for clarity and added decade averages functionality to annual_averages function.
geoglows/_plots/plots.py Added decade_averages parameter to annual_averages function for enhanced analytical capabilities.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant PlotFunction as Plot Function
    participant TimezoneLabel as timezone_label
    participant DataFrame as DataFrame

    User->>PlotFunction: Call plot function
    PlotFunction->>DataFrame: Get index timezone
    PlotFunction->>TimezoneLabel: Call timezone_label with index timezone
    TimezoneLabel-->>PlotFunction: Return formatted timezone string
    PlotFunction-->>User: Return plot with dynamic timezone label

    Note over PlotFunction, DataFrame: Plot function now dynamically sets x-axis label with timezone info
sequenceDiagram
    participant User
    participant AnnualAverages as annual_averages
    participant DataFrame as DataFrame
    participant PlotlyAnnualAverages as plotly_annual_averages

    User->>AnnualAverages: Call with decade_averages=True
    AnnualAverages->>DataFrame: Extract decade averages (if enabled)
    AnnualAverages->>PlotlyAnnualAverages: Pass data and settings
    PlotlyAnnualAverages-->>AnnualAverages: Return plot
    AnnualAverages-->>User: Return plot with decade averages

    Note over AnnualAverages, DataFrame: New feature calculates and includes decade averages in the plot

Poem

In the code where changes bloom,
Timezones now aligned, no gloom.
Decades marked in flowing streams,
Enhanced plots with data dreams. 🌟
A version rise to one-seven-oh,
Usability and features grow. 🚀

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.