Skip to content

Commit

Permalink
Updated Sphinx Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
blaylockbk committed Feb 23, 2022
1 parent e51c9f3 commit 8621bab
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 5 deletions.
Binary file modified docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/_build/doctrees/reference_guide/herbie_api.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/user_guide/searchString.doctree
Binary file not shown.
8 changes: 5 additions & 3 deletions docs/_build/html/_sources/user_guide/searchString.rst.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
================================
===================================
🪂 Subset with ``searchString``
================================
===================================

Subsetting is done using the GRIB2 index files. Index files define the grib variables/parameters of each message (sometimes it is useful to think of a grib message as a "layer" of the file) and define the byte range of the message.

Expand Down Expand Up @@ -44,7 +44,7 @@ Here are some examples you can use for the ``searchString`` argument for the **w
``"^TMP:2 m.*fcst$"`` Beginning of string (^), end of string ($) wildcard (.*)
================================= ========================================================

.. hint:: The NCEP `Parameters & Units Table <https://www.nco.ncep.noaa.gov/pmb/docs/on388/table2.html>`_ is a useful resource to help you identify GRIB variable abbreviations and their meanings.
.. hint:: The NCEP `Parameters & Units Table <https://www.nco.ncep.noaa.gov/pmb/docs/on388/table2.html>`_ is a useful resource to help you identify wgrib2-style GRIB variable abbreviations and their meanings.

ecCodes-style index files
-------------------------
Expand Down Expand Up @@ -94,3 +94,5 @@ searchString (wave/waef) Messages that will be downloaded
":pp1d:" Peak wave period
":mp2:" Mean zero-crossing wave period
======================== ==============================================

.. hint:: The ECMWF `Parameter Database <https://apps.ecmwf.int/codes/grib/param-db?filter=grib2>`_ is a useful resource to help you identify ecCodes-style GRIB variable abbreviations and their meanings.
6 changes: 5 additions & 1 deletion docs/_build/html/reference_guide/herbie_api.html
Original file line number Diff line number Diff line change
Expand Up @@ -508,7 +508,7 @@ <h2>Herbie: Retrieve NWP Model Data<a class="headerlink" href="#herbie-retrieve-
</table>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>The NCEP <a class="reference external" href="https://www.nco.ncep.noaa.gov/pmb/docs/on388/table2.html">Parameters &amp; Units Table</a> is a useful resource to help you identify GRIB variable abbreviations and their meanings.</p>
<p>The NCEP <a class="reference external" href="https://www.nco.ncep.noaa.gov/pmb/docs/on388/table2.html">Parameters &amp; Units Table</a> is a useful resource to help you identify wgrib2-style GRIB variable abbreviations and their meanings.</p>
</div>
<p>Here are some examples you can use for the <code class="docutils literal notranslate"><span class="pre">searchString</span></code> argument for the <strong>grib_ls</strong>-style index files.</p>
<p>Look at the ECMWF GRIB Parameter Database
Expand Down Expand Up @@ -622,6 +622,10 @@ <h2>Herbie: Retrieve NWP Model Data<a class="headerlink" href="#herbie-retrieve-
</tr>
</tbody>
</table>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>The ECMWF <a class="reference external" href="https://apps.ecmwf.int/codes/grib/param-db?filter=grib2">Parameter Database</a> is a useful resource to help you identify ecCodes-style GRIB variable abbreviations and their meanings.</p>
</div>
</p>
</dd>
<dt class="field-even">Return type</dt>
Expand Down
6 changes: 5 additions & 1 deletion docs/_build/html/user_guide/searchString.html
Original file line number Diff line number Diff line change
Expand Up @@ -428,7 +428,7 @@ <h2>wgrib2-style index files<a class="headerlink" href="#wgrib2-style-index-file
</table>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>The NCEP <a class="reference external" href="https://www.nco.ncep.noaa.gov/pmb/docs/on388/table2.html">Parameters &amp; Units Table</a> is a useful resource to help you identify GRIB variable abbreviations and their meanings.</p>
<p>The NCEP <a class="reference external" href="https://www.nco.ncep.noaa.gov/pmb/docs/on388/table2.html">Parameters &amp; Units Table</a> is a useful resource to help you identify wgrib2-style GRIB variable abbreviations and their meanings.</p>
</div>
</section>
<section id="eccodes-style-index-files">
Expand Down Expand Up @@ -545,6 +545,10 @@ <h2>ecCodes-style index files<a class="headerlink" href="#eccodes-style-index-fi
</tr>
</tbody>
</table>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>The ECMWF <a class="reference external" href="https://apps.ecmwf.int/codes/grib/param-db?filter=grib2">Parameter Database</a> is a useful resource to help you identify ecCodes-style GRIB variable abbreviations and their meanings.</p>
</div>
</section>
</section>

Expand Down

0 comments on commit 8621bab

Please sign in to comment.