Skip to content

Commit

Permalink
Update documentation for army corp WL
Browse files Browse the repository at this point in the history
  • Loading branch information
abdu558 committed Aug 20, 2024
1 parent 9a187d3 commit 4cbff33
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Searvey aims to provide the following functionality:
- U.S. Center for Operational Oceanographic Products and Services (CO-OPS)
- Flanders Marine Institute (VLIZ); Intergovernmental Oceanographic Commission (IOC)
- U.S. Geological Survey (USGS)
- Army Corp WL

## Installation

Expand Down
15 changes: 15 additions & 0 deletions docs/source/usace.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
USACE RiverGages
==============
The U.S. Army Corps of Engineers RiverGages <https://rivergages.mvr.usace.army.mil/>_
system provides water level data for rivers and waterways across the United States.
searvey uses the RiverGages REST API to access this data. Currently, water level
data is exposed in searvey.

The data from an individual station can be retrieved with:
.. autofunction:: searvey.usace.get_usace_station

You can fetch data from multiple stations and multiple different dates with:
.. autofunction:: searvey.usace.fetch_usace

Note: The verify=False parameter in the httpx.Client() is used here to bypass
SSL verification, which is the only way to access the USACE RiverGages API.

0 comments on commit 4cbff33

Please sign in to comment.