-
Notifications
You must be signed in to change notification settings - Fork 107
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
JOSS submission draft #361
Merged
Merged
Changes from 12 commits
Commits
Show all changes
54 commits
Select commit
Hold shift + click to select a range
57797ab
initial commit of paper.md (with example or placeholder text)
JessicaS11 dac12fe
populate author and acknowledge list from github commits
JessicaS11 b44aaf8
add author list and update descriptions
JessicaS11 1b2e993
add temp action for testing pdf compiling
JessicaS11 bbe32f8
add unsaved changes
JessicaS11 7a2ee61
Merge branch 'development' into joss
JessicaS11 af41e24
add IDs and affiliations
JessicaS11 360deff
add id
JessicaS11 39cb6e2
add rest of refs to text
JessicaS11 eb58e46
added affiliation for Romina
RomiP b4fe440
Add placeholder institution to fix draft-pdf CI
weiji14 45307de
Set folder path of paper.pdf to be same as paper.md
weiji14 ec8c834
add Anthony Arendt ORCID
aaarendt 5798063
Merge branch 'development' into joss
JessicaS11 cba0460
added orcid and affiliation
kelseybisson 1892020
Added ORCID, affiliation
zachghiaccio fb4cb37
Fixed affiliation number
zachghiaccio 49ab3d4
Create paper.md
liuzheng-arctic 790fc86
Add orcid for Don Setiawan
lsetiawan c931fdd
added orcid and affiliation for Tian Li
icetianli 2b9bcc7
add about IS2 and ref
JessicaS11 6db0d76
fix author affiliation numbers to remove duplicate
JessicaS11 47478f4
add Friedrich Knuth ORCID
friedrichknuth eab8bf2
Update paper.md
norlandrhagen 0800b8c
add orcid for Shashank
ShashankBice 9cd58a9
Affiliation update for Nitin Ravinder
nitin-ravinder 737602f
adding name, affiliation, and orcid for learn2phoenix (#370)
learn2phoenix 19a03ec
add scott henderson orcid (#371)
scottyhq 2eeb45a
remove authors who did not affirm authorship from list
JessicaS11 b199419
update instution numbering and citation formats
JessicaS11 40ad988
fix typos
JessicaS11 8abf75f
fix ref typo
JessicaS11 95faac3
change name to initial for mystery bib formatting issue
JessicaS11 2d4c612
Apply suggestions from code review
JessicaS11 d29450c
apply comments from review
JessicaS11 33d2c54
GitHub action UML generation auto-update
kelseybisson 115b47f
rewrite sentence from code review
JessicaS11 a172c57
GitHub action UML generation auto-update
weiji14 c357432
add more descriptive title
JessicaS11 d51e88b
fix md formatting issue
JessicaS11 5cdf5d8
add joss bot recommended doi
JessicaS11 2d40766
add rest of Zheng's orcid ID
JessicaS11 5b04e26
Merge branch 'development' into joss
weiji14 88e5116
Remove comment on AGU Fall Meeting 2021 citation
weiji14 2ecdd27
is2 resource guide edits
JessicaS11 5531466
fix bib file for build
JessicaS11 e6e834d
Merge branch 'development' into joss
JessicaS11 16de4be
try with @misc instead of @software in bib file
JessicaS11 62e284c
fix typo in doc/source/tracking/paper.md
JessicaS11 2abf392
Change Wei Ji's affiliation to DevSeed
weiji14 7c0e306
add orcid - Romina
RomiP 85c88b1
remove pdf draft generator required for submission
JessicaS11 7533866
Merge branch 'development' into joss
JessicaS11 2c0600b
editorial updates
JessicaS11 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
on: [push] | ||
|
||
jobs: | ||
paper: | ||
runs-on: ubuntu-latest | ||
name: Paper Draft | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v2 | ||
- name: Build draft PDF | ||
uses: openjournals/openjournals-draft-action@master | ||
with: | ||
journal: joss | ||
# This should be the path to the paper within your repo. | ||
paper-path: doc/source/tracking/paper.md | ||
- name: Upload | ||
uses: actions/upload-artifact@v1 | ||
with: | ||
name: paper | ||
# This is the output path where Pandoc will write the compiled | ||
# PDF. Note, this should be the same directory as the input | ||
# paper.md | ||
path: doc/source/tracking/paper.pdf | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,136 @@ | ||
--- | ||
title: 'icepyx' | ||
tags: | ||
- Python | ||
- ICESat-2 | ||
- LiDAR | ||
- elevation | ||
- community | ||
- cloud | ||
authors: | ||
- name: Jessica Scheick^[Corresponding author] # note this makes a footnote | ||
orcid: 0000-0002-3421-4459 | ||
affiliation: 1 | ||
- name: Wei Ji Leong | ||
JessicaS11 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
orcid: 0000-0003-2354-1988 | ||
affiliation: 2 | ||
- name: Kelsey Bisson | ||
affiliation: 3 | ||
- name: Anthony Arendt | ||
affiliation: 4 | ||
- name: Shashank Bhushan | ||
affiliation: 4 | ||
- name: Zach Fair | ||
affiliation: 5 | ||
- name: Raphael Hagen | ||
affiliation: 4 | ||
- name: Sarah Hall | ||
affiliation: 1 | ||
- name: Scott Henderson | ||
affiliation: 4 | ||
- name: Tom Johnson | ||
affiliation: 6 | ||
- name: Friedrich Knuth | ||
affiliation: 7 | ||
- name: Tian Li | ||
affiliation: 8 | ||
- name: Zheng Liu | ||
affiliation: 4 | ||
- name: Luis Lopez | ||
affiliation: 9 | ||
- name: Romina Piunno | ||
affiliation: 10 | ||
- name: Nitin Ravinder | ||
affiliation: 11 | ||
- name: Landung "Don" Setiawan | ||
affiliation: 4 | ||
lsetiawan marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- name: Trey Stafford | ||
affiliation: 9 | ||
- name: Amy Steiker | ||
affiliation: 9 | ||
- name: Tyler Sutterley | ||
JessicaS11 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
orcid: 0000-0002-6964-1194 | ||
affiliation: 4 | ||
- name: JP Swinski | ||
affiliation: 12 | ||
- name: Bruce Wallin | ||
affiliation: 9 | ||
- name: Learn2Pheonix | ||
affiliation: 13 | ||
|
||
# Note: first three authors are driving the publication. Additional contributors/authors are listed in alphabetical order by last name. Anyone who also contributes substantially to preparing the JOSS submission will be moved into ABC order after the first three and before the non-publication contributors to icepyx. Non-responsive coauthors will be removed from the list since their permission to be included was not granted. | ||
|
||
affiliations: | ||
- name: University of New Hampshire, USA | ||
index: 1 | ||
- name: The Ohio State University, USA | ||
weiji14 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
index: 2 | ||
- name: University of Colorado Boulder, USA | ||
index: 3 | ||
- name: Institution, USA | ||
index: 4 | ||
- name: University of Washington, USA | ||
index: 5 | ||
- name: Institution, USA | ||
index: 6 | ||
- name: Institution, USA | ||
index: 7 | ||
- name: Institution, USA | ||
index: 8 | ||
- name: Institution, USA | ||
index: 9 | ||
- name: University of Toronto, Canada | ||
index: 10 | ||
- name: Institution, USA | ||
index: 11 | ||
- name: Institution, USA | ||
index: 12 | ||
- name: Institution, USA | ||
index: 13 | ||
date: 1 September 2022 | ||
bibliography: icepyx_pubs.bib | ||
|
||
# Optional fields if submitting to a AAS journal too, see this blog post: | ||
# https://blog.joss.theoj.org/2018/12/a-new-collaboration-with-aas-publishing | ||
aas-doi: | ||
aas-journal: | ||
--- | ||
|
||
# Summary | ||
|
||
icepyx is both a software library and a community composed of ICESat-2 data users, developers, maintainers, and the scientific community. | ||
JessicaS11 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
We are working together to develop a shared library of resources - including existing resources, new code, tutorials, and use-cases/examples - that simplify the process of querying, obtaining, analyzing, and manipulating ICESat-2 datasets to enable scientific discovery. | ||
|
||
# Statement of need | ||
|
||
icepyx aims to provide a clearinghouse for code, functionality to improve interoperability, documentation, examples, and educational resources that tackle disciplinary research questions while minimizing the amount of repeated effort across groups utilizing similar datasets. icepyx also hopes to foster collaboration, open-science practices, and reproducible workflows by integrating and sharing resources. | ||
|
||
icepyx began during the cryosphere-themed ICESat-2 Hackweek at the University of Washington in June 2019. At the event, a clear need for a collaborative, shared community space that combined and generalized the tooling (including code and examples past, present, and future) written by Hackweek participants, ICESat-2 Science Team members, and the data user community. This project combined and generalized the existing scripts into a unified framework, adding examples, documentation, and testing where necessary and making them accessible for everyone. The library and community continue to grow and evolve, adding new features and building scientific literacy in open-science, cloud computing, and collaborative development practices. icepyx is now a foundational tool for accessing and working with ICESat-2 data and is featured in multiple scientific publications[@Bisson:2021; @Fernando:2021; @Li:2020], presentations [@js2021agu; @js2020agu; @js2019agu], and Hackweeks [@2022_IS2-HW-tutorials; @2020_IS2-HW-tutorials]. | ||
JessicaS11 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
# Acknowledgements | ||
|
||
We acknowledge funding support from NASA and the University of Washington eScience Institute. | ||
Anthony Arendt, Fernando Perez, Lindsey Heagey, and the Pangeo team provided invaluable support and guidance in establishing this library and welcoming us to the open-source community. | ||
Amy Steiker, Mikala Beig, Nick Kotlinski, Luis Lopez, and many others at the National Snow and Ice Data Center (NSIDC) provide technical support and data access guidance. | ||
The icepyx contributors list also includes many wonderful folks who shared ideas, provided mentoring, and embraced the opportunity to engage in open-science practices while working with ICESat-2 data products. | ||
|
||
<!-- Acknowledgments (non-author contributors) | ||
Nicole Abib | ||
Sebastian Alvis | ||
Mikala Beig | ||
Alex DiBella | ||
Nick K | ||
Ted Maksym | ||
Joachim Meyer | ||
Fernando Perez | ||
Facu Sapienza | ||
David Shean | ||
Trevor Skaggs | ||
Ben Smith | ||
Rachel Tilling | ||
Anna Valentine | ||
Molly Wieringa | ||
Bidhya --> | ||
|
||
|
||
# References |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
GitHub Actions CI has been updated so the draft paper PDF is uploaded as an artifact. Get it by going to the 'Checks' tab at https://github.com/icesat2py/icepyx/pull/361/checks, then
.github/workflows/draft-pdf.yml
, and under 'Artifacts', there should be apaper
link you can click to download a zipfile containing the PDF.For example, the PDF for commit 45307de is at https://github.com/icesat2py/icepyx/actions/runs/2958374263