icesat2py / icepyx

Python tools for obtaining and working with ICESat-2 data
https://icepyx.readthedocs.io/en/latest/
BSD 3-Clause "New" or "Revised" License
210 stars 107 forks source link

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

Closed zachghiaccio closed 5 months ago

zachghiaccio commented 7 months ago

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.

github-actions[bot] commented 7 months ago

Binder :point_left: Launch a binder notebook on this branch for commit e3e5a0873e1ea7d88eaf32f43ef1da86602d3348

I will automatically update this comment whenever this PR is modified

Binder :point_left: Launch a binder notebook on this branch for commit 92da5c7901ef80e3b5dbfe1f37a7fcee457bb681

Binder :point_left: Launch a binder notebook on this branch for commit a2cb65d8de51c76eec5d3082a459748ec7469aeb

Binder :point_left: Launch a binder notebook on this branch for commit 5785c478f1c6efc169eaa71b5236af5b2c595511

Binder :point_left: Launch a binder notebook on this branch for commit 3e0dd97e2c95fd1a59186cd4f318fcb2b2b39215

Binder :point_left: Launch a binder notebook on this branch for commit c5e0cb9cd01c09d455a363533f8676904ade5b9d

Binder :point_left: Launch a binder notebook on this branch for commit 91f7f8f7d7e20b3d5e203ee7e108ae3e0abfe012

Binder :point_left: Launch a binder notebook on this branch for commit 5f742209f2bebc95f9b1e37bfd81c5774b447c57

Binder :point_left: Launch a binder notebook on this branch for commit 7700c22eeb5a5398ffe47cbad3397d211aabe698

Binder :point_left: Launch a binder notebook on this branch for commit 60a04f624c1c6f5cf66537dc93780c9549f10cfc

Binder :point_left: Launch a binder notebook on this branch for commit e18386da6b09dc42710c9667b267ade3fff187d0

Binder :point_left: Launch a binder notebook on this branch for commit 1b2f56306c883ec9acd4d195a3e9ce6848d70996

Binder :point_left: Launch a binder notebook on this branch for commit f0387f5330e94c1516dc87023c0fd2338a26e289

Binder :point_left: Launch a binder notebook on this branch for commit 8eef12d938bace79c1f73405fb827ecf59a95449

Binder :point_left: Launch a binder notebook on this branch for commit f18e35bce63e7c98aab45f661f2b09f1a73c59d3

Binder :point_left: Launch a binder notebook on this branch for commit 1c87139267d43327970cd9c42a8c89650be03dcf

Binder :point_left: Launch a binder notebook on this branch for commit 539f1ad70d17f5f7dc743aaa0559da873f33fccc

codecov[bot] commented 7 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

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

Additional details and impacted files ```diff @@ 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 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

zachghiaccio commented 6 months ago

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

JessicaS11 commented 6 months ago

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 commented 6 months ago

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

zachghiaccio commented 6 months ago

So are we good to merge this with development?

JessicaS11 commented 5 months ago

So are we good to merge this with development?

If you're good with the updated citation formatting!