Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/VeinsOfTheEarth/rabpro
Delineating watershed basins and computing attribute statistics using Google Earth Engine
https://github.com/VeinsOfTheEarth/rabpro
manuscript python
Last synced: 3 months ago
JSON representation
Delineating watershed basins and computing attribute statistics using Google Earth Engine
- Host: GitHub
- URL: https://github.com/VeinsOfTheEarth/rabpro
- Owner: VeinsOfTheEarth
- License: bsd-3-clause
- Created: 2021-04-26T16:53:58.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-05T03:08:48.000Z (5 months ago)
- Last Synced: 2024-06-11T17:09:30.392Z (5 months ago)
- Topics: manuscript, python
- Language: Python
- Homepage: https://VeinsOfTheEarth.github.io/rabpro
- Size: 23.1 MB
- Stars: 35
- Watchers: 5
- Forks: 9
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Citation: CITATION.cff
Awesome Lists containing this project
- open-sustainable-technology - rabpro - Delineating watershed basins and computing attribute statistics using Google Earth Engine. (Hydrosphere / Freshwater and Hydrology)
README
Package to delineate watershed basins and compute attribute statistics using [Google Earth Engine](https://developers.google.com/earth-engine/).
## Setup
|[Software installation](https://veinsoftheearth.github.io/rabpro/install/index.html)|[Data configuration](https://veinsoftheearth.github.io/rabpro/configure/index.html#data)|[Software configuration](https://veinsoftheearth.github.io/rabpro/configure/index.html#software)|
|--|--|--|
## Usage
See Example notebooks:
|[Data configuration](https://veinsoftheearth.github.io/rabpro/examples/notebooks/downloading_data.html)|[Basic workflow](https://veinsoftheearth.github.io/rabpro/examples/notebooks/basic_example.html)|[Multiple basins workflow](https://veinsoftheearth.github.io/rabpro/examples/notebooks/multiple_basins.html)|[Basin stats examples](https://veinsoftheearth.github.io/rabpro/examples/notebooks/basin_stats.html)|
|--|--|--|--|
## Citation
The following text is the current citation for rabpro:
> Schwenk, J., T. Zussman, J. Stachelek, and J. Rowland. (2022). rabpro: global watershed boundaries, river elevation profiles, and catchment statistics. Journal of Open Source Software, 7(73), 4237, .
If you delineate watersheds, you should cite either or both (depending on your method) of HydroBasins:
> Lehner, B., Grill G. (2013). Global river hydrography and network routing: baseline data and new approaches to study the world’s large river systems. Hydrological Processes, 27(15): 2171–2186.
or MERIT-Hydro:
> Yamazaki, D., Ikeshima, D., Sosa, J., Bates, P. D., Allen, G. H., & Pavelsky, T. M. (2019). MERIT Hydro: A high‐resolution global hydrography map based on latest topography dataset. *Water Resources Research*, *55*(6), 5053-5073.
## Development
### Testing
```python
python -m pytest
python -m pytest -k "test_img"
```
### Local docs build
```shell
cd docs && make html
```
## Contributing
We welcome all forms of user contributions including feature requests, bug reports, code, and documentation requests - simply open an [issue](https://github.com/VeinsOfTheEarth/rabpro/issues).
Note that *rabpro* adheres to [Black code style](https://black.readthedocs.io/en/stable/) and [NumPy-style docstrings](https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard) for documentation. We ask that contributions adhere to these standards as much as possible. For code development contributions, please contact us via email (rabpro at lanl [dot] gov) to be added to our slack channel where we can hash out a plan for your contribution.