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

Adding scripts for using the NCEDC data stored on s3 #283

Merged
merged 10 commits into from
Feb 12, 2024
Merged

Conversation

kuanfufeng
Copy link
Collaborator

@kuanfufeng kuanfufeng commented Jan 24, 2024

This PR is for adding scripts/functions and a tutorial for using the NCEDC data stored on s3.

  • adding NCEDCS3DataStore by refactoring a base a common base class from SCEDCS3DataStore
  • adding a notebook noisepy_ncedc_tutorial.ipynb for the tutorial

Copy link

codecov bot commented Jan 24, 2024

Codecov Report

Attention: 11 lines in your changes are missing coverage. Please review.

Comparison is base (d8ce19a) 75.81% compared to head (3baf92e) 75.86%.
Report is 1 commits behind head on main.

Files Patch % Lines
src/noisepy/seis/scedc_s3store.py 80.70% 9 Missing and 2 partials ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #283      +/-   ##
==========================================
+ Coverage   75.81%   75.86%   +0.04%     
==========================================
  Files          39       40       +1     
  Lines        4425     4483      +58     
  Branches      603      606       +3     
==========================================
+ Hits         3355     3401      +46     
- Misses        925      934       +9     
- Partials      145      148       +3     

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

Copy link
Collaborator

@carlosgjs carlosgjs left a comment

Choose a reason for hiding this comment

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

See comments about the tests, also please remove the 3 data files that got added.

Copy link
Collaborator

@carlosgjs carlosgjs left a comment

Choose a reason for hiding this comment

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

@kuanfufeng @mdenolle Do you want to add this new notebook to the tutorials/_toc.html? This would make it appear on the docs, but also make sure that it's tested on every PR.

@carlosgjs
Copy link
Collaborator

@kuanfufeng I suggest adding tutorials/ncedc_data to the .gitignore

That will prevent tests data from accidentally getting added to the repo later on.

@kuanfufeng
Copy link
Collaborator Author

kuanfufeng commented Jan 29, 2024

@kuanfufeng I suggest adding tutorials/ncedc_data to the .gitignore

That will prevent tests data from accidentally getting added to the repo later on.

Right, but I saw it has been added by your previous commit. Do you want it updated with tutorials/ncedc_data?

@kuanfufeng
Copy link
Collaborator Author

@kuanfufeng @mdenolle Do you want to add this new notebook to the tutorials/_toc.html? This would make it appear on the docs, but also make sure that it's tested on every PR.

That sounds good. I saw an editing of tutorials/_toc.html in PR284. Would it be better to add it from that branch?

@carlosgjs
Copy link
Collaborator

@kuanfufeng @mdenolle Do you want to add this new notebook to the tutorials/_toc.html? This would make it appear on the docs, but also make sure that it's tested on every PR.

That sounds good. I saw an editing of tutorials/_toc.html in PR284. Would it be better to add it from that branch?

I think it's better to add it here, since this PR is the one adding the notebook and using these data directory. Keeps the PRs more cohesive. E.g. what is #284 ends up not getting merged?

Granted, this will likely require a merge at some point, but will be a pretty simple one.

@kuanfufeng kuanfufeng merged commit c58d6b8 into main Feb 12, 2024
23 checks passed
@kuanfufeng kuanfufeng deleted the kuanfu_ncedc2 branch February 12, 2024 22:54
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.

3 participants