Adding documentation for typical usages of OpenFAST
Complete this sentence THIS PULL REQUEST NOT READY TO MERGE
Feature or improvement description
This 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. It should refer to the user manual when needed. Some of these use cases are:
- 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)
This is currently work in progress.
Impacted areas of the software
Documentation only
Live version https://ebranlard-openfast.readthedocs.io/en/doc/source/working.html
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'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.
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 :)