| Name | streamstats-access JSON |
| Version |
0.1.9
JSON |
| download |
| home_page | None |
| Summary | A Python package to access and process data from the USGS StreamStats API. |
| upload_time | 2024-06-04 13:33:07 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | MIT License Copyright (c) 2024 streamstats_access Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
usgs
streamstats
api
geospatial
hydrology
statistics
watershed characteristics
water resources
data retrieval
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# streamstats_access: Python access to the USGS Streamstats API
<p align=center>
<img src="images/logo_nobg_txt.png" alt="StreamStats API Python library" width="350">
</p>
## Overview
This library provides users access to functionality of the USGS StreamStats application from within Python. The StreamStats app includes a suite of GIS-based hydrologic tools that are useful for water resources planning/management, engineering, and design purposes.
**_NOTE:_** This is a community package and has no affiliation the U.S. Geological Survey, Web Informatics and Mapping team, or StreamStats team. While efforts have been made to mimic Batch Processor functionality and formats, results received from this package may differ from results returned by the StreamStats Batch Processor. The Batch Processor contains additional features and technicalities that may not be represented in this package.
## Key Features
- **Watershed Delineation:** Use streamStats GIS services to delineate watershed polygons from an outlet point.
- **Basin Characteristics:** Retrieve basin characteristics such as drainage area, percent wetlands, slope, mean annual precipitation, etc from a delineated watershed.
- **Flow Statistics:** Use basin characteristics to derive USGS flow frequency estimates.
- **A Better Batch Point Tool:** Submit large batches of points at once. This library mimics the functionality of the StreamStats batch tool.
- Avoid the 250 point limit of the USGS Streamstats Batch Tool.
- The library implements asynchronous requests offering 2x speed compared to the batch tool.
- Avoid the queue. The library directly queries USGS API endpoints, meaning you don't need to wait in the batch point queue.
## Installation
To install this package, use pip:
1. Pip Installation:
```sh
pip install streamstats-access
```
2. Anaconda Installation (coming soon!):
```bash
# conda install conda_forge:streamstats_access
```
## Example Usage
See samples folder for data and scripts.
```python
import streamstats_access as ssa
import os
IN_PATH = os.path.join(os.path.dirname(__file__), 'vt_test.gpkg')
OUT_PATH = os.path.join(os.path.dirname(__file__), 'out_pts.gpkg')
ssa.process_batch(IN_PATH, OUT_PATH, rcode='VT', unique_field='UID')
```
## License
This project is licensed under the MIT License - see the LICENSE file for details.
## Contact
For any questions or issues, please direct inquiries to Scott Lawson([Scott.Lawson@uvm.edu](mailto:Scott.Lawson@uvm.edu)).
Raw data
{
"_id": null,
"home_page": null,
"name": "streamstats-access",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "USGS, StreamStats, API, Geospatial, Hydrology, statistics, watershed characteristics, water resources, data retrieval",
"author": null,
"author_email": "Scott Lawson <scott.lawson@uvm.edu>",
"download_url": "https://files.pythonhosted.org/packages/11/87/bdffb0c0b3221bd20f5345a3b28ba9bc42f9a02fc2fcf2b95d65cb29a030/streamstats_access-0.1.9.tar.gz",
"platform": null,
"description": "# streamstats_access: Python access to the USGS Streamstats API\r\n<p align=center>\r\n<img src=\"images/logo_nobg_txt.png\" alt=\"StreamStats API Python library\" width=\"350\">\r\n</p>\r\n\r\n## Overview\r\n\r\nThis library provides users access to functionality of the USGS StreamStats application from within Python. The StreamStats app includes a suite of GIS-based hydrologic tools that are useful for water resources planning/management, engineering, and design purposes.\r\n\r\n**_NOTE:_** This is a community package and has no affiliation the U.S. Geological Survey, Web Informatics and Mapping team, or StreamStats team. While efforts have been made to mimic Batch Processor functionality and formats, results received from this package may differ from results returned by the StreamStats Batch Processor. The Batch Processor contains additional features and technicalities that may not be represented in this package.\r\n\r\n## Key Features\r\n\r\n- **Watershed Delineation:** Use streamStats GIS services to delineate watershed polygons from an outlet point.\r\n- **Basin Characteristics:** Retrieve basin characteristics such as drainage area, percent wetlands, slope, mean annual precipitation, etc from a delineated watershed.\r\n- **Flow Statistics:** Use basin characteristics to derive USGS flow frequency estimates.\r\n- **A Better Batch Point Tool:** Submit large batches of points at once. This library mimics the functionality of the StreamStats batch tool.\r\n - Avoid the 250 point limit of the USGS Streamstats Batch Tool.\r\n - The library implements asynchronous requests offering 2x speed compared to the batch tool.\r\n - Avoid the queue. The library directly queries USGS API endpoints, meaning you don't need to wait in the batch point queue.\r\n\r\n## Installation\r\n\r\nTo install this package, use pip:\r\n\r\n1. Pip Installation:\r\n ```sh\r\n pip install streamstats-access\r\n ```\r\n2. Anaconda Installation (coming soon!):\r\n ```bash\r\n # conda install conda_forge:streamstats_access\r\n ```\r\n\r\n## Example Usage\r\n\r\nSee samples folder for data and scripts.\r\n\r\n```python\r\nimport streamstats_access as ssa\r\nimport os\r\n\r\n\r\nIN_PATH = os.path.join(os.path.dirname(__file__), 'vt_test.gpkg')\r\nOUT_PATH = os.path.join(os.path.dirname(__file__), 'out_pts.gpkg')\r\n\r\n\r\nssa.process_batch(IN_PATH, OUT_PATH, rcode='VT', unique_field='UID')\r\n```\r\n\r\n## License\r\n\r\nThis project is licensed under the MIT License - see the LICENSE file for details.\r\n\r\n## Contact\r\n\r\nFor any questions or issues, please direct inquiries to Scott Lawson([Scott.Lawson@uvm.edu](mailto:Scott.Lawson@uvm.edu)).\r\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 streamstats_access Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "A Python package to access and process data from the USGS StreamStats API.",
"version": "0.1.9",
"project_urls": {
"Bug Tracker": "https://github.com/sclaw/streamstats_access/issues",
"Homepage": "https://github.com/sclaw/streamstats_access"
},
"split_keywords": [
"usgs",
" streamstats",
" api",
" geospatial",
" hydrology",
" statistics",
" watershed characteristics",
" water resources",
" data retrieval"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fc60439a8eae7392c2765dfa3396f4f3c9f49d85df91e01c99fe72f4368a4808",
"md5": "b0ee048dbf84978923c11ad8deb9961d",
"sha256": "987b8b8d981392e165a799d6b4f4d42b436be7521357104d7f0e9428ca5fb87d"
},
"downloads": -1,
"filename": "streamstats_access-0.1.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b0ee048dbf84978923c11ad8deb9961d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 12539,
"upload_time": "2024-06-04T13:33:05",
"upload_time_iso_8601": "2024-06-04T13:33:05.505434Z",
"url": "https://files.pythonhosted.org/packages/fc/60/439a8eae7392c2765dfa3396f4f3c9f49d85df91e01c99fe72f4368a4808/streamstats_access-0.1.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1187bdffb0c0b3221bd20f5345a3b28ba9bc42f9a02fc2fcf2b95d65cb29a030",
"md5": "4d830e749cad25dfac09187bc58f617e",
"sha256": "2b81b7108501f9adce353eddffc57a5b97d5d7feac1dd79cd05783389130e9c2"
},
"downloads": -1,
"filename": "streamstats_access-0.1.9.tar.gz",
"has_sig": false,
"md5_digest": "4d830e749cad25dfac09187bc58f617e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 11837,
"upload_time": "2024-06-04T13:33:07",
"upload_time_iso_8601": "2024-06-04T13:33:07.611269Z",
"url": "https://files.pythonhosted.org/packages/11/87/bdffb0c0b3221bd20f5345a3b28ba9bc42f9a02fc2fcf2b95d65cb29a030/streamstats_access-0.1.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-04 13:33:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sclaw",
"github_project": "streamstats_access",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "streamstats-access"
}
