Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a quick start guide #1158

Closed
2 of 3 tasks
visr opened this issue Feb 21, 2024 · 1 comment · Fixed by #1787
Closed
2 of 3 tasks

Add a quick start guide #1158

visr opened this issue Feb 21, 2024 · 1 comment · Fixed by #1787
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@visr
Copy link
Member

visr commented Feb 21, 2024

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: #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 visr added the documentation Improvements or additions to documentation label Feb 21, 2024
@github-project-automation github-project-automation bot moved this to To do in Ribasim Feb 21, 2024
@visr visr added the usage label Mar 14, 2024
@SnippenE SnippenE moved this from To do to What's next in Ribasim May 29, 2024
@SnippenE SnippenE moved this from What's next to Sprint backlog in Ribasim May 30, 2024
@visr visr self-assigned this Jun 20, 2024
@Jingru923 Jingru923 moved this from Sprint backlog to What's next in Ribasim Jun 27, 2024
@evetion evetion added the v1.0 label Jul 4, 2024
@visr
Copy link
Member Author

visr commented Jul 4, 2024

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.

@visr visr mentioned this issue Jul 15, 2024
7 tasks
@Jingru923 Jingru923 moved this from What's next to Sprint backlog in Ribasim Jul 15, 2024
@visr visr assigned Fati-Mon and unassigned visr Jul 15, 2024
@Jingru923 Jingru923 moved this from Sprint backlog to 🏗 In progress in Ribasim Jul 22, 2024
@Jingru923 Jingru923 self-assigned this Aug 22, 2024
@Jingru923 Jingru923 mentioned this issue Sep 2, 2024
@Jingru923 Jingru923 linked a pull request Sep 2, 2024 that will close this issue
SouthEndMusic added a commit that referenced this issue Sep 3, 2024
Fixes #1158 

The quick start guide is now also in our documentation.

When I was working on this, I thought about what is the best way to make
sure the offline and online one are synchronized, so that when we modify
the old module or add new module to the docx, it can be updated in the
documentation.

I tried conversion between docx and qmd and it doesn't work very well. 

For now I suggest we should keep to modifying the qmd instead of
modifying the docx.

---------

Co-authored-by: Bart de Koning <[email protected]>
@github-project-automation github-project-automation bot moved this from 👀 In review to ✅ Done in Ribasim Sep 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

4 participants