search

hydroframe / hf_hydrodata

Other
5 stars 0 forks source link

Add a more complete tutorial #164

Open thodson-usgs opened 4 months ago

thodson-usgs commented 4 months ago

openjournals/joss-reviews#6623

Optional but encouraged. I think users might benefit from having a more developed tutorial example in the docs. Would it be feasible to use hf_hydrodata to set up a "toy" hydrologic model? A template users can run through in a few minutes, which they could riff off in setting up their own workflows.

amy-defnet commented 4 months ago

Thank you for your comment @thodson-usgs! In addition to the short examples in the README and the Getting Started section of the docs, se also have some more in-depth walkthrough notebooks for the point module functions. We added a reference to that section of the docs in the README.

Additionally, we have added some text to the Usage section of the README to point users to the subsettools Python package. The subsettools package was developed by members of our team and uses hf_hydrodata to access data and then run the hydrologic model ParFlow. The subsettools documentation contains full start-to-finish examples for obtaining data and running a ParFlow hydrologic simulation. Subsettools is also a public repository (https://github.com/hydroframe/subsettools/tree/main).

Related Pull Request: #166