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

Added a brief mention to QUEST in icepyx docs intro. #514

Merged
merged 17 commits into from
Apr 9, 2024

Conversation

zachghiaccio
Copy link
Contributor

Addressing Task 3 in Issue #474.

Were there any other pages that we wanted to add mention of QUEST? I was thinking maybe the "Origin and Purpose" page, though it's also just a general overview icepyx's conception.

Copy link

github-actions bot commented Feb 26, 2024

Binder 👈 Launch a binder notebook on this branch for commit e3e5a08

I will automatically update this comment whenever this PR is modified

Binder 👈 Launch a binder notebook on this branch for commit 92da5c7

Binder 👈 Launch a binder notebook on this branch for commit a2cb65d

Binder 👈 Launch a binder notebook on this branch for commit 5785c47

Binder 👈 Launch a binder notebook on this branch for commit 3e0dd97

Binder 👈 Launch a binder notebook on this branch for commit c5e0cb9

Binder 👈 Launch a binder notebook on this branch for commit 91f7f8f

Binder 👈 Launch a binder notebook on this branch for commit 5f74220

Binder 👈 Launch a binder notebook on this branch for commit 7700c22

Binder 👈 Launch a binder notebook on this branch for commit 60a04f6

Binder 👈 Launch a binder notebook on this branch for commit e18386d

Binder 👈 Launch a binder notebook on this branch for commit 1b2f563

Binder 👈 Launch a binder notebook on this branch for commit f0387f5

Binder 👈 Launch a binder notebook on this branch for commit 8eef12d

Binder 👈 Launch a binder notebook on this branch for commit f18e35b

Binder 👈 Launch a binder notebook on this branch for commit 1c87139

Binder 👈 Launch a binder notebook on this branch for commit 539f1ad

Copy link

codecov bot commented Feb 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 66.19%. Comparing base (5eb4501) to head (539f1ad).

Additional details and impacted files
@@             Coverage Diff              @@
##           development     #514   +/-   ##
============================================
  Coverage        66.19%   66.19%           
============================================
  Files               36       36           
  Lines             3065     3065           
  Branches           541      541           
============================================
  Hits              2029     2029           
  Misses             945      945           
  Partials            91       91           

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

@zachghiaccio
Copy link
Contributor Author

Add mention to Github readme, and add a link to the QUEST example to Github readme.

@JessicaS11
Copy link
Member

JessicaS11 commented Mar 13, 2024

I was thinking maybe the "Origin and Purpose" page, though it's also just a general overview icepyx's conception.

Agreed - perhaps even as simple as a "(via the QUEST module)" annotation where we're noting "relevant ancillary datasets" in the first paragraph?

Were there any other pages that we wanted to add mention of QUEST?

Would we like to encourage users to cite QUEST specifically within their icepyx citation? This could also be a good opportunity to add the link to citing ArgoVis on our citations page.

EDIT: Citation for ArgoVis and more info on citing Argo data here, in the "Identification of Data Sources" section after the team photos.

Ultimately, we'll want to add some language in the contributing section (probably "Contributing Guidelines" for users adding a new dataset, but I think it would make the most sense to add that when we're also adding the "how to add a new dataset" guide.

@zachghiaccio
Copy link
Contributor Author

Will address suggestions next week, after ST meeting chaos is out of the way.

@JessicaS11 JessicaS11 mentioned this pull request Mar 27, 2024
6 tasks
@zachghiaccio
Copy link
Contributor Author

So are we good to merge this with development?

@JessicaS11
Copy link
Member

So are we good to merge this with development?

If you're good with the updated citation formatting!

@zachghiaccio zachghiaccio merged commit e5fd7d1 into development Apr 9, 2024
8 checks passed
@zachghiaccio zachghiaccio deleted the quest-intro branch April 9, 2024 20:38
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