Migrate from hrrrb to herbie-data on PyPi

blaylockbk · Aug 30, 2021 · 8ab0b61 · 8ab0b61
1 parent 6b16640
commit 8ab0b61
Show file tree

Hide file tree

Showing 49 changed files with 37 additions and 34 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -15,7 +15,7 @@
         "button.foreground": "#f0ead2"
     },
     "python.formatting.provider": "black",
-        
+
     "actionButtons": {
         "reloadButton": null,
         "commands": [
@@ -37,5 +37,5 @@
             },
         ],
     },
-    
-}
+
+}
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@
 # Herbie: Retrieve NWP Model Data
 
 <!-- Badges -->
-[![](https://img.shields.io/pypi/v/hrrrb)](https://pypi.python.org/pypi/hrrrb/)
+[![](https://img.shields.io/pypi/v/herbie-data)](https://pypi.python.org/pypi/herbie-data/)
 ![](https://img.shields.io/github/license/blaylockbk/Herbie)
 [![DOI](https://zenodo.org/badge/275214142.svg)](https://zenodo.org/badge/latestdoi/275214142)
 <!-- (Badges) -->
@@ -23,12 +23,14 @@ The [NOAA Big Data Program](https://www.noaa.gov/information-technology/big-data
 Requires cURL and **Python 3.8+** with requests, numpy, pandas, xarray, and cfgrib. Optional packages are matplotlib, cartopy, and [Carpenter Workshop](https://github.com/blaylockbk/Carpenter_Workshop).
 
 ```bash
-pip install hrrrb
-
+pip install herbie-data
+```
+or
+```bash
 pip install git+https://github.com/blaylockbk/Herbie.git
 ```
 
-Or, create the provided [conda environment](https://github.com/blaylockbk/Herbie/blob/master/environment.yml).
+or, create the provided **[conda environment](https://github.com/blaylockbk/Herbie/blob/master/environment.yml)**.
 
 ## Capabilities
 

diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/doctrees/reference_guide/herbie_api.doctree b/docs/_build/doctrees/reference_guide/herbie_api.doctree
diff --git a/docs/_build/doctrees/reference_guide/hrrrb_api.doctree b/docs/_build/doctrees/reference_guide/hrrrb_api.doctree
diff --git a/docs/_build/doctrees/reference_guide/index.doctree b/docs/_build/doctrees/reference_guide/index.doctree
diff --git a/docs/_build/doctrees/user_guide/configure.doctree b/docs/_build/doctrees/user_guide/configure.doctree
diff --git a/docs/_build/doctrees/user_guide/contribute.doctree b/docs/_build/doctrees/user_guide/contribute.doctree
diff --git a/docs/_build/doctrees/user_guide/data_sources.doctree b/docs/_build/doctrees/user_guide/data_sources.doctree
diff --git a/docs/_build/doctrees/user_guide/examples.doctree b/docs/_build/doctrees/user_guide/examples.doctree
diff --git a/docs/_build/doctrees/user_guide/grib2.doctree b/docs/_build/doctrees/user_guide/grib2.doctree
diff --git a/docs/_build/doctrees/user_guide/history.doctree b/docs/_build/doctrees/user_guide/history.doctree
diff --git a/docs/_build/doctrees/user_guide/index.doctree b/docs/_build/doctrees/user_guide/index.doctree
diff --git a/docs/_build/doctrees/user_guide/install.doctree b/docs/_build/doctrees/user_guide/install.doctree
diff --git a/docs/_build/doctrees/user_guide/model_template.doctree b/docs/_build/doctrees/user_guide/model_template.doctree
diff --git a/docs/_build/doctrees/user_guide/notebooks.doctree b/docs/_build/doctrees/user_guide/notebooks.doctree
diff --git a/docs/_build/doctrees/user_guide/notebooks/config.doctree b/docs/_build/doctrees/user_guide/notebooks/config.doctree
diff --git a/docs/_build/doctrees/user_guide/notebooks/data_gfs.doctree b/docs/_build/doctrees/user_guide/notebooks/data_gfs.doctree
diff --git a/docs/_build/doctrees/user_guide/notebooks/data_hrrr.doctree b/docs/_build/doctrees/user_guide/notebooks/data_hrrr.doctree
diff --git a/docs/_build/doctrees/user_guide/notebooks/data_hrrrak.doctree b/docs/_build/doctrees/user_guide/notebooks/data_hrrrak.doctree
diff --git a/docs/_build/doctrees/user_guide/notebooks/data_navgem.doctree b/docs/_build/doctrees/user_guide/notebooks/data_navgem.doctree
diff --git a/docs/_build/doctrees/user_guide/notebooks/data_nbm.doctree b/docs/_build/doctrees/user_guide/notebooks/data_nbm.doctree
diff --git a/docs/_build/doctrees/user_guide/notebooks/data_rap.doctree b/docs/_build/doctrees/user_guide/notebooks/data_rap.doctree
diff --git a/docs/_build/doctrees/user_guide/notebooks/data_rrfs.doctree b/docs/_build/doctrees/user_guide/notebooks/data_rrfs.doctree
diff --git a/docs/_build/doctrees/user_guide/notebooks/index.doctree b/docs/_build/doctrees/user_guide/notebooks/index.doctree
diff --git a/docs/_build/doctrees/user_guide/searchString.doctree b/docs/_build/doctrees/user_guide/searchString.doctree
diff --git a/docs/_build/doctrees/user_guide/tutorial.doctree b/docs/_build/doctrees/user_guide/tutorial.doctree
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 249715d29038b779690eac60075c31fc
+config: caae394bad62c0fe32971595c0c7f98b
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/html/_sources/index.rst.txt b/docs/_build/html/_sources/index.rst.txt
@@ -20,14 +20,14 @@ Install with pip
 
 .. code:: bash
 
-   pip install hrrrb
+   pip install herbie-data
 
    # or
 
    pip install git+https://github.com/blaylockbk/Herbie.git
 
 To install within a conda environment file, you may use this minimum `environment.yml
-<https://github.com/blaylockbk/Herbie/blob/master/environment.yml>`_ file 
+<https://github.com/blaylockbk/Herbie/blob/master/environment.yml>`_ file
 and create the environment with the following...
 
 .. code:: bash
@@ -67,7 +67,7 @@ This Herbie object is for the HRRR model sfc product and 6 hour forecast. The fi
 
 .. image:: _static/screenshots/usage_1.png
 
-Data Sources 
+Data Sources
 """"""""""""
 Thanks to the `NOAA Big Data Program <https://www.noaa.gov/information-technology/big-data>`_ weather data is more easily accessible than ever before. Common data sources include
 

diff --git a/docs/_build/html/_sources/user_guide/install.md.txt b/docs/_build/html/_sources/user_guide/install.md.txt
@@ -9,7 +9,7 @@ Herbie requires `curl` and **Python 3.8+** with the following packages: `request
 Install the last published version from PyPI.
 
 ```bash
-pip install hrrrb
+pip install herbie-data
 ```
 
 The version on PyPI has likely diverged from the code on GitHub, so to get the most recent Herbie code, install the package directly from GitHub.

diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html
@@ -256,7 +256,7 @@ <h1>Herbie: Retrieve NWP Model Data<a class="headerlink" href="#herbie-retrieve-
 <h2>Install<a class="headerlink" href="#install" title="Permalink to this headline">¶</a></h2>
 <p>Herbie requires <strong>Python 3.8+</strong></p>
 <p>Install with pip</p>
-<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip install hrrrb
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip install herbie-data
 
 <span class="c1"># or</span>
 

diff --git a/docs/_build/html/reference_guide/herbie_api.html b/docs/_build/html/reference_guide/herbie_api.html
@@ -261,7 +261,7 @@ <h2>Herbie: Retrieve NWP Model Data<a class="headerlink" href="#herbie-retrieve-
 </table>
 <dl class="py class">
 <dt class="sig sig-object py" id="herbie.archive.Herbie">
-<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">herbie.archive.</span></span><span class="sig-name descname"><span class="pre">Herbie</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">date</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">valid_date</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">model</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'hrrr'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fxx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">product</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">member</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">priority</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">['aws',</span> <span class="pre">'nomads',</span> <span class="pre">'google',</span> <span class="pre">'azure',</span> <span class="pre">'pando',</span> <span class="pre">'pando2',</span> <span class="pre">'aws-old']</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">save_dir</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">PosixPath('/p/cwfs/blaylock/data')</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">overwrite</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">verbose</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#herbie.archive.Herbie" title="Permalink to this definition">¶</a></dt>
+<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">herbie.archive.</span></span><span class="sig-name descname"><span class="pre">Herbie</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">date</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">valid_date</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">model</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'hrrr'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fxx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">product</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">member</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">priority</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">['aws',</span> <span class="pre">'nomads',</span> <span class="pre">'google',</span> <span class="pre">'azure',</span> <span class="pre">'pando',</span> <span class="pre">'pando2',</span> <span class="pre">'aws-old']</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">save_dir</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">WindowsPath('C:/Users/blaylock/data')</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">overwrite</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">verbose</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#herbie.archive.Herbie" title="Permalink to this definition">¶</a></dt>
 <dd><p>Locate GRIB2 file at one of the archive sources.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
@@ -344,7 +344,7 @@ <h2>Herbie: Retrieve NWP Model Data<a class="headerlink" href="#herbie-retrieve-
 </table>
 <dl class="py method">
 <dt class="sig sig-object py" id="herbie.archive.Herbie.__init__">
-<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">date</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">valid_date</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">model</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'hrrr'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fxx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">product</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">member</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">priority</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">['aws',</span> <span class="pre">'nomads',</span> <span class="pre">'google',</span> <span class="pre">'azure',</span> <span class="pre">'pando',</span> <span class="pre">'pando2',</span> <span class="pre">'aws-old']</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">save_dir</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">PosixPath('/p/cwfs/blaylock/data')</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">overwrite</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">verbose</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#herbie.archive.Herbie.__init__" title="Permalink to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">date</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">valid_date</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">model</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'hrrr'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fxx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">product</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">member</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">priority</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">['aws',</span> <span class="pre">'nomads',</span> <span class="pre">'google',</span> <span class="pre">'azure',</span> <span class="pre">'pando',</span> <span class="pre">'pando2',</span> <span class="pre">'aws-old']</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">save_dir</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">WindowsPath('C:/Users/blaylock/data')</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">overwrite</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">verbose</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#herbie.archive.Herbie.__init__" title="Permalink to this definition">¶</a></dt>
 <dd><p>Specify model output and find GRIB2 file at one of the sources.</p>
 </dd></dl>
 

diff --git a/docs/_build/html/reference_guide/hrrrb_api.html b/docs/_build/html/reference_guide/hrrrb_api.html
@@ -312,7 +312,7 @@ <h3>Main Functions<a class="headerlink" href="#main-functions" title="Permalink
 </table>
 <dl class="py function">
 <dt class="sig sig-object py" id="hrrrb.archive.download_hrrr">
-<span class="sig-prename descclassname"><span class="pre">hrrrb.archive.</span></span><span class="sig-name descname"><span class="pre">download_hrrr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">DATES</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">searchString</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fxx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">range(0,</span> <span class="pre">1)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">model</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'hrrr'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">field</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'sfc'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">save_dir</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">PosixPath('/p/cwfs/blaylock/data')</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">download_source_priority</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">overwrite</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dryrun</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">verbose</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#hrrrb.archive.download_hrrr" title="Permalink to this definition">¶</a></dt>
+<span class="sig-prename descclassname"><span class="pre">hrrrb.archive.</span></span><span class="sig-name descname"><span class="pre">download_hrrr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">DATES</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">searchString</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fxx</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">range(0,</span> <span class="pre">1)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">model</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'hrrr'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">field</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'sfc'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">save_dir</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">WindowsPath('C:/Users/blaylock/data')</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">download_source_priority</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">overwrite</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dryrun</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">verbose</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#hrrrb.archive.download_hrrr" title="Permalink to this definition">¶</a></dt>
 <dd><p>Download full or partial HRRR grib2 files for a list of dates and forecasts.</p>
 <p>Attempts to download grib2 files from three different sources in the
 following order:</p>

diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js
diff --git a/docs/_build/html/user_guide/install.html b/docs/_build/html/user_guide/install.html
@@ -384,7 +384,7 @@ <h2>Option 1: pip<a class="headerlink" href="#option-1-pip" title="Permalink to
 <div><p>Note: “herbie” is already registered on PyPI, so I continue to use the “hrrrb” package to publish for now. This may change in version 0.1.0</p>
 </div></blockquote>
 <p>Install the last published version from PyPI.</p>
-<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip install hrrrb
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip install herbie-data
 </pre></div>
 </div>
 <p>The version on PyPI has likely diverged from the code on GitHub, so to get the most recent Herbie code, install the package directly from GitHub.</p>