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

Create a new user tutorial with up-to-date examples #500

Open
lawrenceccheung opened this issue Nov 1, 2021 · 2 comments
Open

Create a new user tutorial with up-to-date examples #500

lawrenceccheung opened this issue Nov 1, 2021 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation no-issue-activity

Comments

@lawrenceccheung
Copy link
Contributor

Starting an issue to track the creation of a new user tutorial with up-to-date examples.

The few tasks I see under this issue are:

  • Creating a tutorial section in the sphinx documentation
  • Choosing which cases to include in the tutorial
  • Writing documentation for the cases (obviously)
    • I'm thinking of end-to-end documentation, covering case setup, running, and postprocessing
  • Figuring out a way to run the examples periodically, either scaled down as a part of regression test suite or any other method.

Ideally this will be completed before many more AMR-Wind users come in from other projects.

Lawrence

@lawrenceccheung lawrenceccheung added the documentation Improvements or additions to documentation label Nov 1, 2021
@lawrenceccheung lawrenceccheung added this to In progress in Development Tracker Nov 1, 2021
@tonyinme tonyinme mentioned this issue Dec 9, 2021
3 tasks
@rybchuk
Copy link
Contributor

rybchuk commented Jul 6, 2023

I put together an unofficial tutorial while visiting TU Delft. This material could help someone get started on an official tutorial, cheers!

Copy link

This issue is stale because it has been open 30 days with no activity.

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 no-issue-activity
Projects
Development Tracker
In progress: people assigned to it
Development

No branches or pull requests

3 participants