Skip to content

Commit 933c56b

Browse files
committed
add new function to init, add some more documentation
1 parent fd35362 commit 933c56b

2 files changed

Lines changed: 6 additions & 8 deletions

File tree

dataretrieval/waterdata/__init__.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
from .api import (
1414
_check_profiles,
1515
get_codes,
16+
get_continuous,
1617
get_daily,
1718
get_field_measurements,
1819
get_latest_continuous,
@@ -30,6 +31,7 @@
3031

3132
__all__ = [
3233
"get_codes",
34+
"get_continuous",
3335
"get_daily",
3436
"get_field_measurements",
3537
"get_latest_continuous",

dataretrieval/waterdata/api.py

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -216,15 +216,16 @@ def get_continuous(
216216
qualifier: Optional[Union[str, List[str]]] = None,
217217
value: Optional[Union[str, List[str]]] = None,
218218
last_modified: Optional[str] = None,
219-
skip_geometry: Optional[bool] = None,
220219
time: Optional[Union[str, List[str]]] = None,
221220
limit: Optional[int] = None,
222221
convert_type: bool = True,
223222
) -> Tuple[pd.DataFrame, BaseMetadata]:
224223
"""This is an early version of the continuous endpoint. It is
225224
feature-complete and provides access to the full continuous data record,
226225
and is being made available as we continue to work on performance
227-
improvements. Continuous data are collected via automated sensors
226+
improvements. Geometries are not included with the continuous endpoint.
227+
228+
Continuous data are collected via automated sensors
228229
installed at a monitoring location. They are collected at a high
229230
frequency and often at a fixed 15-minute interval. Depending on the
230231
specific monitoring location, the data may be transmitted automatically
@@ -307,11 +308,6 @@ def get_continuous(
307308
308309
Only features that have a last_modified that intersects the value of
309310
datetime are selected.
310-
skip_geometry : boolean, optional
311-
This option can be used to skip response geometries for each feature.
312-
The returning object will be a data frame with no spatial information.
313-
Note that the USGS Water Data APIs use camelCase "skipGeometry" in
314-
CQL2 queries.
315311
time : string, optional
316312
The date an observation represents. You can query this field using
317313
date-times or intervals, adhering to RFC 3339, or using ISO 8601
@@ -353,7 +349,7 @@ def get_continuous(
353349
>>> # single site from a single year
354350
>>> df, md = dataretrieval.waterdata.get_continuous(
355351
... monitoring_location_id="USGS-02238500",
356-
... parameter_code="00060",
352+
... parameter_code="00065",
357353
... time="2021-01-01T00:00:00Z/2022-01-01T00:00:00Z",
358354
... )
359355
"""

0 commit comments

Comments
 (0)