Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pre release v0.1-rc1 #1

Merged
merged 11 commits into from
Oct 20, 2024
Merged

Pre release v0.1-rc1 #1

merged 11 commits into from
Oct 20, 2024

Conversation

wvenialbo
Copy link
Owner

@wvenialbo wvenialbo commented Oct 20, 2024

This pull request introduces the pre-release version v0.1-rc1 of GOES-DL. This release introduces several key features and improvements:

  • Enhanced data access: Simplified and streamlined data retrieval from NOAA archives, allowing users to efficiently download GOES and GridSat-B1 datasets.
  • Improved usability: A user-friendly interface that facilitates easy integration into various scientific workflows.
  • Expanded data support: Support for both second and third-generation GOES satellites, as well as the GridSat-B1 Climate Data Record.

Summary by Sourcery

Release pre-release version v0.1-rc1 of GOES-DL with enhanced data access, improved usability, and expanded data support. Update build scripts to support various build options and add a new example notebook for GridSat-B1 data.

New Features:

  • Introduce a user-friendly interface for easy integration into scientific workflows.
  • Add support for second and third-generation GOES satellites and the GridSat-B1 Climate Data Record.

Enhancements:

  • Simplify and streamline data retrieval from NOAA archives for efficient downloading of GOES and GridSat-B1 datasets.

Build:

  • Update build script to support multiple build options including sdist, wheel, and poetry with and without isolation.

Documentation:

  • Add a new Jupyter notebook example for downloading GridSat-B1 data, providing a comprehensive guide on using the GOES-DL tool.

Copy link

sourcery-ai bot commented Oct 20, 2024

Reviewer's Guide by Sourcery

This pull request introduces the pre-release version v0.1-rc1 of GOES-DL, focusing on enhancing data access, improving usability, and expanding data support. The changes include updates to the build script, modifications to the AWS datasource, README updates, and the addition of a new example notebook for GridSat-B1 data.

User journey diagram for downloading data with GOES-DL

journey
    title User Journey for Downloading Data with GOES-DL
    section Initialize Components
      User -> ProductLocator: Import and initialize
      User -> DatasourceAWS: Import and initialize with locator
      User -> Downloader: Initialize with datasource and locator
    section Download Data
      User -> Downloader: Call get_files with start date
      User -> Downloader: Call get_files with start and end dates
    section Handle Results
      User -> System: Receive data files or empty list
      User -> System: Handle exceptions if any
Loading

Class diagram for DatasourceAWS changes

classDiagram
    class DatasourceAWS {
        +DatasourceCache cache
        +create(locator: tuple[str, ...] | ProductLocator, life_time: float | None): DatasourceAWS
    }
    note for DatasourceAWS "Added static method create with overloads for different locator types"
Loading

File-Level Changes

Change Details Files
Enhanced build script functionality
  • Added more build options including sdist and wheel builds
  • Implemented no-isolation builds for advanced users
  • Added poetry-specific build commands
  • Improved usage instructions and error handling
scripts/build.ps1
Updated AWS datasource implementation
  • Added a static 'create' method with overloads for different parameter types
  • Implemented type hinting for better code readability
src/GOES_DL/datasource/datasource_aws.py
Updated README with improved usage examples and documentation
  • Modified example code to use updated API parameters
  • Added information about GridSat-B1 Climate Data Record support
  • Clarified the general workflow for using GOES-DL
  • Updated information about available data sources
README.md
Added a new example notebook for GridSat-B1 data
  • Created a comprehensive tutorial for downloading GridSat-B1 Climate Data Record
  • Included step-by-step instructions for using GOES-DL with GridSat-B1 data
  • Demonstrated initialization of downloader and data retrieval processes
examples/Download_GridSat_B1_data.ipynb
Added package initialization file
  • Defined package metadata including name and version
  • Set up the package structure for GOES-DL
src/GOES_DL/__init__.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@wvenialbo wvenialbo merged commit b8a1594 into main Oct 20, 2024
0 of 2 checks passed
Copy link
Contributor

deepsource-io bot commented Oct 20, 2024

Here's the code health analysis summary for commits b030c5e..45878a3. View details on DeepSource ↗.

Analysis Summary

AnalyzerStatusSummaryLink
DeepSource Python LogoPython❌ Failure
❗ 37 occurences introduced
🎯 36 occurences resolved
View Check ↗
DeepSource Test coverage LogoTest coverage⚠️ Artifact not reportedTimed out: Artifact was never reportedView Check ↗

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @wvenialbo - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Remember to update the version number in init.py from 'v0.1-rc1' to the appropriate version number for the final release.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

scripts/build.ps1 Show resolved Hide resolved
@wvenialbo wvenialbo deleted the pre-release branch October 20, 2024 09:01
@wvenialbo wvenialbo self-assigned this Oct 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant