DarriEy
commented
7 years ago Hi Yifan
Some thoughts on the Tutorial and Steps pages:
Tutorial:
The overview, Input and Output sections are all clear and descriptive. Regarding the Salmon example it would be nice to have a little bit more detail like a short description of the example area but maybe the whole appendix A should be moved to the Steps page?
Steps to run RBM:
The steps are descriptive and relatively easy to understand, links to all the supporting data are provided which is great. My suggestions
• Move Appendix A to the steps page. It is only referenced there and not in the tutorial page • Some slight information about the example case (e.g. map of Salmon river). Doesn‘t have to be much, just to give some physical info on the example • It’s great to have a link to example files (both input and output) like you do in step 2. It would be good to add such links to subsequent steps also. • Flow chart of model interactions and hierarchy would be great to easily understand how the flow of data between the models are processed (Should maybe be on Tutorial page) • Naming of the page should maybe be something like “Example run of VIC-RBM model” as the tutorial and steps seem to be referring to similar things. • Step 6, typo, routing instead of rounting
YifanCheng
Mainly two documentation get updated 1) Documentation/tutorial 2) Documentation/steps to run RBM The link to the RBM website is: http://rbm.readthedocs.io/en/latest/