Doc: Core aspects of the basic setup

[ArseniyKholod]

This is a new part of the documentation, that provides explanation of the execution path for Semidiscretization and rhs! for TreeMesh. Closes #1215

[github-actions]

Review checklist

This checklist is meant to assist creators of PRs (to let them know what reviewers will typically look for) and reviewers (to guide them in a structured review process). Items do not need to be checked explicitly for a PR to be eligible for merging.

Purpose and scope

• The PR has a single goal that is clear from the PR title and/or description.
• All code changes represent a single set of modifications that logically belong together.
• No more than 500 lines of code are changed or there is no obvious way to split the PR into multiple PRs.

Code quality

• The code can be understood easily.
• Newly introduced names for variables etc. are self-descriptive and consistent with existing naming conventions.
• There are no redundancies that can be removed by simple modularization/refactoring.
• There are no leftover debug statements or commented code sections.
• The code adheres to our conventions and style guide, and to the Julia guidelines.

Documentation

• New functions and types are documented with a docstring or top-level comment.
• Relevant publications are referenced in docstrings (see example for formatting).
• Inline comments are used to document longer or unusual code sections.
• Comments describe intent ("why?") and not just functionality ("what?").
• If the PR introduces a significant change or new feature, it is documented in NEWS.md.

Testing

• The PR passes all tests.
• New or modified lines of code are covered by tests.
• New or modified tests run in less then 10 seconds.

Performance

• There are no type instabilities or memory allocations in performance-critical parts.
• If the PR intent is to improve performance, before/after time measurements are posted in the PR.

Verification

• The correctness of the code was verified using appropriate tests.
• If new equations/methods are added, a convergence test has been run and the results
  are posted in the PR.

Created with ❤️ by the Trixi.jl community.

[ArseniyKholod]

Preview of the tutorial https://host-docs-from-fork-pr.lakemper.eu/tutorials/behind_the_scenes_simulation_setup.html

[sloede]

Thanks a lot for the nice tutorial. I've left a few suggestions. Please also commit the scripts you used to generate the nice visualization plots (maybe create a folder named like the tutorial, e.g., tutorial.jl -> tutorial_plots/)

[ArseniyKholod]

Visualizations used in tutorial

[ArseniyKholod]

Thanks a lot for the nice tutorial. I've left a few suggestions. Please also commit the scripts you used to generate the nice visualization plots (maybe create a folder named like the tutorial, e.g., tutorial.jl -> tutorial_plots/)

Thank you very much for this review, I will add visualization scripts into a folder as you said, but these scripts are unfortunately do not seem to be reusable, because I didn't expect such need und wrote only for one time use by me

[ArseniyKholod]

Do you mean links to general things like method of lines and so on?

Yeah why not, just to avoid any confusion due to doubled usage of terms.

I didn't work with Riemann solvers, so I not sure what I should mention...

Okay, do not worry at this point. Maybe I will add something (later ?)

Thanks for your help with Riemann solvers :)

[ArseniyKholod]

Let's wait a little and merge this after #1343 (assuming #1343 will be merged soon-ish). We can then maybe add it as the fourth installment of the "getting started" series.

To summarize, would you prefer to add this as a fourth part to the introductory tutorial?

[sloede]

Let's wait a little and merge this after #1343 (assuming #1343 will be merged soon-ish). We can then maybe add it as the fourth installment of the "getting started" series.

To summarize, would you prefer to add this as a fourth part to the introductory tutorial?

TBH, I am not sure anymore. This is certainly way beyond "getting started". What do the other reviewers think?

[DanielDoehring]

TBH, I am not sure anymore. This is certainly way beyond "getting started". What do the other reviewers think?

What are the alternatives? Making this an own section labeled "behind the scenes" or similar?

[sloede]

TBH, I am not sure anymore. This is certainly way beyond "getting started". What do the other reviewers think?

What are the alternatives? Making this an own section labeled "behind the scenes" or similar?

I believe that yes, exactly this name was floating around a while ago

[ArseniyKholod]

The current state of the tutorial, after all reviews available here.
I also added introduction, as tutorial is going to be separate.
https://host-docs-from-fork-pr.lakemper.eu/tutorials/introduction.html

[JoshuaLampert]

Thanks again! Please find two comments below.

[DanielDoehring]

Thanks for your work!

[ArseniyKholod]

@DanielDoehring, this PR has disabled checks, because it only adds docs, so auto-merge will not work, as some checks didn't run. So merging should be done manually:)

Thank you very much!

[ranocha]

Thanks!

[ranocha]

Can you see the new docs in the dev branch of our docs?

[ranocha]

Ah, okay, it's fine now - just needed some time to update stuff. Thanks again

[DanielDoehring]

Sometimes your browser cookies might also play tricks on you here