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

Adding documentation for typical usages of OpenFAST #308

Merged
merged 10 commits into from
Dec 12, 2023

Conversation

ebranlard
Copy link
Contributor

@ebranlard ebranlard commented Jul 19, 2019

Feature or improvement description

Slight restructuring of the documentation:

  1. Adding a section "Working with OpenFAST" as a "quick start", high up in the table of content. I've added a "Minimal Example" to the r-test (in dev right now, so links will fail) that the users can download for their first OpenFAST simulation.
  2. Putting the "Testing OpenFAST" section further down in the table of content. I think our test suite is not for the basic user.
  3. Moving all the modules documentation one level up so that the table of content is more readable.

The "Working With OpenFAST" section intend to describe some of the typical use cases of OpenFAST and point the users to the tools and scripts that can be used.
Some of these use cases are:

  • running a simple OpenFAST simulation
  • visualizing inputs and outputs data
  • reading and writing files
  • performing linearization
  • running a suite of Design load cases
  • running a parametric and combined cases
  • postprocessing tools (links to the nwtc portal)

Impacted areas of the software

Documentation only

Live version
https://ebranlard-openfast.readthedocs.io/en/doc/source/working.html

  • Address reviewers comments

@ebranlard ebranlard requested a review from rafmudaf July 19, 2019 22:35
@ebranlard ebranlard changed the base branch from master to dev July 19, 2019 22:35
Copy link
Contributor

@bjonkman bjonkman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. I am not sure I believe this: "For a typical use case the linearization is done at only one time". If the rotor is spinning, you need azimuth-averaged values, and we typically do 36 linearization times (i.e., about every 10 degrees)
  2. BeamDyn is included in the system-level linearization., so you should remove it from the section "options not yet supported with the linearization"
  3. There is a typo on line 55: whre

@ebranlard
Copy link
Contributor Author

Thanks @bjonkman for your input. I'll try to correct it soon.

@rafmudaf
Copy link
Collaborator

rafmudaf commented Oct 3, 2019

@ebranlard I think this info would be great and may fit in better in the upcoming OpenFAST user's guide: https://raf-openfast.readthedocs.io/en/docs-fast8readme/source/user/openfast/running_openfast.html

This is in my fork at https://github.com/rafmudaf/openfast/tree/docs/fast8readme.

@rafmudaf
Copy link
Collaborator

@ebranlard I'm closing this pull request, see the comment above!

@rafmudaf rafmudaf closed this Oct 29, 2019
@ebranlard ebranlard deleted the doc branch July 7, 2020 15:28
@ebranlard ebranlard restored the doc branch July 7, 2020 15:28
@ebranlard ebranlard reopened this Mar 30, 2021
@ebranlard ebranlard marked this pull request as draft March 30, 2021 04:32
@ebranlard
Copy link
Contributor Author

ebranlard commented Apr 29, 2021

I'm bringing this pull request back to life, to try to give a reference for some of the issues that are raised by the users (how to run cases, how to visualize outputs, how to troubleshoot cases, how to run linearization, etc.).
I've flushed out some more help and usage in my latest commit. I don't think that what I wrote is complete, but i think it's good to have a placeholder, something we can improve on with time, and send a link to users.

I think it qualifies as a section on its own, to give it more visibility, and since the user manual is already quite large..

I'm open to inputs and contributions :)

A live version is there :
https://ebranlard-openfast.readthedocs.io/en/doc/source/working.html

I think a tutorial and a set of working files (stored in the r-test in a standalone folder), could be great.

@ebranlard ebranlard force-pushed the doc branch 2 times, most recently from f88be73 to 27cbf13 Compare April 29, 2021 21:35
@ebranlard ebranlard requested review from andrew-platt and jjonkman and removed request for rafmudaf November 14, 2023 23:05
@ebranlard
Copy link
Contributor Author

I believe this is now ready for review. I'm happy to receive comments and address what I can. I would be in favor in merging this as early as possible and having others take over if they want changes or updates :)

@andrew-platt andrew-platt marked this pull request as ready for review November 15, 2023 04:20
Copy link
Collaborator

@jjonkman jjonkman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding this version useful user documentation! Hopefully this will reduce the number of beginner questions that often arise.

docs/source/user/general.rst Show resolved Hide resolved
docs/source/working.rst Outdated Show resolved Hide resolved
docs/source/working.rst Outdated Show resolved Hide resolved
docs/source/working.rst Outdated Show resolved Hide resolved
docs/source/working.rst Outdated Show resolved Hide resolved
docs/source/working.rst Outdated Show resolved Hide resolved
docs/source/working.rst Outdated Show resolved Hide resolved
docs/source/working.rst Outdated Show resolved Hide resolved
docs/source/working.rst Outdated Show resolved Hide resolved
docs/source/working.rst Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants