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

A suggestion: I think it would be nice to add a page at the beginning of the in-depth tutorial summarizing the functionalities epyt-flow offers. This could include a complete list of the uncertainties, events, faults, and controls you allow users to model, and ideally would include time series or spatial plots to better visualize these things (e.g., abrupt and incipient leaks, sensor override attacks, different uncertainty distributions, etc). Having all of these cases in one single page could provide users with a clear overview of what the package offers #22

Open
Tracked by #9
andreArtelt opened this issue Oct 16, 2024 · 1 comment

Comments

@andreArtelt
Copy link
Member

No description provided.

@andreArtelt andreArtelt mentioned this issue Oct 16, 2024
23 tasks
andreArtelt added a commit that referenced this issue Oct 16, 2024
@andreArtelt
Copy link
Member Author

This is a great idea, but it is not clear to me how to best implement it. Because EPyT-Flow offers so much functionalities, it is easy to overwhelm the user.
After some time, I decided to create a somewhat detailed list of features and functionalities and put it as a "table of contents" in front of the in-depth tutorial -- by this, the user not only gets an overview of the functionalities and features but also gets help in navigating the extensive in-depth tutorial (hopefully it helps the user to quickly find what their are looking for).

I attached a screenshot of the new page, so you can have a look without compiling the documentation. Let me know what you think.
Screenshot_2024-10-16_07-42-36

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant