Walkthrough section in documentation

Exawind / amr-wind

AMReX-based structured wind solver

https://exawind.github.io/amr-wind

Other

105 stars 83 forks source link

Walkthrough section in documentation #1056

Closed mbkuhn closed 3 months ago

mbkuhn commented 4 months ago

Summary

Adding a walkthrough section to the documentation to clarify the typical workflow and usage recommendations associated with common AMR-Wind applications. Other documentation updates may be included here too.

Pull request type

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, renaming)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[x] Documentation content changes
[ ] Other (please describe):

mbkuhn commented 4 months ago

@lawrenceccheung @ndevelder @tonyinme @rthedin

I copy-pasted the bulk of Alex's tutorial to give us a general framework. Now we can update it and adapt the details as needed. As the walkthrough section gets more complete, we can put between it and the user manual, and we can remove obsolete parts of the user manual section.

mbkuhn commented 4 months ago

Keeping track of tasks here. If you're interested in getting involved but do not have access to this project page, let me know and I can try to add you. https://github.com/orgs/Exawind/projects/8

rthedin commented 4 months ago

I don't have access-- can you add me?

github-actions[bot] commented 3 months ago

This PR is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 7 days.

github-actions[bot] commented 3 months ago

This PR was closed because it has been stalled for 7 days with no activity.