-
Notifications
You must be signed in to change notification settings - Fork 461
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- 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)
- BeamDyn is included in the system-level linearization., so you should remove it from the section "options not yet supported with the linearization"
- There is a typo on line 55:
whre
Thanks @bjonkman for your input. I'll try to correct it soon. |
@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. |
@ebranlard I'm closing this pull request, see the comment above! |
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 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 : I think a tutorial and a set of working files (stored in the r-test in a standalone folder), could be great. |
f88be73
to
27cbf13
Compare
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 :) |
There was a problem hiding this 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.
Feature or improvement description
Slight restructuring of the documentation:
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:
Impacted areas of the software
Documentation only
Live version
https://ebranlard-openfast.readthedocs.io/en/doc/source/working.html