You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-37Lines changed: 16 additions & 37 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,39 +3,34 @@
3
3
# 2020 ICESat-2 Hackweek Tutorials
4
4
Combined repository for the final tutorial material presented at the 2020 ICESat-2 Cryosphere-themed Hackweek presented virtually by the University of Washington from 8-18 June 2020.
5
5
6
-
7
6
## Background
8
-
The [ICESat-2 Cryospheric Science Hackweek](https://icesat-2hackweek.github.io/learning-resources/) was the first virtual Hackweek held by the University of Washington. Originally meant to be a five-day, in-person workshop, organizers quickly regrouped to make the event virtual in light of stay-at-home orders and travel restrictions in place to curb the spread of COVID-19. To accomodate multiple time zones and limit the daily duration of online tutorial sessions, the event was spread out over the course of ten days. The first week had three half-days of interactive tutorials/lectures. The second week had four days that included some interactive tutorials/lectures and scheduled times where instructors were available to help participants with a facilitated exploration of datasets and hands-on software development.
7
+
The [ICESat-2 Cryospheric Science Hackweek](https://icesat-2hackweek.github.io/learning-resources/) was the first virtual Hackweek held by the University of Washington. While originally planned as a five-day, in-person workshop, the event was shifted to a fully virtual/remote setting in light of stay-at-home orders and travel restrictions in place to curb the spread of COVID-19. To accomodate multiple time zones and limit the daily duration of online tutorial sessions, the event was spread out over the course of ten days. The first week had three half-days of interactive tutorials/lectures. The second week had four days that included some interactive tutorials/lectures and scheduled times where instructors were available to help participants with a facilitated exploration of datasets and hands-on software development.
9
8
10
-
Participants learned about the ICESat-2 satellite, sensors, and datasets as well as technologies and tools for accessing and processing ICESat-2 data with a focus on the cryosphere. They also participated in hacking projects.
9
+
Participants learned about the ICESat-2 satellite, sensors, and datasets as well as technologies and tools for accessing and processing ICESat-2 data with a focus on the cryosphere. They also self-organized into teams for hacking projects involving ICESat-2 data.
11
10
12
-
These tutorials were largely developed by volunteer instructors. Each tutorial was prepared and distributed via a topical repository under the [ICESat-2 Hackweek Github organization](https://github.com/ICESAT-2HackWeek). Participants were welcomed to either follow along on the video presentation or clone the repository and run it locally on the provided Pangeo JupyterHub environment created explicitly for the event. This 2020_ICESat-2_Hackweek_Tutorials repository contains the final collection of tutorials presented at the virtual event. It centralizes the final content from the individual tutorial repositories and provides a tagged "release" of the material presented during the hackweek with a DOI for distribution to the larger community. Some of these tutorials may continue to evolve within their respective repositories (links are below).
11
+
These tutorials were largely developed by volunteer instructors. Each tutorial was prepared and distributed via a topical repository under the [ICESat-2 Hackweek Github organization](https://github.com/ICESAT-2HackWeek). Participants followed the live or recorded video of each tutorial, and had the option to clone the repository and interactively run the examples on the Pangeo JupyterHub environment created explicitly for the event.
13
12
13
+
This `2020_ICESat-2_Hackweek_Tutorials` repository contains the final collection of Jupyter notebooks and slides presented at the virtual event. It centralizes the final content from the individual tutorial repositories and provides a tagged "release" of the material presented during the hackweek with a DOI for distribution to the larger community. Most notebooks were rendered to include all output (including embedded plots). These notebooks can be identified by the "\_rendered" at the end of the filename. Some of these tutorials may continue to evolve within their respective repositories (links are below).
14
14
15
15
## Running these tutorials
16
-
During the Hackweek participants worked in a [Pangeo](https://pangeo.io/) environment specifically created for the event and hosted on the AWS us-west-2 hub. The hub included several datasets that are too large to be included within this repository but that are easily and freely availabe from [NSIDC](https://nsidc.org/data/icesat-2) and easily obtained using the [icepyx library](https://icepyx.readthedocs.io/en/latest/). Where possible, code to download the needed data using `icepyx` has been included within each tutorial notebook.
17
-
18
-
**Please note that the tutorials presented here used version 0.2.0 of `icepyx`. These tutorials are set up to use that version in the provided Binder link, but they will not run without edits on more recent versions (>= v0.3.0) of `icepyx` due to non-backwards compatible changes in syntax. Up-to-date data access tutorials/examples are available [from `icepyx`](https://icepyx.readthedocs.io/en/latest/getting_started/example_link.html).**
16
+
During the Hackweek participants worked in a [Pangeo](https://pangeo.io/) environment specifically created for the event and hosted on AWS us-west-2. The JupyterHub included a shared volume with datasets used during some tutorials that are too large to be included within this repository. However, these data are publicly available from [NSIDC](https://nsidc.org/data/icesat-2) and can be easily obtained using the [icepyx library](https://icepyx.readthedocs.io/en/latest/). Where possible, code to download the needed data using `icepyx` has been included within each tutorial notebook.
19
17
20
-
To maximize the utility of this archive, most notebooks, including all those that require large datasets, have been rendered to include outputs. These notebooks can be identified by the "\_rendered" at the end of the filename.
18
+
**Please note that the tutorials presented here used version 0.2.0 of `icepyx`. These tutorials are set up to use that version in the provided Binder link, but they will require modification for more recent versions (>= v0.3.0) of `icepyx`. Up-to-date data access tutorials/examples are available from the `icepyx`[repository](https://github.com/icesat2py/icepyx) and [associated documentation](https://icepyx.readthedocs.io/en/latest/getting_started/example_link.html).**
21
19
22
20
### Re-create the ICEsat-2 Hackweek JupyterLab environment with Binder
23
21
Clicking this button will launch a [binder](https://mybinder.org/) replica of the [JupyterLab computing environment](https://github.com/ICESAT-2HackWeek/jupyterhub-2020) described above. With the exception of those tutorials denoted with an asterisk(\*), this will allow you to run the tutorials presented during the Hackweek. Be aware the session is ephemeral. **Your home directory will not persist, so use this binder only for running tutorials or other short-lived demos!**
Tutorial content is made up of original material modified specifically for the Hackweek by a dedicated team of volunteer instructors. We release these materials with a digital object identifier (DOI) to provide an easy way for both contributors and users to cite their work, given it is not necessarily appropriate for a peer-reviewed journal article publication. If you find these tutorials useful or adapt some of the underlying source code for your research (whether or not you attended the Hackweek), we request that you cite it as:
85
+
## Citation
86
+
This content is original material prepared and/or modified for the Hackweek by a dedicated team of volunteer instructors. We released these materials with a digital object identifier (DOI) to provide an easy way for both contributors and users to cite this material, as it is not necessarily appropriate for a peer-reviewed journal article publication. If you find these tutorials useful and/or adapt some of the underlying source code for your research (whether or not you attended the Hackweek), we request that you *Star* the repository (clicking the button in upper right corner) and cite as:
108
87
109
88
Anthony Arendt, Jessica Scheick, David Shean, Ellen Buckley, Shane Grigsby, Charley Haley, Lindsey Heagy, Yara Mohajerani, Tom Neumann, Johan Nilsson, Thorsten Markus, Fernando Paolo, Fernando Perez, Alek Petty, Axel Schweiger, Ben Smith, Amy Steiker, Sebastian Alvis, Scott Henderson, Nick Holschuh, Zheng Liu, Tyler Sutterley. (2020). ICESAT-2HackWeek/2020_ICESat-2_Hackweek_Tutorials (Version 1.0). Zenodo. http://doi.org/10.5281/zenodo.3966463.
110
89
111
-
With such a large number of contributors completing a diverse array of tasks and at varying career stages (and therefore with a varying level of need for publications), author order was challenging to establish. Here, author order was determined by:
112
-
1.involvement in planning the Hackweek and in preparing this summary repository for release on Zenodo
113
-
2.alphabetical order by last name for tutorial leads and presenters
114
-
3.alphabetical order by last name for other planning team members who did not present
90
+
With such a large number of contributors at varying career stages (with many building publication records) collaboratively working on a diverse array of tasks for this event, author order is somewhat subjective. The author order listed above was determined by:
91
+
1.Involvement in planning the Hackweek and in preparing this repository for release
92
+
2.Alphabetical order by last name for tutorial leads and presenters
93
+
3.Alphabetical order by last name for other planning team members who did not present
115
94
116
-
Special thanks to Yu-Chan and Jane for all of their technical expertise and help in planning and executing the event!
95
+
Special thanks to Yu-Chan Chao (UW APL) and Jane Koh (UW eScience) for all of their technical expertise and help in planning and executing the event!
117
96
118
97
Please click on the Zenodo badge [](https://doi.org/10.5281/zenodo.3966463) for the latest citation information and export options.
119
98
120
-
99
+
## License
121
100
The content of this project is licensed under the [Creative Commons Attribution 3.0 Unported license](https://creativecommons.org/licenses/by/3.0/), and the underlying source code used to format and display that content is licensed under the [MIT license](LICENSE.md).
0 commit comments