Merge pull request #23 from snowex-hackweek/website-readme

Update README.md - Remove template content
snowex-hackweek · Aug 20, 2024 · 85fdfcd · 85fdfcd
2 parents 4017c1d + 85ae702
commit 85fdfcd
Show file tree

Hide file tree

Showing 7 changed files with 11 additions and 91 deletions.
diff --git a/README.md b/README.md
@@ -1,83 +1,3 @@
-# Hackweek Website Template
-<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors-)
-<!-- ALL-CONTRIBUTORS-BADGE:END -->
+# 2024 SnowEx Hackweek
 
-**THIS IS A [TEMPLATE REPOSITORY](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template )** designed to streamline creating two linked websites for a [UW eScience Hackweek](https://uwhackweek.github.io/hackweeks-as-a-service/intro.html):
-
-1. An event landing page built on a [Tech Conference Theme](https://themes.3rdwavemedia.com/demo/bs5/devconf/)
-1. A [JupyterBook](https://jupyterbook.org/) for event content (including tutorials)
-
-We've found that every hackweek benefits from a single-page website to get people's attention and consolidate important logistical details such as the 'who','what','why','when' of an event. In addition, JupyterBook provides a convenient means to consolidate and present tutorials with dynamic content such as executable code and dynamic figures.
-
-## Examples
-
-We've used this template for the following events:
-
-* ICESat-2 Hackweek 2022 + 2023: https://icesat-2.hackweek.io
-* SnowEx Hackweeks (2021, 2022): https://snowex.hackweek.io
-
-
-## How to use this template
-
-You can use this template for your own event!
-
-1. Click the "Use this template" button at the top of the repo
-1. Select the account where you'd like to use the template.
-1. In your new repo, got to Settings --> Pages --> Source = GitHub Actions
-  1. Enter a Custom Domain if you have one, or use the default GitHub Pages URL
-1. There are a few files you'll need to edit to customize content for your event:
-  * `cookiecutter.yaml`:  customize your landing page content
-  * `book/_config.yml`:  customize your JupyterBook content
-  * `README.md`:  a basic description of your project
-  * `CITATION.cff`:  add a standard citation file with all the event organizers
-
-
-## Design
-
-We've designed this template so that you should only have to edit a few files with intuitive syntax. When changes are pushed to GitHub, [continuous integration](./.github/README.md) takes care of converting these files into HTML and publishing the website.
-
-
-### Additional options to consider
-[ReviewNB](https://www.reviewnb.com/) is a great tool for viewing changes in Jupyter Notebooks.
-Someone with admin privileges must activate it for each repository you create from this template.
-To activate:
-
-1. Go to [reviewnb.com](https://www.reviewnb.com/).
-1. Select the "Connect to GitHub" button.
-1. Select "+/- REPOSITORIES" from the menu or bottom of the page.
-1. Choose the organization where your repo lives.
-1. Toggle the "Only select repositories" button and choose your repo from the dropdown.
-1. Select "Install".
-
-Great! Now ReviewNB will post a rich-diff of your notebooks each time a PR is opened.
-
-
-## How to contribute
-
-We are always trying to improve upon this template for future events and welcome contributions. Have a look at our [code of conduct](./CODE_OF_CONDUCT.md) and [contributing guide](./CONTRIBUTING.md).
-
-
-## Contributors ✨
-
-Thanks for this template goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
-
-<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
-<!-- prettier-ignore-start -->
-<!-- markdownlint-disable -->
-<table>
-  <tr>
-    <td align="center"><a href="http://scottyhq.github.io"><img src="https://avatars.githubusercontent.com/u/3924836?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Scott Henderson</b></sub></a><br /><a href="#eventOrganizing-scottyhq" title="Event Organizing">📋</a> <a href="https://github.com/uwhackweek/jupyterbook-template/commits?author=scottyhq" title="Code">💻</a> <a href="#ideas-scottyhq" title="Ideas, Planning, & Feedback">🤔</a> <a href="#content-scottyhq" title="Content">🖋</a></td>
-    <td align="center"><a href="http://psc.apl.uw.edu/people/investigators/anthony-arendt/"><img src="https://avatars.githubusercontent.com/u/4993098?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Anthony Arendt</b></sub></a><br /><a href="#eventOrganizing-aaarendt" title="Event Organizing">📋</a> <a href="#ideas-aaarendt" title="Ideas, Planning, & Feedback">🤔</a> <a href="#content-aaarendt" title="Content">🖋</a></td>
-    <td align="center"><a href="https://www.linkedin.com/in/landungsetiawan/"><img src="https://avatars.githubusercontent.com/u/17802172?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Landung "Don" Setiawan</b></sub></a><br /><a href="#eventOrganizing-lsetiawan" title="Event Organizing">📋</a> <a href="#ideas-lsetiawan" title="Ideas, Planning, & Feedback">🤔</a> <a href="#content-lsetiawan" title="Content">🖋</a> <a href="https://github.com/uwhackweek/jupyterbook-template/commits?author=lsetiawan" title="Code">💻</a></td>
-    <td align="center"><a href="https://github.com/JessicaS11"><img src="https://avatars.githubusercontent.com/u/11756442?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Jessica</b></sub></a><br /><a href="https://github.com/uwhackweek/jupyterbook-template/commits?author=JessicaS11" title="Code">💻</a> <a href="#ideas-JessicaS11" title="Ideas, Planning, & Feedback">🤔</a> <a href="#content-JessicaS11" title="Content">🖋</a></td>
-    <td align="center"><a href="https://github.com/jomey"><img src="https://avatars.githubusercontent.com/u/178649?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Joachim Meyer</b></sub></a><br /><a href="https://github.com/uwhackweek/jupyterbook-template/commits?author=jomey" title="Code">💻</a> <a href="#ideas-jomey" title="Ideas, Planning, & Feedback">🤔</a> <a href="#content-jomey" title="Content">🖋</a></td>
-  </tr>
-</table>
-
-<!-- markdownlint-restore -->
-<!-- prettier-ignore-end -->
-
-<!-- ALL-CONTRIBUTORS-LIST:END -->
-
-This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+This is the repository that contains all tutorial content for the 2024 SnowEx Hackweek.
diff --git a/book/tutorials/snowex-core/01_snowex_data_overview.ipynb b/book/tutorials/snowex-core/01_snowex_data_overview.ipynb
@@ -113,11 +113,11 @@
     "![](./content/01_snow-classes-sturm.png)\n",
     "**Figure 3.** Snow Classes across North America at 300 m (Sturm and Liston, 2021) -->\n",
     "\n",
-    "As part of the mission statement, SnowEx aims to quantify snow estimation uncertainty across a range of snow classes, terrain and vegetration types. This is important to determine what areas and time periods have high SWE uncertainty across the ensemble of instrument techniques. \n",
+    "As part of the mission statement, SnowEx aims to quantify snow estimation uncertainty across a range of snow classes, terrain and vegetation types. This is important to determine what areas and time periods have high SWE uncertainty across the ensemble of instrument techniques. \n",
     "\n",
     "    \n",
     "![](./content/01_map-n-barchart.png)\n",
-    "**Figure 2.** Map of the in situ field visits for the duration of SnowEx field campaigns (2017-2023). At this scale, points are overlapping, especially in the eastern Rocky Mountain region around Colorado. The total number of unique visits with recorded SWE are listed in the legend. Upper Right Bar chart of snow classes over the four SnowEx field campagin years. Counts represent in situ field visits. A range of sites in Boreal and Montane Forests occured in open areas such as meadows and clearings. The snow classification colors match those used in [Sturm and Liston, 2021](https://journals.ametsoc.org/view/journals/hydr/22/11/JHM-D-21-0070.1.xml).\n",
+    "**Figure 2.** Map of the in situ field visits for the duration of SnowEx field campaigns (2017-2023). At this scale, points are overlapping, especially in the eastern Rocky Mountain region around Colorado. The total number of unique visits with recorded SWE are listed in the legend. Upper Right Bar chart of snow classes over the four SnowEx field campaign years. Counts represent in situ field visits. A range of sites in Boreal and Montane Forests occurred in open areas such as meadows and clearings. The snow classification colors match those used in [Sturm and Liston, 2021](https://journals.ametsoc.org/view/journals/hydr/22/11/JHM-D-21-0070.1.xml).\n",
     "\n",
     "<!-- ![](./content/01_snow-classes-barchart.png)\n",
     "**Figure 2.** Bar chart of snow classes over the four SnowEx field campagin years. Counts represent in situ field visits. A range of sites in Boreal and Montane Forests occured in open areas such as meadows and clearings. The snow classification colors match those used in [Sturm and Liston, 2021](https://journals.ametsoc.org/view/journals/hydr/22/11/JHM-D-21-0070.1.xml).  -->\n",

diff --git a/book/tutorials/snowex_database/1_getting_started_example.ipynb b/book/tutorials/snowex_database/1_getting_started_example.ipynb
@@ -11,7 +11,7 @@
     "\n",
     "__Tutorial Author Micah_o__: [Micah Johnson](https://github.com/micahjohnson150)\n",
     "\n",
-    "[SnowEx](https://snow.nasa.gov/campaigns/snowex) has introduced a unique opportunity to study SWE in a way thats unprecedented, but with more data comes new challenges. \n",
+    "[SnowEx](https://snow.nasa.gov/campaigns/snowex) has introduced a unique opportunity to study SWE in a way that's unprecedented, but with more data comes new challenges. \n",
     "\n",
     "![examples](./images/data_examples.png)\n",
     "\n",
@@ -55,7 +55,7 @@
     "* AND NOW WITH API!\n",
     "\n",
     "\n",
-    "### So whats the catch?\n",
+    "### So what's the catch?\n",
     "New tech can create barriers...\n",
     "\n",
     "```{figure} ./images/pits_not_bits.jpg\n",

diff --git a/book/tutorials/snowex_database/3_forming_queries.ipynb b/book/tutorials/snowex_database/3_forming_queries.ipynb
@@ -107,7 +107,7 @@
    "source": [
     "from snowexsql.api import PointMeasurements\n",
     "\n",
-    "# Instatiate the class to use the properties!\n",
+    "# Instantiate the class to use the properties!\n",
     "measurements = PointMeasurements()\n",
     "\n",
     "# Get the unique data names/types in the table\n",

diff --git a/book/tutorials/snowex_database/4_get_spiral_example.ipynb b/book/tutorials/snowex_database/4_get_spiral_example.ipynb
@@ -4,12 +4,12 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Excercise: Visualize a Manual Depth Spiral\n",
+    "# Exercise: Visualize a Manual Depth Spiral\n",
     "\n",
     "During the SnowEx campaigns a TON of manual snow depths were collected, past surveys for hackweek showed an overhelming interest in the manual \n",
     "snow depths dataset. This tutorial shows how easy it is to get at that data in the database while learning how to build queries\n",
     "\n",
-    "**Goal**: Visualize a small subset of snow depth, ideally a full spiral (mostly cause theyre cool!)\n",
+    "**Goal**: Visualize a small subset of snow depth, ideally a full spiral (mostly cause they are cool!)\n",
     "\n",
     "**Approach**: \n",
     "1. Determine the necessary details for isolating manual depths\n",

diff --git a/book/tutorials/snowex_database/5_plot_raster_example.ipynb b/book/tutorials/snowex_database/5_plot_raster_example.ipynb
@@ -21,7 +21,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "# import in the raster measurments class\n",
+    "# import in the raster measurements class\n",
     "from snowexsql.api import RasterMeasurements\n",
     "from datetime import datetime \n",
     "from rasterio.plot import show\n",

diff --git a/book/tutorials/snowex_database/6_wrap_up.ipynb b/book/tutorials/snowex_database/6_wrap_up.ipynb
@@ -32,7 +32,7 @@
     "\n",
     "Big thanks to all the dedicated scientists who went out and collected these invaluable datasets. \n",
     "\n",
-    "A huge thanks to HP Marshall who originally gave us the opportunity to build this a couple years ago. And thanks to Joe Meyer who pursued funding to develop it futher. Buy them a beer or better yet volunteer for field work to hang out with them! \n",
+    "A huge thanks to HP Marshall who originally gave us the opportunity to build this a couple years ago. And thanks to Joe Meyer who pursued funding to develop it further. Buy them a beer or better yet volunteer for field work to hang out with them! \n",
     "\n",
     "❄️ **Go forth and snow science!** ❄️"
    ]