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

Add tutorials and update documentation #59

Merged
merged 27 commits into from
Aug 16, 2024
Merged

Add tutorials and update documentation #59

merged 27 commits into from
Aug 16, 2024

Conversation

ghiggi
Copy link
Owner

@ghiggi ghiggi commented Jun 26, 2024

Prework

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Documentation
  • Tutorial
  • Code style update
  • Refactor
  • Build-related changes
  • Other, please describe:

Does this PR introduce a breaking change? (check one)

  • Yes
  • No

If yes, please describe the impact and communicate accordingly:

The PR fulfills these requirements:

  • Don't forget to link PR to issue if you are solving one.
  • All tests are passing.
  • New/updated tests are included

Summary

This PR adds the SR/GR matching tutorials.
The repository code has been refactored, new features has been added, test coverage has been increased and the documentation has been improved.
The code has been also adapted to work with numpy 2.0 and python 3.12.

Copy link

codecov bot commented Jun 26, 2024

Codecov Report

Attention: Patch coverage is 98.29932% with 5 lines in your changes missing coverage. Please review.

Project coverage is 93.04%. Comparing base (299b4d8) to head (ad63db5).

Files Patch % Lines
gpm/io/products.py 33.33% 2 Missing ⚠️
gpm/utils/directories.py 97.64% 2 Missing ⚠️
gpm/io/checks.py 85.71% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main      #59      +/-   ##
==========================================
+ Coverage   92.84%   93.04%   +0.19%     
==========================================
  Files         131      130       -1     
  Lines       14223    14268      +45     
==========================================
+ Hits        13205    13275      +70     
+ Misses       1018      993      -25     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@coveralls
Copy link

Coverage Status

coverage: 93.031% (+0.2%) from 92.843%
when pulling 62792b9 on add-tutorials
into 299b4d8 on main.

@coveralls
Copy link

Coverage Status

coverage: 93.031% (+0.2%) from 92.843%
when pulling dc9566d on add-tutorials
into 299b4d8 on main.

@coveralls
Copy link

Coverage Status

coverage: 93.031% (+0.2%) from 92.843%
when pulling dc9566d on add-tutorials
into 299b4d8 on main.

@coveralls
Copy link

Coverage Status

coverage: 93.043% (+0.2%) from 92.843%
when pulling d4f5733 on add-tutorials
into 299b4d8 on main.

@coveralls
Copy link

Coverage Status

coverage: 93.044% (+0.2%) from 92.843%
when pulling a2b0570 on add-tutorials
into 299b4d8 on main.

@coveralls
Copy link

Coverage Status

coverage: 93.04% (+0.2%) from 92.843%
when pulling ad63db5 on add-tutorials
into 299b4d8 on main.

@coveralls
Copy link

coveralls commented Aug 16, 2024

Coverage Status

coverage: 90.466% (-2.4%) from 92.843%
when pulling 245877b on add-tutorials
into 299b4d8 on main.

@ghiggi ghiggi merged commit f44f3e2 into main Aug 16, 2024
25 of 32 checks passed
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.

2 participants