|
1 | | -[](https://zenodo.org/record/7786710) |
| 1 | +[](https://zenodo.org/record/7786710) |
| 2 | +[](https://codespaces.new/NASA-Openscapes/earthdata-cloud-cookbook?quickstart=1&editor=jupyter) |
2 | 3 |
|
3 | | -[](https://codespaces.new/eeholmes/earthdata-cloud-cookbook?quickstart=1&editor=jupyter) |
| 4 | +# NASA Earthdata Cloud Cookbook |
4 | 5 |
|
5 | | -# Hello! |
| 6 | +**Supporting NASA Earth Science Research Teams' Migration to the Cloud** |
6 | 7 |
|
7 | | -This Earthdata Cloud Cookbook is being developed by the [NASA Openscapes team](https://nasa-openscapes.github.io/). |
| 8 | +The NASA Openscapes Earthdata Cloud Cookbook is a learning resource for |
| 9 | +scientific researchers who use NASA Earthdata as NASA migrates data and |
| 10 | +workflows to the cloud. It is built as a cross-DAAC collaboration by the |
| 11 | +[NASA-Openscapes](https://nasa-openscapes.github.io) team and is under active, |
| 12 | +open development. |
8 | 13 |
|
9 | | -## How to contribute to our book |
| 14 | +**Live site:** [nasa-openscapes.github.io/earthdata-cloud-cookbook](https://nasa-openscapes.github.io/earthdata-cloud-cookbook) |
10 | 15 |
|
11 | | -Information for our team [to contribute to the Cookbook](https://nasa-openscapes.github.io/earthdata-cloud-cookbook/contributing/). This includes setup and workflow instructions. |
| 16 | +--- |
12 | 17 |
|
13 | | -## Hackdays |
| 18 | +## What's in the Cookbook |
14 | 19 |
|
15 | | -In 2023 we are iterating and improving on our original cookbook structure, incorporating current technical approaches and what we've learned teaching NASA colleagues and Earth science researchers. We will increasingly track our tasks and progress using [issues](https://github.com/nasa-openscapes/earthdata-cloud-cookbook) in this repository. We are having ongoing virtual Hackdays ([ongoing notes](https://docs.google.com/document/d/1fzT-iSFlWZLS38eoPmFseljyMKDQIAc-24qH6QpnRCc/edit) and [spreadsheet](https://docs.google.com/spreadsheets/d/10WC19Rrkq7YM1P3cc6qjI8rm8yi7yiYo/edit#gid=877539921)) to focus progress together. |
| 20 | +| Section | Description | |
| 21 | +|---|---| |
| 22 | +| [Our Cookbooks](https://nasa-openscapes.github.io/earthdata-cloud-cookbook/our-cookbooks.html) | Links to DAAC-specific cookbooks (PO.DAAC, NSIDC, ORNL, OB.DAAC, and more) | |
| 23 | +| [Core Concepts](https://nasa-openscapes.github.io/earthdata-cloud-cookbook/cloud_paradigm.html) | Conceptual background on cloud computing for Earth science | |
| 24 | +| [Tutorials](https://nasa-openscapes.github.io/earthdata-cloud-cookbook/tutorials/) | End-to-end, learn-by-doing workflows (hurricanes, sea level rise, carbon stocks, and more) | |
| 25 | +| [How-To Guides](https://nasa-openscapes.github.io/earthdata-cloud-cookbook/how-tos/) | Goal-oriented recipes for finding, accessing, and working with data | |
| 26 | +| [Reference](https://nasa-openscapes.github.io/earthdata-cloud-cookbook/appendix/) | Glossary, cheatsheets | |
16 | 27 |
|
17 | | -Hackdays: |
| 28 | +## Quick Start |
18 | 29 |
|
19 | | -- February 2, 2023 |
20 | | -- March 2, 2023 |
21 | | -- March 30, 2023 |
22 | | -- May 10, 2023 |
| 30 | +You can follow along the examples provided on the cookbook or run them locally |
| 31 | +download the [corn environment.yml](https://github.com/NASA-Openscapes/corn/blob/main/ci/environment.yml) |
| 32 | +from the NASA-Openscapes JupyterHub base image and create a conda environment: |
23 | 33 |
|
24 | | -### Hackday 4 Summary |
| 34 | +```bash |
| 35 | +conda env create -f environment.yml |
| 36 | +conda activate nasaopenscapes_env |
| 37 | +``` |
25 | 38 |
|
26 | | -This was our first Hackday "opening up" to folks beyond the NASA Mentors. Thanks Owen Littlejohns for joining and contributing! |
| 39 | +## Key Tool: earthaccess |
27 | 40 |
|
28 | | -- OPeNDAP: Cassie & Chris added OPeNDAP access to how-do-i > access data > if I’m local |
29 | | -Merged branch into cookbook main! https://github.com/NASA-Openscapes/earthdata-cloud-cookbook/pull/202#pullrequestreview-1421457010 |
| 41 | +The [**earthaccess**](https://earthaccess.readthedocs.io/en/latest/) Python |
| 42 | +library streamlines access to NASA Earthdata locally or in the cloud and is |
| 43 | +used throughout this Cookbook. |
30 | 44 |
|
31 | | -- harmony-py: Amy and Owen added Harmony to how-do-i > subset data https://github.com/NASA-Openscapes/earthdata-cloud-cookbook/pull/187/commit s . Nearly ready to merge but zoom screensharing stopped |
| 45 | +```python |
| 46 | +import earthaccess |
| 47 | +earthaccess.login() |
| 48 | +``` |
32 | 49 |
|
| 50 | +## Contributing |
33 | 51 |
|
34 | | -### **Hackday 3 Summary** |
| 52 | +We welcome contributions from the community. See the [Contributing |
| 53 | +Guide](https://nasa-openscapes.github.io/earthdata-cloud-cookbook/contributing/) |
| 54 | +for setup instructions, workflows, and notebook templates. |
35 | 55 |
|
36 | | -Brief planning check-in and then mostly worked in breakouts the whole time - |
| 56 | +## Citation |
37 | 57 |
|
38 | | -- OPeNDAP tutorial (Chris) - goal to not use pyDAP, instead earthaccess/Xarray and Zarr. |
| 58 | +Please cite this resource using the Zenodo DOI: |
| 59 | +[10.5281/zenodo.7786710](https://doi.org/10.5281/zenodo.7786710). This DOI |
| 60 | +always resolves to the latest version. |
39 | 61 |
|
40 | | - - Progress: Added auth steps and CMR query. [Notebook](https://github.com/NASA-Openscapes/earthdata-cloud-cookbook/blob/177-opendap-tutorials/how-tos/working-with-data-in-cloud/Earthdata_Cloud__Data_Access_OPeNDAP_Example.ipynb); [issue #177](https://github.com/NASA-Openscapes/earthdata-cloud-cookbook/issues/177) |
| 62 | +> Andy Barrett, Chris Battisto, Brandon Bottomley, Aaron Friesz, Alexis |
| 63 | +> Hunzinger, Mahsa Jami, Alex Lewandowski, Bri Lind, Luis López, Jack McNelis, |
| 64 | +> Cassie Nickles, Catalina Oaida Taglialatela, Celia Ou, Brianna Pagán, Sargent |
| 65 | +> Shriver, Amy Steiker, Michele Thornton, Makhan Virdi, Jessica Nicole Welch, |
| 66 | +> Jess Welch, Erin Robinson, Julia Stewart Lowndes. (2023). |
| 67 | +> NASA-Openscapes/earthdata-cloud-cookbook: NASA EarthData Cloud Cookbook |
| 68 | +> v2023.03.0. Zenodo. https://doi.org/10.5281/zenodo.7786711 |
41 | 69 |
|
42 | | -- How-Tos: Harmony-py subset example with PO.DAAC data (Amy) |
43 | | - |
44 | | - - Progress: Pushed work-in-progress to branch, [draft PR](https://github.com/NASA-Openscapes/earthdata-cloud-cookbook/pull/187) |
45 | | - |
46 | | -- How-Tos: Populated \"access data\"; created \"read data\" for python. (Cassie & Andy) |
47 | | - |
48 | | - - Progress: [merged PR](https://github.com/NASA-Openscapes/earthdata-cloud-cookbook/pull/190) |
49 | | - |
50 | | - - Next steps: Tagging R people fill in their wisdom - please go through and populate some of the R parts |
51 | | - |
52 | | -- Tutorials: Import AppEEARS tutorial (Mahsa & Julie) |
53 | | - |
54 | | - - Progress: successful import and [draft PR](https://github.com/NASA-Openscapes/earthdata-cloud-cookbook/pull/189) |
55 | | - |
56 | | - - Question: not re-import all notebooks each time (see draft PR) |
57 | | - |
58 | | -- Tutorials: earthaccess walk-through (Jess). Shared workflow with Luis (conversation below). Focus: how to use earthaccess outside the JupyterHub |
59 | | - |
60 | | -- Get-Started section (Jess) - reviewed [old chapters commented out in quarto_yml](https://github.com/NASA-Openscapes/earthdata-cloud-cookbook/blob/188cfd30dfff6573c65af371cda171a46adb5841/_quarto.yml#L87-L91) to see how to incorporate/delete. |
61 | | - |
62 | | - - Progress: notes/suggestions below |
63 | | - |
64 | | - - Next steps: review & do! |
65 | | - |
66 | | -- Environments chapter (Erin) started, notes here: [#186](https://github.com/NASA-Openscapes/earthdata-cloud-cookbook/pull/186) |
67 | | - |
68 | | -- DOI, Zenodo, Citation, Documentation (Stef) - Deposit in Zenodo & get DOI for cookbook [#178](https://github.com/NASA-Openscapes/earthdata-cloud-cookbook/issues/178). Added DOI badge to README: [commit](https://github.com/NASA-Openscapes/earthdata-cloud-cookbook/commit/4a825bf8b7fe1dd476019704f107449cc3e76177) |
69 | | - |
70 | | - - woohoo <https://zenodo.org/record/7786711> |
71 | | - |
72 | | - - Next steps: review pull request for citation text:[ #191](https://github.com/NASA-Openscapes/earthdata-cloud-cookbook/pull/191) |
73 | | - |
74 | | - - Next steps: create Openscapes Zenodo Community (a là [NASA TOPS](https://zenodo.org/communities/tops/) & add Cookbook et al there) |
75 | | - |
76 | | - |
77 | | -### **Hackday 2 Summary** |
78 | | - |
79 | | -At our 2nd hackday we had a brief overview of cookbook progress since we'd last met before working in breakout groups together. In this session: |
80 | | - |
81 | | -- Updated the importer function by adding .md capability and rethinking storing copies of notebooks bc will get out of sync ([commit](https://github.com/NASA-Openscapes/earthdata-cloud-cookbook/commit/540e30545062dc6528f57aa9e1a83a9b66a46fe2)) (Cassie+Luis) |
82 | | - |
83 | | -- added CC-BY [license](https://github.com/NASA-Openscapes/earthdata-cloud-cookbook/blob/main/LICENSE.md) and added [license text to page footer](https://github.com/NASA-Openscapes/earthdata-cloud-cookbook/commit/6841a703346eeb3e93d798a6f7e244df792cfac5) (Erin+Stef) |
84 | | - |
85 | | -- Planned How-Tos restructure through organization & level of granularity on left and right nav ([draft PR](https://github.com/NASA-Openscapes/earthdata-cloud-cookbook/pull/182)) (Andy, Catalina, Mahsa, Alexis, Julie) |
86 | | - |
87 | | -- Update and add Cloud OPeNDAP tutorials ([issue](https://github.com/NASA-Openscapes/earthdata-cloud-cookbook/issues/177)) (Chris, Michele) |
88 | | - |
89 | | -- Reviewing earthaccess tutorial in cookbook to parse and point to the docs; also [how to sync a forked repo](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork#syncing-a-fork-branch-from-the-command-line) via cmd line (Jess) |
90 | | - |
91 | | -### **Progress following Hackday 1** |
92 | | - |
93 | | -- [\_CookbookTutorialsInventory_Feb_2023.xlsx](https://docs.google.com/spreadsheets/d/10WC19Rrkq7YM1P3cc6qjI8rm8yi7yiYo/edit#gid=877539921) that Catalina made to identify Tutorials in the Cookbook and track decisions and progress for updating; and [Imported Cloud Hackathon Tutorials](https://github.com/NASA-Openscapes/earthdata-cloud-cookbook/pull/176) so this content is available to modernize in the cookbook |
94 | | - |
95 | | -- [Reorg How-Tos structure as "How Do I..."](https://nasa-openscapes.github.io/earthdata-cloud-cookbook/how-tos/) - the work that Andy led to restructure the How-Tos structure to be more goal-oriented |
96 | | - |
97 | | -- [Cookbook GitHub Issues](https://github.com/NASA-Openscapes/earthdata-cloud-cookbook/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) - began organizing ideas in Issues |
| 70 | +## License |
98 | 71 |
|
| 72 | +All materials are publicly available under a [CC-BY license](LICENSE.md), |
| 73 | +adapted from [The Turing Way](https://github.com/alan-turing-institute/the-turing-way/blob/master/LICENSE.md). |
0 commit comments