Skip to content

Commit 8694925

Browse files
thodson-usgsthodson-usgs
committed
Deploying to gh-pages from @ dca49a7 🚀
1 parent 8c43b48 commit 8694925

76 files changed

Lines changed: 1528 additions & 1497 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.buildinfo‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: f2b91a932f93dc9cd817e1c4390c0f88
3+
config: 91e2f17ace4268fbf72dff51e6eae0b3
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎_images/examples_WaterData_demo_36_0.png‎

-309 Bytes
Loading

‎_images/examples_WaterData_demo_40_0.png‎

-352 Bytes
Loading

‎_modules/dataretrieval/nadp.html‎

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>dataretrieval.nadp &mdash; dataretrieval 0.1.dev1+gc107fc9f6 documentation</title>
8+
<title>dataretrieval.nadp &mdash; dataretrieval 0.1.dev1+gdca49a7bc documentation</title>
99
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" />
1010
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=9edc463e" />
1111

1212

1313
<script src="../../_static/jquery.js?v=5d32c60e"></script>
1414
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
15-
<script src="../../_static/documentation_options.js?v=bdbd3255"></script>
15+
<script src="../../_static/documentation_options.js?v=8f9da921"></script>
1616
<script src="../../_static/doctools.js?v=fd6eb6e6"></script>
1717
<script src="../../_static/sphinx_highlight.js?v=6ffebe34"></script>
1818
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -105,6 +105,8 @@ <h1>Source code for dataretrieval.nadp</h1><div class="highlight"><pre>
105105

106106
<span class="sd">&quot;&quot;&quot;</span>
107107

108+
<span class="kn">from</span><span class="w"> </span><span class="nn">__future__</span><span class="w"> </span><span class="kn">import</span> <span class="n">annotations</span>
109+
108110
<span class="kn">import</span><span class="w"> </span><span class="nn">io</span>
109111
<span class="kn">import</span><span class="w"> </span><span class="nn">re</span>
110112
<span class="kn">import</span><span class="w"> </span><span class="nn">warnings</span>
@@ -121,7 +123,7 @@ <h1>Source code for dataretrieval.nadp</h1><div class="highlight"><pre>
121123
<span class="p">)</span>
122124

123125

124-
<span class="k">def</span><span class="w"> </span><span class="nf">_warn_deprecated</span><span class="p">():</span>
126+
<span class="k">def</span><span class="w"> </span><span class="nf">_warn_deprecated</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
125127
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="n">_DEPRECATION_MESSAGE</span><span class="p">,</span> <span class="ne">DeprecationWarning</span><span class="p">,</span> <span class="n">stacklevel</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span>
126128

127129

@@ -154,7 +156,7 @@ <h1>Source code for dataretrieval.nadp</h1><div class="highlight"><pre>
154156

155157
<div class="viewcode-block" id="NADP_ZipFile.tif_name">
156158
<a class="viewcode-back" href="../../reference/nadp.html#dataretrieval.nadp.NADP_ZipFile.tif_name">[docs]</a>
157-
<span class="k">def</span><span class="w"> </span><span class="nf">tif_name</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
159+
<span class="k">def</span><span class="w"> </span><span class="nf">tif_name</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
158160
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get the name of the tif file in the zip file.&quot;&quot;&quot;</span>
159161
<span class="n">filenames</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">namelist</span><span class="p">()</span>
160162
<span class="n">r</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s2">&quot;.*tif$&quot;</span><span class="p">)</span>
@@ -164,7 +166,7 @@ <h1>Source code for dataretrieval.nadp</h1><div class="highlight"><pre>
164166

165167
<div class="viewcode-block" id="NADP_ZipFile.tif">
166168
<a class="viewcode-back" href="../../reference/nadp.html#dataretrieval.nadp.NADP_ZipFile.tif">[docs]</a>
167-
<span class="k">def</span><span class="w"> </span><span class="nf">tif</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
169+
<span class="k">def</span><span class="w"> </span><span class="nf">tif</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bytes</span><span class="p">:</span>
168170
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Read the tif file in the zip file.&quot;&quot;&quot;</span>
169171
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">tif_name</span><span class="p">())</span></div>
170172
</div>
@@ -173,7 +175,7 @@ <h1>Source code for dataretrieval.nadp</h1><div class="highlight"><pre>
173175

174176
<div class="viewcode-block" id="get_annual_MDN_map">
175177
<a class="viewcode-back" href="../../reference/nadp.html#dataretrieval.nadp.get_annual_MDN_map">[docs]</a>
176-
<span class="k">def</span><span class="w"> </span><span class="nf">get_annual_MDN_map</span><span class="p">(</span><span class="n">measurement_type</span><span class="p">,</span> <span class="n">year</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
178+
<span class="k">def</span><span class="w"> </span><span class="nf">get_annual_MDN_map</span><span class="p">(</span><span class="n">measurement_type</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">year</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">path</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
177179
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Download a MDN map from NDAP.</span>
178180

179181
<span class="sd"> This function looks for a zip file containing gridded information at:</span>
@@ -225,7 +227,12 @@ <h1>Source code for dataretrieval.nadp</h1><div class="highlight"><pre>
225227

226228
<div class="viewcode-block" id="get_annual_NTN_map">
227229
<a class="viewcode-back" href="../../reference/nadp.html#dataretrieval.nadp.get_annual_NTN_map">[docs]</a>
228-
<span class="k">def</span><span class="w"> </span><span class="nf">get_annual_NTN_map</span><span class="p">(</span><span class="n">measurement_type</span><span class="p">,</span> <span class="n">measurement</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">year</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">path</span><span class="o">=</span><span class="s2">&quot;.&quot;</span><span class="p">):</span>
230+
<span class="k">def</span><span class="w"> </span><span class="nf">get_annual_NTN_map</span><span class="p">(</span>
231+
<span class="n">measurement_type</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
232+
<span class="n">measurement</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
233+
<span class="n">year</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
234+
<span class="n">path</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;.&quot;</span><span class="p">,</span>
235+
<span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
229236
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Download a NTN map from NDAP.</span>
230237

231238
<span class="sd"> This function looks for a zip file containing gridded information at:</span>
@@ -286,7 +293,7 @@ <h1>Source code for dataretrieval.nadp</h1><div class="highlight"><pre>
286293

287294
<div class="viewcode-block" id="get_zip">
288295
<a class="viewcode-back" href="../../reference/nadp.html#dataretrieval.nadp.get_zip">[docs]</a>
289-
<span class="k">def</span><span class="w"> </span><span class="nf">get_zip</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">filename</span><span class="p">):</span>
296+
<span class="k">def</span><span class="w"> </span><span class="nf">get_zip</span><span class="p">(</span><span class="n">url</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">filename</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">NADP_ZipFile</span><span class="p">:</span>
290297
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Gets a ZipFile at url and returns it</span>
291298

292299
<span class="sd"> Parameters</span>

0 commit comments

Comments
 (0)