|
5 | 5 | <head> |
6 | 6 | <meta charset="utf-8" /> |
7 | 7 | <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
8 | | - <title>dataretrieval.nadp — dataretrieval 0.1.dev1+g8cbff617e documentation</title> |
| 8 | + <title>dataretrieval.nadp — dataretrieval 0.1.dev1+g51ac674de documentation</title> |
9 | 9 | <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b86133f3" /> |
10 | 10 | <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=9edc463e" /> |
11 | 11 |
|
12 | 12 |
|
13 | 13 | <script src="../../_static/jquery.js?v=5d32c60e"></script> |
14 | 14 | <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> |
15 | | - <script src="../../_static/documentation_options.js?v=584d99c5"></script> |
| 15 | + <script src="../../_static/documentation_options.js?v=11a62b05"></script> |
16 | 16 | <script src="../../_static/doctools.js?v=fd6eb6e6"></script> |
17 | 17 | <script src="../../_static/sphinx_highlight.js?v=6ffebe34"></script> |
18 | 18 | <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> |
@@ -107,10 +107,22 @@ <h1>Source code for dataretrieval.nadp</h1><div class="highlight"><pre> |
107 | 107 |
|
108 | 108 | <span class="kn">import</span><span class="w"> </span><span class="nn">io</span> |
109 | 109 | <span class="kn">import</span><span class="w"> </span><span class="nn">re</span> |
| 110 | +<span class="kn">import</span><span class="w"> </span><span class="nn">warnings</span> |
110 | 111 | <span class="kn">import</span><span class="w"> </span><span class="nn">zipfile</span> |
111 | 112 |
|
112 | 113 | <span class="kn">import</span><span class="w"> </span><span class="nn">requests</span> |
113 | 114 |
|
| 115 | +<span class="n">_DEPRECATION_MESSAGE</span> <span class="o">=</span> <span class="p">(</span> |
| 116 | + <span class="s2">"The `nadp` module is deprecated and will be removed from `dataretrieval` "</span> |
| 117 | + <span class="s2">"on or after 2026-11-01. NADP is not a USGS data source; please retrieve "</span> |
| 118 | + <span class="s2">"NADP data directly from https://nadp.slh.wisc.edu/."</span> |
| 119 | +<span class="p">)</span> |
| 120 | + |
| 121 | + |
| 122 | +<span class="k">def</span><span class="w"> </span><span class="nf">_warn_deprecated</span><span class="p">():</span> |
| 123 | + <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> |
| 124 | + |
| 125 | + |
114 | 126 | <span class="n">NADP_URL</span> <span class="o">=</span> <span class="s2">"https://nadp.slh.wisc.edu"</span> |
115 | 127 | <span class="n">NADP_MAP_EXT</span> <span class="o">=</span> <span class="s2">"filelib/maps"</span> |
116 | 128 |
|
@@ -194,6 +206,8 @@ <h1>Source code for dataretrieval.nadp</h1><div class="highlight"><pre> |
194 | 206 | <span class="sd"> ... )</span> |
195 | 207 |
|
196 | 208 | <span class="sd"> """</span> |
| 209 | + <span class="n">_warn_deprecated</span><span class="p">()</span> |
| 210 | + |
197 | 211 | <span class="n">url</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">NADP_URL</span><span class="si">}</span><span class="s2">/</span><span class="si">{</span><span class="n">NADP_MAP_EXT</span><span class="si">}</span><span class="s2">/MDN/grids/"</span> |
198 | 212 |
|
199 | 213 | <span class="n">filename</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"Hg_</span><span class="si">{</span><span class="n">measurement_type</span><span class="si">}</span><span class="s2">_</span><span class="si">{</span><span class="n">year</span><span class="si">}</span><span class="s2">.zip"</span> |
@@ -250,6 +264,8 @@ <h1>Source code for dataretrieval.nadp</h1><div class="highlight"><pre> |
250 | 264 | <span class="sd"> ... )</span> |
251 | 265 |
|
252 | 266 | <span class="sd"> """</span> |
| 267 | + <span class="n">_warn_deprecated</span><span class="p">()</span> |
| 268 | + |
253 | 269 | <span class="n">url</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">NADP_URL</span><span class="si">}</span><span class="s2">/</span><span class="si">{</span><span class="n">NADP_MAP_EXT</span><span class="si">}</span><span class="s2">/NTN/grids/</span><span class="si">{</span><span class="n">year</span><span class="si">}</span><span class="s2">/"</span> |
254 | 270 |
|
255 | 271 | <span class="n">filename</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">measurement_type</span><span class="si">}</span><span class="s2">_</span><span class="si">{</span><span class="n">year</span><span class="si">}</span><span class="s2">.zip"</span> |
@@ -288,6 +304,8 @@ <h1>Source code for dataretrieval.nadp</h1><div class="highlight"><pre> |
288 | 304 | <span class="sd"> finish docstring</span> |
289 | 305 |
|
290 | 306 | <span class="sd"> """</span> |
| 307 | + <span class="n">_warn_deprecated</span><span class="p">()</span> |
| 308 | + |
291 | 309 | <span class="n">req</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">url</span> <span class="o">+</span> <span class="n">filename</span><span class="p">)</span> |
292 | 310 | <span class="n">req</span><span class="o">.</span><span class="n">raise_for_status</span><span class="p">()</span> |
293 | 311 |
|
|
0 commit comments