+ "markdown": "---\ntitle: Earthdata Cloud Cookbook Python Notebook Template (Quarto)\nauthors:\n - name: \"Albert Einstein\"\n orcid: XXXX....\n email: albert@science.org\n affiliation: University of Relativity\n - name: \"Marie Curie\"\n orcid: XXXX....\n email: marie@science.org\n affiliation: University of Radioactivity\ndate: \"YYYY-MM-DD\" # Last modified date. `last-modified` automatically generates the date when the doc gets rendered, but when rendering on GitHub Actions it will show the render date. (#336)\nkeywords: [sea-ice, netcdf, xarray]\nformat: \n html: default\n ipynb: default # Adds a Jupyter Notebook download button in the right menu\n\n# TODO: Add nasa-metadata as a custom field for providing NASA-specific metadata\n# #441\n---\n\n## Overview\n\nIf you have an introductory paragraph, lead with it here! Keep it short and tied to your material. \nThis is also a great place to add a relevant image.\n\nIf it works for your material, a great way to frame things is to use the [**POP**](https://rockwoodleadership.org/pop-everything-strategic-planning-in-30-seconds-or-less/) (Purpose, Outcomes, Process) framework:\n\n- **Purpose:** What is the motivation for this tutorial? What problem does it solve?\n- **Outcomes:** quick notes on what you'll learn and where the tutorial ends\n- **Process:** maybe a time estimate, and/or where it was first taught?\n\n## Learning objectives\n\nList the main learning objectives here.\n\n## Prerequisites\n\nFollowing your overview, tell your reader what concepts, packages, or other background information they'll **need** before learning your material. Tie this explicitly with links to other pages here in Foundations or to relevant external resources. Remove this body text, then populate the Markdown table, denoted in this cell with `|` vertical brackets, below, and fill out the information following. In this table, lay out prerequisite concepts by explicitly linking to other Foundations material or external resources, or describe generally helpful concepts.\n\nLabel the importance of each concept explicitly as **helpful/necessary**.\n\n| Concepts | Importance | Notes |\n| --- | --- | --- |\n| [Intro to earthaccess](https://earthaccess.readthedocs.io/en/stable/quick-start/) | Necessary | Required for accessing NASA Earthdata Cloud resources |\n| [Understanding of NetCDF](https://foundations.projectpythia.org/core/data-formats/netcdf-cf) | Helpful | Familiarity with metadata structure |\n| Project management | Helpful | |\n\n- **Time to learn**: estimate in minutes. For a rough idea, use 5 mins per subsection, 10 if longer; add these up for a total. Safer to round up and overestimate.\n- **System requirements**:\n - Populate with any system, version, or non-Python software requirements if necessary\n - Otherwise use the concepts table above and the Imports section below to describe required packages as necessary\n - If no extra requirements, remove the **System requirements** point altogether\n\n---\n\n## Imports\nPopulate the following code cell with all necessary Python imports **up-front**:\n\n::: {#bf394ceb .cell execution_count=1}\n``` {.python .cell-code}\nimport sys\n# import earthaccess\n```\n:::\n\n\n## Your first content section\n\nThis is where you begin your first section of material, loosely tied to your objectives stated up front. Tie together your notebook as a narrative, with interspersed Markdown text, images, and more as necessary,\n\n::: {#48d665fa .cell execution_count=2}\n``` {.python .cell-code}\n# as well as any and all of your code cells\nprint(\"Hello world!\")\n```\n\n::: {.cell-output .cell-output-stdout}\n```\nHello world!\n```\n:::\n:::\n\n\n### A content subsection\nDivide and conquer your objectives with Markdown subsections, which will populate the helpful navbar in Jupyter Lab and here in the Cookbook!\n\n::: {#cd882c90 .cell execution_count=3}\n``` {.python .cell-code}\n# some subsection code\na = [1, 2, 3, 4, 5]\n[i + 2 for i in a]\n```\n\n::: {.cell-output .cell-output-display execution_count=3}\n```\n[3, 4, 5, 6, 7]\n```\n:::\n:::\n\n\n### Another content subsection\nKeep up the good work! A note, *try to avoid using code comments as narrative*, and instead let them only exist as brief clarifications where necessary.\n\n## Your second content section\nHere we can move on to our second objective, and we can demonstrate...\n\n### A subsection to the second section\n\n#### a quick demonstration\n\n##### of further and further\n\n###### header levels\n\nCheck out [**the Quarto Guide**](https://quarto.org/docs/guide/) for syntax and guidance on customizing your notebooks. Don't hesitate to ask questions if you have problems getting it to look *just right*.\n\n## Last Section\n\nYou can add [callouts using quarto callout syntax](https://quarto.org/docs/authoring/callouts/) to highlight important information, provide helpful hints, or even just to add some fun and personality to your notebook. Here's an example of a note callout:\n\n:::{.callout-note}\nYour relevant information here!\n:::\n\n:::{.callout-tip}\nA helpful hint.\n:::\n\n:::{.callout-warning}\nBe careful!\n:::\n\nWe also suggest checking out Quarto's [documentation](https://quarto.org/docs/computations/execution-options.html#output-options) on specifying code cell output options.\n\n---\n\n## Summary\nAdd one final `---` marking the end of your body of content, and then conclude with a brief single paragraph summarizing at a high level the key pieces that were learned and how they tied to your objectives. Look to reiterate what the most important takeaways were.\n\n## Additional resources\n\nLink to relevant external material, further reading, documentation, etc.\n\n## References\nBe rigorous in your citations and references as necessary. Give credit where credit is due.\n\nYou're done! Give yourself a quick review, a high five, and send us a pull request. A few final notes:\n\n - `Kernel > Restart Kernel and Run All Cells...` to confirm that your notebook will cleanly run from start to finish\n - `Kernel > Restart Kernel and Clear All Outputs...` before committing your notebook, our machines will do the heavy lifting\n - Take credit! Provide author information in the metadata.\n - Give credit! Attribute appropriate authorship for referenced code, information, images, etc.\n - Only include what you're legally allowed: **no copyright infringement or plagiarism**\n \nThank you for your contribution!\n\n## Acknowledgements\n\nThis template builds from the [Project Pythia Notebook Template](https://github.com/ProjectPythia/cookbook-template/blob/main/notebooks/notebook-template.ipynb), which was in turn inspired by [this template](https://github.com/alan-turing-institute/the-turing-way/blob/master/book/templates/chapter-template/chapter-landing-page.md) of the wonderful [The Turing Way](https://the-turing-way.netlify.app) Jupyter Book.\n\n",
0 commit comments