search

Deltares / Ribasim

Water resources modeling
https://deltares.github.io/Ribasim/
MIT License
38 stars 5 forks source link

Add a quick start guide #1158

Open visr opened 5 months ago

visr commented 5 months ago

Many modelers like to learn by example, and end up using https://deltares.github.io/Ribasim/python/examples.html without first reading much of the rest of the documentation.

Right now that page is really just a collection of Python examples. Having a separate tutorial or quick start guide that stands by itself would be valuable. It doesn't have to cover everything, just the essentials. This probably makes sense after this lands: https://github.com/Deltares/Ribasim/pull/1110. Then the Python examples would also be much more self-explanatory.

Additional context Came up in #1154, but also other feedback from first time users.

visr commented 2 weeks ago

And addition from @SouthEndMusic that is in scope of this issue:

@Fati-Mon mentioned that from the documentation it is not clear how to set up a model in Ribasim python for new users. We have the examples, but that is already quite a deep dive without detailed explanation of the add API. So I propose adding a new page with how to set up a model, with detailed explanations of every step from initializing the model to writing it to disk. Maybe also add some information about how the input data will end up in the tables.