update docs to hopefully better give proper credit for RAPIDpy

erdc · May 9, 2019 · bd161d2 · bd161d2
1 parent b64d6d1
commit bd161d2
Show file tree

Hide file tree

Showing 4 changed files with 101 additions and 35 deletions.
diff --git a/README.md b/README.md
@@ -1,8 +1,11 @@
 # RAPIDpy
 
+Documentation: http://rapidpy.readthedocs.io/en/latest
+
 RAPIDpy is a python interface for RAPID that assists to prepare inputs, runs the RAPID program, and provides post-processing utilities.
 More information about installation and the input parameters for RAPID can be found at http://rapid-hub.org.
-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.
+
+The source code for RAPID is located at https://github.com/c-h-david/rapid/.
 
 [![DOI](https://zenodo.org/badge/19918/erdc-cm/RAPIDpy.svg)](https://zenodo.org/badge/latestdoi/19918/erdc-cm/RAPIDpy)
 
@@ -18,5 +21,44 @@ The source code for RAPID is located at https://github.com/c-h-david/rapid/. Oth
 
 [![Docs](https://readthedocs.org/projects/rapidpy/badge/?version=latest)](http://rapidpy.readthedocs.io/en/latest)
 
-Documentation can be found at: http://rapidpy.readthedocs.io/en/latest
 
+## Credit
+
+- The development of RAPIDpy was funded by ERDC.
+- 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).
+
+
+## How the Inflow and GIS tools work:
+
+Snow, Alan D., Scott D. Christensen, Nathan R. Swain, E. James Nelson,
+Daniel P. Ames, Norman L. Jones, Deng Ding, Nawajish S. Noman, Cedric H.
+David, Florian Pappenberger, and Ervin Zsoter, 2016. A High-Resolution
+National-Scale Hydrologic Forecast System from a Global Ensemble Land
+Surface Model. *Journal of the American Water Resources Association
+(JAWRA)* 1-15, DOI: 10.1111/1752-1688.12434
+https://onlinelibrary.wiley.com/doi/full/10.1111/1752-1688.12434
+
+Snow, Alan Dee, "A New Global Forecasting Model to Produce
+High-Resolution Stream Forecasts" (2015). All Theses and Dissertations.
+Paper 5272.
+http://scholarsarchive.byu.edu/etd/5272
+
+
+## Publications using RAPID and RAPIDpy:
+
+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
+
+
+## Datasets produced using RAPID and RAPIDpy:
+
+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|
+
+.. |Mississippi Dataset DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.322886.svg
+   :target: https://doi.org/10.5281/zenodo.322886
+
+
+## Other tools to prepare input for RAPID
+
+- For ESRI users: https://github.com/Esri/python-toolbox-for-rapid
+- Modified version of the ESRI RAPID Toolbox: https://github.com/erdc-cm/python-toolbox-for-rapid
+- For the NHDPlus dataset: https://github.com/c-h-david/RRR
diff --git a/docs/gis_tools.rst b/docs/gis_tools.rst
@@ -8,10 +8,6 @@ These tools generate the RAPID input files and weight table files from the GIS s
 
 .. note:: For these tools to work, you need GIS dependencies installed (See :doc:`installation`).
 
-There are also tools by Esri for ArcMap located here:
-
-- https://github.com/Esri/python-toolbox-for-rapid
-- https://github.com/erdc-cm/python-toolbox-for-rapid
 
 Workflows
 ---------
@@ -63,18 +59,3 @@ Utilities
 ---------
 
 .. autofunction:: RAPIDpy.gis.centroid.FlowlineToPoint
-
-
-How it works:
--------------
-
-Snow, Alan D., Scott D. Christensen, Nathan R. Swain, E. James Nelson,
-Daniel P. Ames, Norman L. Jones, Deng Ding, Nawajish S. Noman, Cedric H.
-David, Florian Pappenberger, and Ervin Zsoter, 2016. A High-Resolution
-National-Scale Hydrologic Forecast System from a Global Ensemble Land
-Surface Model. *Journal of the American Water Resources Association
-(JAWRA)* 1-15, DOI: 10.1111/1752-1688.12434
-
-Snow, Alan Dee, "A New Global Forecasting Model to Produce
-High-Resolution Stream Forecasts" (2015). All Theses and Dissertations.
-Paper 5272. http://scholarsarchive.byu.edu/etd/5272
diff --git a/docs/index.rst b/docs/index.rst
@@ -27,20 +27,6 @@ https://github.com/c-h-david/rapid.
    :target: https://coveralls.io/github/erdc/RAPIDpy
 .. |License (3-Clause BSD)| image:: https://img.shields.io/badge/license-BSD%203--Clause-yellow.svg
    :target: https://github.com/erdc-cm/RAPIDpy/blob/master/LICENSE
-
-Publications:
-=============
-
-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
-
-Datasets:
-=========
-
-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|
-
-.. |Mississippi Dataset DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.322886.svg
-   :target: https://doi.org/10.5281/zenodo.322886
-
 
 Contents:
 
@@ -56,6 +42,59 @@ Contents:
    postprocessing
    rapid_to_gssha
 
+
+Credit
+------
+
+- The development of RAPIDpy was funded by ERDC.
+- 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).
+
+
+How the Inflow and GIS tools work:
+----------------------------------
+
+Snow, Alan D., Scott D. Christensen, Nathan R. Swain, E. James Nelson,
+Daniel P. Ames, Norman L. Jones, Deng Ding, Nawajish S. Noman, Cedric H.
+David, Florian Pappenberger, and Ervin Zsoter, 2016. A High-Resolution
+National-Scale Hydrologic Forecast System from a Global Ensemble Land
+Surface Model. *Journal of the American Water Resources Association
+(JAWRA)* 1-15, DOI: 10.1111/1752-1688.12434
+https://onlinelibrary.wiley.com/doi/full/10.1111/1752-1688.12434
+
+Snow, Alan Dee, "A New Global Forecasting Model to Produce
+High-Resolution Stream Forecasts" (2015). All Theses and Dissertations.
+Paper 5272.
+http://scholarsarchive.byu.edu/etd/5272
+
+
+Publications using RAPIDpy and RAPID:
+-------------------------------------
+
+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
+
+
+Datasets produced using RAPIDpy and RAPID:
+------------------------------------------
+
+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|
+
+.. |Mississippi Dataset DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.322886.svg
+   :target: https://doi.org/10.5281/zenodo.322886
+
+
+Other tools to prepare input for RAPID
+---------------------------------------
+
+- For ESRI users: https://github.com/Esri/python-toolbox-for-rapid
+- Modified version of the ESRI RAPID Toolbox: https://github.com/erdc-cm/python-toolbox-for-rapid
+- For the NHDPlus dataset: https://github.com/c-h-david/RRR
+
+
+
 Indices and tables
 ==================
 

diff --git a/docs/lsm_inflow.rst b/docs/lsm_inflow.rst
@@ -7,6 +7,10 @@ Code to use to prepare input data for RAPID from Land Surface Models
 - ECMWF's ERA Interim Data
 - NASA's GLDAS/NLDAS/LIS Data
 - CMIP5 Data (daily VIC data available from 1950 to 2099)
+- Joules
+- WRF
+- FLDAS (http://disc.sci.gsfc.nasa.gov/uui/datasets?keywords=FLDAS)
+- ERA 20CM
 
 Step 1: Retrieve Land Surface Model Runoff Output
 -------------------------------------------------