Updated Sphinx Docs

blaylockbk · Feb 26, 2021 · c01bd28 · c01bd28
1 parent 4475471
commit c01bd28
Show file tree

Hide file tree

Showing 8 changed files with 1,793 additions and 54 deletions.
diff --git a/README.md b/README.md
@@ -9,8 +9,6 @@
 <!-- Badges -->
 [![](https://img.shields.io/pypi/v/hrrrb)](https://pypi.python.org/pypi/hrrrb/)
 ![](https://img.shields.io/github/license/blaylockbk/HRRR_archive_download)
-![](https://img.shields.io/pypi/dm/hrrrb)
-
 
 |HRRR Archive Website|**http://hrrr.chpc.utah.edu/**|
 |--:|:--|

diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/user_guide/notebooks.doctree b/docs/_build/doctrees/user_guide/notebooks.doctree
diff --git a/docs/_build/html/_sources/user_guide/notebooks.md.txt b/docs/_build/html/_sources/user_guide/notebooks.md.txt
@@ -5,10 +5,12 @@ These notebooks show practical use case of the `hrrrb` package:
 - [Main Package Examples](https://github.com/blaylockbk/HRRR_archive_download/blob/master/notebooks/examples.ipynb)
 - [Make Cartopy maps with HRRR data](https://github.com/blaylockbk/HRRR_archive_download/blob/master/notebooks/demo_plot-on-map-with-common-features.ipynb)
 
-Select variables of the HRRR archive are available in Zarr format (managed by the MesoWest group at the University of Utah). I'm still trying to understand how to use it, but here is a notebook showing my exploring...
+**Zarr:** Select parts of the HRRR archive are available in [Zarr](https://zarr.readthedocs.io/en/stable/) format in the `s3://hrrrzarr` bucket on AWS developed by [Taylor Gowan](https://twitter.com/tayloragowan) and managed by the MesoWest group at the University of Utah. I'm still trying to understand how to use Zarr and haven't added any zarr functionality into `hrrrb`, but here is a notebook showing my zarr exploration...
 - [HRRR in Zarr format](https://github.com/blaylockbk/HRRR_archive_download/blob/master/notebooks/zarr_HRRR.ipynb)
 
-The following notebooks offer a deeper discussion on how the download process works. These are not intended for practical use, but should help illustrate my thought process when I created this package.
+---
+
+The following notebooks offer a deeper discussion on how the GRIB2 download process works. These are not intended for practical use, but should help illustrate my thought process when I created the `hrrrb` package.
 
 - [Part 1: How to download a bunch of HRRR grib2 files (full file)](https://github.com/blaylockbk/HRRR_archive_download/blob/master/notebooks/demo_download_hrrr_archive_part1.ipynb)
 - [Part 2: How to download a subset of variables from a HRRR file](https://github.com/blaylockbk/HRRR_archive_download/blob/master/notebooks/demo_download_hrrr_archive_part2.ipynb)

diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js
diff --git a/docs/_build/html/user_guide/notebooks.html b/docs/_build/html/user_guide/notebooks.html
@@ -224,13 +224,14 @@ <h1>📝 Jupyter Notebooks<a class="headerlink" href="#jupyter-notebooks" title=
 <li class="toctree-l1"><a class="reference external" href="https://github.com/blaylockbk/HRRR_archive_download/blob/master/notebooks/demo_plot-on-map-with-common-features.ipynb">Make Cartopy maps with HRRR data</a></li>
 </ul>
 </div>
-<p>Select variables of the HRRR archive are available in Zarr format (managed by the MesoWest group at the University of Utah). I’m still trying to understand how to use it, but here is a notebook showing my exploring…</p>
+<p><strong>Zarr:</strong> Select parts of the HRRR archive are available in <a class="reference external" href="https://zarr.readthedocs.io/en/stable/">Zarr</a> format in the <code class="docutils literal notranslate"><span class="pre">s3://hrrrzarr</span></code> bucket on AWS developed by <a class="reference external" href="https://twitter.com/tayloragowan">Taylor Gowan</a> and managed by the MesoWest group at the University of Utah. I’m still trying to understand how to use Zarr and haven’t added any zarr functionality into <code class="docutils literal notranslate"><span class="pre">hrrrb</span></code>, but here is a notebook showing my zarr exploration…</p>
 <div class="toctree-wrapper compound">
 <ul>
 <li class="toctree-l1"><a class="reference external" href="https://github.com/blaylockbk/HRRR_archive_download/blob/master/notebooks/zarr_HRRR.ipynb">HRRR in Zarr format</a></li>
 </ul>
 </div>
-<p>The following notebooks offer a deeper discussion on how the download process works. These are not intended for practical use, but should help illustrate my thought process when I created this package.</p>
+<hr class="docutils" />
+<p>The following notebooks offer a deeper discussion on how the GRIB2 download process works. These are not intended for practical use, but should help illustrate my thought process when I created the <code class="docutils literal notranslate"><span class="pre">hrrrb</span></code> package.</p>
 <div class="toctree-wrapper compound">
 <ul>
 <li class="toctree-l1"><a class="reference external" href="https://github.com/blaylockbk/HRRR_archive_download/blob/master/notebooks/demo_download_hrrr_archive_part1.ipynb">Part 1: How to download a bunch of HRRR grib2 files (full file)</a></li>

diff --git a/docs/user_guide/notebooks.md b/docs/user_guide/notebooks.md
@@ -5,10 +5,12 @@ These notebooks show practical use case of the `hrrrb` package:
 - [Main Package Examples](https://github.com/blaylockbk/HRRR_archive_download/blob/master/notebooks/examples.ipynb)
 - [Make Cartopy maps with HRRR data](https://github.com/blaylockbk/HRRR_archive_download/blob/master/notebooks/demo_plot-on-map-with-common-features.ipynb)
 
-Select variables of the HRRR archive are available in Zarr format (managed by the MesoWest group at the University of Utah). I'm still trying to understand how to use it, but here is a notebook showing my exploring...
+**Zarr:** Select parts of the HRRR archive are available in [Zarr](https://zarr.readthedocs.io/en/stable/) format in the `s3://hrrrzarr` bucket on AWS developed by [Taylor Gowan](https://twitter.com/tayloragowan) and managed by the MesoWest group at the University of Utah. I'm still trying to understand how to use Zarr and haven't added any zarr functionality into `hrrrb`, but here is a notebook showing my zarr exploration...
 - [HRRR in Zarr format](https://github.com/blaylockbk/HRRR_archive_download/blob/master/notebooks/zarr_HRRR.ipynb)
 
-The following notebooks offer a deeper discussion on how the download process works. These are not intended for practical use, but should help illustrate my thought process when I created this package.
+---
+
+The following notebooks offer a deeper discussion on how the GRIB2 download process works. These are not intended for practical use, but should help illustrate my thought process when I created the `hrrrb` package.
 
 - [Part 1: How to download a bunch of HRRR grib2 files (full file)](https://github.com/blaylockbk/HRRR_archive_download/blob/master/notebooks/demo_download_hrrr_archive_part1.ipynb)
 - [Part 2: How to download a subset of variables from a HRRR file](https://github.com/blaylockbk/HRRR_archive_download/blob/master/notebooks/demo_download_hrrr_archive_part2.ipynb)