Skip to content

Commit 7f79ef8

Browse files
committed
update docs to hopefully better give proper credit for RAPIDpy
1 parent b64d6d1 commit 7f79ef8

File tree

4 files changed

+101
-35
lines changed

4 files changed

+101
-35
lines changed

README.md

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
# RAPIDpy
22

3+
Documentation: http://rapidpy.readthedocs.io/en/latest
4+
35
RAPIDpy is a python interface for RAPID that assists to prepare inputs, runs the RAPID program, and provides post-processing utilities.
46
More information about installation and the input parameters for RAPID can be found at http://rapid-hub.org.
5-
The source code for RAPID is located at https://github.com/c-h-david/rapid/. Other tools to prepare input for RAPID based on the NHDPlus dataset are located at https://github.com/c-h-david/RRR.
7+
8+
The source code for RAPID is located at https://github.com/c-h-david/rapid/.
69

710
[![DOI](https://zenodo.org/badge/19918/erdc-cm/RAPIDpy.svg)](https://zenodo.org/badge/latestdoi/19918/erdc-cm/RAPIDpy)
811

@@ -18,5 +21,44 @@ The source code for RAPID is located at https://github.com/c-h-david/rapid/. Oth
1821

1922
[![Docs](https://readthedocs.org/projects/rapidpy/badge/?version=latest)](http://rapidpy.readthedocs.io/en/latest)
2023

21-
Documentation can be found at: http://rapidpy.readthedocs.io/en/latest
2224

25+
## Credit
26+
27+
- The development of RAPIDpy was funded by ERDC.
28+
- The pre-processing GIS tools and the inflow tools in RAPIDpy are based on the ESRI RAPID Toolbox (https://github.com/Esri/python-toolbox-for-rapid).
29+
30+
31+
## How the Inflow and GIS tools work:
32+
33+
Snow, Alan D., Scott D. Christensen, Nathan R. Swain, E. James Nelson,
34+
Daniel P. Ames, Norman L. Jones, Deng Ding, Nawajish S. Noman, Cedric H.
35+
David, Florian Pappenberger, and Ervin Zsoter, 2016. A High-Resolution
36+
National-Scale Hydrologic Forecast System from a Global Ensemble Land
37+
Surface Model. *Journal of the American Water Resources Association
38+
(JAWRA)* 1-15, DOI: 10.1111/1752-1688.12434
39+
https://onlinelibrary.wiley.com/doi/full/10.1111/1752-1688.12434
40+
41+
Snow, Alan Dee, "A New Global Forecasting Model to Produce
42+
High-Resolution Stream Forecasts" (2015). All Theses and Dissertations.
43+
Paper 5272.
44+
http://scholarsarchive.byu.edu/etd/5272
45+
46+
47+
## Publications using RAPID and RAPIDpy:
48+
49+
Tavakoly, A. A., A. D. Snow, C. H. David, M. L. Follum, D. R. Maidment, and Z.-L. Yang, (2016) "Continental-Scale River Flow Modeling of the Mississippi River Basin Using High-Resolution NHDPlus Dataset", Journal of the American Water Resources Association (JAWRA) 1-22. DOI: 10.1111/1752-1688.12456
50+
51+
52+
## Datasets produced using RAPID and RAPIDpy:
53+
54+
Ahmad A Tavakoly. (2017). RAPID input files corresponding to the Mississippi River Basin using the NHDPlus v2 Dataset [Data set]. Zenodo. http://doi.org/10.5281/zenodo.322886 |Mississippi Dataset DOI|
55+
56+
.. |Mississippi Dataset DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.322886.svg
57+
:target: https://doi.org/10.5281/zenodo.322886
58+
59+
60+
## Other tools to prepare input for RAPID
61+
62+
- For ESRI users: https://github.com/Esri/python-toolbox-for-rapid
63+
- Modified version of the ESRI RAPID Toolbox: https://github.com/erdc-cm/python-toolbox-for-rapid
64+
- For the NHDPlus dataset: https://github.com/c-h-david/RRR

docs/gis_tools.rst

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,6 @@ These tools generate the RAPID input files and weight table files from the GIS s
88

99
.. note:: For these tools to work, you need GIS dependencies installed (See :doc:`installation`).
1010

11-
There are also tools by Esri for ArcMap located here:
12-
13-
- https://github.com/Esri/python-toolbox-for-rapid
14-
- https://github.com/erdc-cm/python-toolbox-for-rapid
1511

1612
Workflows
1713
---------
@@ -63,18 +59,3 @@ Utilities
6359
---------
6460

6561
.. autofunction:: RAPIDpy.gis.centroid.FlowlineToPoint
66-
67-
68-
How it works:
69-
-------------
70-
71-
Snow, Alan D., Scott D. Christensen, Nathan R. Swain, E. James Nelson,
72-
Daniel P. Ames, Norman L. Jones, Deng Ding, Nawajish S. Noman, Cedric H.
73-
David, Florian Pappenberger, and Ervin Zsoter, 2016. A High-Resolution
74-
National-Scale Hydrologic Forecast System from a Global Ensemble Land
75-
Surface Model. *Journal of the American Water Resources Association
76-
(JAWRA)* 1-15, DOI: 10.1111/1752-1688.12434
77-
78-
Snow, Alan Dee, "A New Global Forecasting Model to Produce
79-
High-Resolution Stream Forecasts" (2015). All Theses and Dissertations.
80-
Paper 5272. http://scholarsarchive.byu.edu/etd/5272

docs/index.rst

Lines changed: 53 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -27,20 +27,6 @@ https://github.com/c-h-david/rapid.
2727
:target: https://coveralls.io/github/erdc/RAPIDpy
2828
.. |License (3-Clause BSD)| image:: https://img.shields.io/badge/license-BSD%203--Clause-yellow.svg
2929
:target: https://github.com/erdc-cm/RAPIDpy/blob/master/LICENSE
30-
31-
Publications:
32-
=============
33-
34-
Tavakoly, A. A., A. D. Snow, C. H. David, M. L. Follum, D. R. Maidment, and Z.-L. Yang, (2016) "Continental-Scale River Flow Modeling of the Mississippi River Basin Using High-Resolution NHDPlus Dataset", Journal of the American Water Resources Association (JAWRA) 1-22. DOI: 10.1111/1752-1688.12456
35-
36-
Datasets:
37-
=========
38-
39-
Ahmad A Tavakoly. (2017). RAPID input files corresponding to the Mississippi River Basin using the NHDPlus v2 Dataset [Data set]. Zenodo. http://doi.org/10.5281/zenodo.322886 |Mississippi Dataset DOI|
40-
41-
.. |Mississippi Dataset DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.322886.svg
42-
:target: https://doi.org/10.5281/zenodo.322886
43-
4430

4531
Contents:
4632

@@ -56,6 +42,59 @@ Contents:
5642
postprocessing
5743
rapid_to_gssha
5844

45+
46+
Credit
47+
------
48+
49+
- The development of RAPIDpy was funded by ERDC.
50+
- The pre-processing GIS tools and the inflow tools in RAPIDpy are based on the ESRI RAPID Toolbox (https://github.com/Esri/python-toolbox-for-rapid).
51+
52+
53+
How the Inflow and GIS tools work:
54+
----------------------------------
55+
56+
Snow, Alan D., Scott D. Christensen, Nathan R. Swain, E. James Nelson,
57+
Daniel P. Ames, Norman L. Jones, Deng Ding, Nawajish S. Noman, Cedric H.
58+
David, Florian Pappenberger, and Ervin Zsoter, 2016. A High-Resolution
59+
National-Scale Hydrologic Forecast System from a Global Ensemble Land
60+
Surface Model. *Journal of the American Water Resources Association
61+
(JAWRA)* 1-15, DOI: 10.1111/1752-1688.12434
62+
https://onlinelibrary.wiley.com/doi/full/10.1111/1752-1688.12434
63+
64+
Snow, Alan Dee, "A New Global Forecasting Model to Produce
65+
High-Resolution Stream Forecasts" (2015). All Theses and Dissertations.
66+
Paper 5272.
67+
http://scholarsarchive.byu.edu/etd/5272
68+
69+
70+
Publications using RAPIDpy and RAPID:
71+
-------------------------------------
72+
73+
Tavakoly, A. A., A. D. Snow, C. H. David, M. L. Follum, D. R. Maidment, and Z.-L. Yang, (2016)
74+
"Continental-Scale River Flow Modeling of the Mississippi River Basin Using High-Resolution
75+
NHDPlus Dataset", Journal of the American Water Resources Association (JAWRA) 1-22.
76+
DOI: 10.1111/1752-1688.12456
77+
78+
79+
Datasets produced using RAPIDpy and RAPID:
80+
------------------------------------------
81+
82+
Ahmad A Tavakoly. (2017). RAPID input files corresponding to the Mississippi River Basin using
83+
the NHDPlus v2 Dataset [Data set]. Zenodo. http://doi.org/10.5281/zenodo.322886 |Mississippi Dataset DOI|
84+
85+
.. |Mississippi Dataset DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.322886.svg
86+
:target: https://doi.org/10.5281/zenodo.322886
87+
88+
89+
Other tools to prepare input for RAPID
90+
---------------------------------------
91+
92+
- For ESRI users: https://github.com/Esri/python-toolbox-for-rapid
93+
- Modified version of the ESRI RAPID Toolbox: https://github.com/erdc-cm/python-toolbox-for-rapid
94+
- For the NHDPlus dataset: https://github.com/c-h-david/RRR
95+
96+
97+
5998
Indices and tables
6099
==================
61100

docs/lsm_inflow.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ Code to use to prepare input data for RAPID from Land Surface Models
77
- ECMWF's ERA Interim Data
88
- NASA's GLDAS/NLDAS/LIS Data
99
- CMIP5 Data (daily VIC data available from 1950 to 2099)
10+
- Joules
11+
- WRF
12+
- FLDAS (http://disc.sci.gsfc.nasa.gov/uui/datasets?keywords=FLDAS)
13+
- ERA 20CM
1014

1115
Step 1: Retrieve Land Surface Model Runoff Output
1216
-------------------------------------------------

0 commit comments

Comments
 (0)