|
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.waterdata.api — dataretrieval 0.1.dev1+g63b586e0e documentation</title> |
| 8 | + <title>dataretrieval.waterdata.api — dataretrieval 0.1.dev1+gf10f08b77 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=39133080"></script> |
| 15 | + <script src="../../../_static/documentation_options.js?v=27b0860f"></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> |
@@ -286,11 +286,27 @@ <h1>Source code for dataretrieval.waterdata.api</h1><div class="highlight"><pre> |
286 | 286 | <span class="sd"> ... time="2021-01-01T00:00:00Z/2022-01-01T00:00:00Z",</span> |
287 | 287 | <span class="sd"> ... )</span> |
288 | 288 |
|
| 289 | +<span class="sd"> >>> # Quick "show me the last week" idiom (ISO 8601 duration)</span> |
| 290 | +<span class="sd"> >>> df, md = dataretrieval.waterdata.get_daily(</span> |
| 291 | +<span class="sd"> ... monitoring_location_id="USGS-02238500",</span> |
| 292 | +<span class="sd"> ... parameter_code="00060",</span> |
| 293 | +<span class="sd"> ... time="P7D",</span> |
| 294 | +<span class="sd"> ... )</span> |
| 295 | + |
289 | 296 | <span class="sd"> >>> # Get approved daily flow data from multiple sites</span> |
290 | 297 | <span class="sd"> >>> df, md = dataretrieval.waterdata.get_daily(</span> |
291 | | -<span class="sd"> ... monitoring_location_id = ["USGS-05114000", "USGS-09423350"],</span> |
292 | | -<span class="sd"> ... approval_status = "Approved",</span> |
293 | | -<span class="sd"> ... time = "2024-01-01/.."</span> |
| 298 | +<span class="sd"> ... monitoring_location_id=["USGS-05114000", "USGS-09423350"],</span> |
| 299 | +<span class="sd"> ... approval_status="Approved",</span> |
| 300 | +<span class="sd"> ... time="2024-01-01/..",</span> |
| 301 | +<span class="sd"> ... )</span> |
| 302 | + |
| 303 | +<span class="sd"> >>> # Pull only rows whose underlying record was refreshed in the</span> |
| 304 | +<span class="sd"> >>> # last 7 days — handy for incremental ETL polling</span> |
| 305 | +<span class="sd"> >>> df, md = dataretrieval.waterdata.get_daily(</span> |
| 306 | +<span class="sd"> ... monitoring_location_id="USGS-02238500",</span> |
| 307 | +<span class="sd"> ... parameter_code="00060",</span> |
| 308 | +<span class="sd"> ... last_modified="P7D",</span> |
| 309 | +<span class="sd"> ... )</span> |
294 | 310 | <span class="sd"> """</span> |
295 | 311 | <span class="n">service</span> <span class="o">=</span> <span class="s2">"daily"</span> |
296 | 312 | <span class="n">output_id</span> <span class="o">=</span> <span class="s2">"daily_id"</span> |
@@ -1422,6 +1438,22 @@ <h1>Source code for dataretrieval.waterdata.api</h1><div class="highlight"><pre> |
1422 | 1438 | <span class="sd"> ... monitoring_location_id="USGS-02238500", parameter_code="00060"</span> |
1423 | 1439 | <span class="sd"> ... )</span> |
1424 | 1440 |
|
| 1441 | +<span class="sd"> >>> # Restrict to the last 7 days; sites with no observation in that</span> |
| 1442 | +<span class="sd"> >>> # window are dropped instead of returned with stale values</span> |
| 1443 | +<span class="sd"> >>> df, md = dataretrieval.waterdata.get_latest_continuous(</span> |
| 1444 | +<span class="sd"> ... monitoring_location_id="USGS-02238500",</span> |
| 1445 | +<span class="sd"> ... parameter_code="00060",</span> |
| 1446 | +<span class="sd"> ... time="P7D",</span> |
| 1447 | +<span class="sd"> ... )</span> |
| 1448 | + |
| 1449 | +<span class="sd"> >>> # Pull only rows whose underlying record was refreshed in the</span> |
| 1450 | +<span class="sd"> >>> # last 7 days, across multiple sites and parameters</span> |
| 1451 | +<span class="sd"> >>> df, md = dataretrieval.waterdata.get_latest_continuous(</span> |
| 1452 | +<span class="sd"> ... monitoring_location_id=["USGS-451605097071701", "USGS-14181500"],</span> |
| 1453 | +<span class="sd"> ... parameter_code=["00060", "72019"],</span> |
| 1454 | +<span class="sd"> ... last_modified="P7D",</span> |
| 1455 | +<span class="sd"> ... )</span> |
| 1456 | + |
1425 | 1457 | <span class="sd"> >>> # Get latest continuous measurements for multiple sites</span> |
1426 | 1458 | <span class="sd"> >>> df, md = dataretrieval.waterdata.get_latest_continuous(</span> |
1427 | 1459 | <span class="sd"> ... monitoring_location_id=["USGS-05114000", "USGS-09423350"]</span> |
@@ -1606,6 +1638,21 @@ <h1>Source code for dataretrieval.waterdata.api</h1><div class="highlight"><pre> |
1606 | 1638 | <span class="sd"> ... monitoring_location_id="USGS-02238500", parameter_code="00060"</span> |
1607 | 1639 | <span class="sd"> ... )</span> |
1608 | 1640 |
|
| 1641 | +<span class="sd"> >>> # Restrict to rows whose underlying record was refreshed in the</span> |
| 1642 | +<span class="sd"> >>> # last 7 days</span> |
| 1643 | +<span class="sd"> >>> df, md = dataretrieval.waterdata.get_latest_daily(</span> |
| 1644 | +<span class="sd"> ... monitoring_location_id="USGS-02238500",</span> |
| 1645 | +<span class="sd"> ... parameter_code="00060",</span> |
| 1646 | +<span class="sd"> ... last_modified="P7D",</span> |
| 1647 | +<span class="sd"> ... )</span> |
| 1648 | + |
| 1649 | +<span class="sd"> >>> # Multi-site, multi-parameter — discharge and water temperature</span> |
| 1650 | +<span class="sd"> >>> # at two sites in a single round-trip</span> |
| 1651 | +<span class="sd"> >>> df, md = dataretrieval.waterdata.get_latest_daily(</span> |
| 1652 | +<span class="sd"> ... monitoring_location_id=["USGS-01491000", "USGS-01645000"],</span> |
| 1653 | +<span class="sd"> ... parameter_code=["00060", "00010"],</span> |
| 1654 | +<span class="sd"> ... )</span> |
| 1655 | + |
1609 | 1656 | <span class="sd"> >>> # Get most recent daily measurements for two sites</span> |
1610 | 1657 | <span class="sd"> >>> df, md = dataretrieval.waterdata.get_latest_daily(</span> |
1611 | 1658 | <span class="sd"> ... monitoring_location_id=["USGS-05114000", "USGS-09423350"]</span> |
@@ -1785,13 +1832,23 @@ <h1>Source code for dataretrieval.waterdata.api</h1><div class="highlight"><pre> |
1785 | 1832 | <span class="sd"> ... skip_geometry=True,</span> |
1786 | 1833 | <span class="sd"> ... )</span> |
1787 | 1834 |
|
| 1835 | +<span class="sd"> >>> # Half-bounded time range: every measurement at this site since</span> |
| 1836 | +<span class="sd"> >>> # 1980 (open-ended end). Use ``"../<date>"`` for the inverse</span> |
| 1837 | +<span class="sd"> >>> # (everything up to a date).</span> |
| 1838 | +<span class="sd"> >>> df, md = dataretrieval.waterdata.get_field_measurements(</span> |
| 1839 | +<span class="sd"> ... monitoring_location_id="USGS-425957088141001",</span> |
| 1840 | +<span class="sd"> ... time="1980-01-01/..",</span> |
| 1841 | +<span class="sd"> ... )</span> |
| 1842 | + |
1788 | 1843 | <span class="sd"> >>> # Get field measurements from multiple sites and</span> |
1789 | 1844 | <span class="sd"> >>> # parameter codes from the last 20 years</span> |
1790 | 1845 | <span class="sd"> >>> df, md = dataretrieval.waterdata.get_field_measurements(</span> |
1791 | | -<span class="sd"> ... monitoring_location_id = ["USGS-451605097071701",</span> |
1792 | | -<span class="sd"> "USGS-263819081585801"],</span> |
1793 | | -<span class="sd"> ... parameter_code = ["62611", "72019"],</span> |
1794 | | -<span class="sd"> ... time = "P20Y"</span> |
| 1846 | +<span class="sd"> ... monitoring_location_id=[</span> |
| 1847 | +<span class="sd"> ... "USGS-451605097071701",</span> |
| 1848 | +<span class="sd"> ... "USGS-263819081585801",</span> |
| 1849 | +<span class="sd"> ... ],</span> |
| 1850 | +<span class="sd"> ... parameter_code=["62611", "72019"],</span> |
| 1851 | +<span class="sd"> ... time="P20Y",</span> |
1795 | 1852 | <span class="sd"> ... )</span> |
1796 | 1853 | <span class="sd"> """</span> |
1797 | 1854 | <span class="n">service</span> <span class="o">=</span> <span class="s2">"field-measurements"</span> |
|
0 commit comments