JOSS submission draft

.github/workflows/draft-pdf.yml

@@ -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

doc/source/tracking/paper.md

@@ -0,0 +1,138 @@
+---
+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
+    orcid: 0000-0003-2354-1988
+    affiliation: 2
+  - name: Kelsey Bisson
+    orcid: 0000-0003-4230-3467
+    affiliation: 3
+  - name: Anthony Arendt
+    orcid: 0000-0003-0429-6905
+    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
+  - name: Trey Stafford
+    affiliation: 9
+  - name: Amy Steiker
+    affiliation: 9
+  - name: Tyler Sutterley
+    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
+   index: 2
+ - name: Oregon State University, 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.
+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].
+
+# 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