Add a rough estimate for tutorial runtime
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 142
- Forks
- 167
- Avg merge
- 20h 24m
- Merged PRs (30d)
- 11
Description
It would be nice to have a rough estimate on how long tutorials run, similar to "estimated reading time" on some websites. We could use the all serial setup to give these estimates.
While this is very hardware dependent, it can give the user a good feeling on what to expect.
For example elastic-tube-1d runs in approx 1 minute, heat-exchanger runs in approx 10 minutes, elastic-tube-3d in approx 1h (maybe).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the serial setup for elastic-tube-1d, heat-exchanger, and elastic-tube-3d, then locate where tutorial information is rendered. Determine how rough runtime estimates should be presented and verify that the displayed values reflect the example runs. Done means the relevant tutorials show clear approximate runtimes.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100