VeinsOfTheEarth / rabpro

Delineating watershed basins and computing attribute statistics using Google Earth Engine
https://VeinsOfTheEarth.github.io/rabpro
BSD 3-Clause "New" or "Revised" License
35 stars 8 forks source link

JOSS review: Add an illustrative version of MERIT tile along with HydroBasins file? #128

Closed kanishkan91 closed 2 years ago

kanishkan91 commented 2 years ago

In the current documentation a user is asked to create an account for the MERIT files and then the code here (https://veinsoftheearth.github.io/rabpro/configure/index.html#downloading-merit-hydro) provides an example of how you can download the data. For the sake of user convenience , can you also add a sample file to the repo or to the download link with the HydroBasins file? That way, the user when just wanting to look at code would always have access to a sample. You can provide a citation for the file provided in the repo. This would be in addition to the extensive instructions already provided (The current instructions are very useful in knowing how to download from the online MERIT database).

https://github.com/openjournals/joss-reviews/issues/4237

jsta commented 2 years ago

We have a clipped portion of a MERIT tile used to run the tests (see subfolders under https://github.com/VeinsOfTheEarth/rabpro/tree/main/tests/data/MERIT_Hydro).

The MERIT website says "we ask users to refrain from redistributing the data" so we've not included an entire tile (file size not withstanding).

I suppose we could formalize the CI steps that do the setup of this "test" data https://github.com/VeinsOfTheEarth/rabpro/blob/main/.github/workflows/build.yaml#L87