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

Major documentation update #49

Merged
60 commits merged into from
Sep 29, 2017
Merged

Major documentation update #49

60 commits merged into from
Sep 29, 2017

Conversation

ghost
Copy link

@ghost ghost commented Sep 28, 2017

This pull request substantially updates the readthedocs documentation in OpenFAST. Major updates include

  • Menu reorganization into meaningful categories and sequential order
  • Initial module documentation for
    • AeroDyn
    • BeamDyn
  • Improved and updated support for compiling on Windows
  • Description of testing frameworks
  • Guidelines for community development including Git/GitHub workflow

A live version can be viewed at http://mas-openfast-fork.readthedocs.io/en/latest/index.html

michaelasprague and others added 30 commits September 25, 2017 12:09
The user directory contains directories for installation, individual
modules, and running the test suite.

The dev directory includes info on the doxygen API documentation,
building sphinx documentation locally, and will include information on
adding new tests to the testing suite.
AeroDyn and BeamDyn docs are still in rough shape and need
much cleanup; compiles on local sphinx fine
- show execution documentation first
- improve section for adding test
- remove general software design links
Restructure high-level contents; put installing, testing, user,
dev, and cdash at same level.
@ghost ghost assigned ghost and michaelasprague Sep 28, 2017
@ghost ghost mentioned this pull request Sep 28, 2017
@ghost
Copy link
Author

ghost commented Sep 29, 2017

Here are the regression test results for this pull request:

rmudafor@~/Development/openfast/build: ctest -L openfast -j 8
Test project /Users/rmudafor/Development/openfast/build
      Start  6: AOC_WSt
      Start  1: AWT_YFix_WSt
      Start  2: AWT_WSt_StartUp_HighSpShutDown
      Start  3: AWT_YFree_WSt
      Start  4: AWT_YFree_WTurb
      Start  5: AWT_WSt_StartUpShutDown
      Start  7: AOC_YFree_WTurb
      Start  8: AOC_YFix_WSt
 1/26 Test  #1: AWT_YFix_WSt .............................   Passed   34.11 sec
      Start  9: UAE_Dnwind_YRamp_WSt
 2/26 Test  #6: AOC_WSt ..................................   Passed   51.08 sec
      Start 10: UAE_Upwind_Rigid_WRamp_PwrCurve
 3/26 Test  #2: AWT_WSt_StartUp_HighSpShutDown ...........   Passed   64.99 sec
      Start 11: WP_VSP_WTurb_PitchFail
 4/26 Test  #3: AWT_YFree_WSt ............................   Passed   75.50 sec
      Start 12: WP_VSP_ECD
 5/26 Test  #8: AOC_YFix_WSt .............................   Passed   78.35 sec
      Start 13: WP_VSP_WTurb
 6/26 Test  #5: AWT_WSt_StartUpShutDown ..................   Passed   99.12 sec
      Start 14: WP_Stationary_Linear
 7/26 Test #14: WP_Stationary_Linear .....................   Passed    4.80 sec
      Start 15: SWRT_YFree_VS_EDG01
 8/26 Test #11: WP_VSP_WTurb_PitchFail ...................   Passed   63.55 sec
      Start 16: SWRT_YFree_VS_EDC01
 9/26 Test #12: WP_VSP_ECD ...............................   Passed   69.35 sec
      Start 17: SWRT_YFree_VS_WTurb
10/26 Test #10: UAE_Upwind_Rigid_WRamp_PwrCurve ..........   Passed  141.41 sec
      Start 18: 5MW_Land_DLL_WTurb
11/26 Test  #9: UAE_Dnwind_YRamp_WSt .....................   Passed  250.50 sec
      Start 19: 5MW_OC3Mnpl_DLL_WTurb_WavesIrr
12/26 Test  #4: AWT_YFree_WTurb ..........................   Passed  297.46 sec
      Start 20: 5MW_OC3Trpd_DLL_WSt_WavesReg
13/26 Test #13: WP_VSP_WTurb .............................   Passed  221.97 sec
      Start 21: 5MW_OC4Jckt_DLL_WTurb_WavesIrr_MGrowth
14/26 Test  #7: AOC_YFree_WTurb ..........................   Passed  325.04 sec
      Start 22: 5MW_ITIBarge_DLL_WTurb_WavesIrr
15/26 Test #22: 5MW_ITIBarge_DLL_WTurb_WavesIrr ..........   Passed  126.16 sec
      Start 23: 5MW_TLP_DLL_WTurb_WavesIrr_WavesMulti
16/26 Test #16: SWRT_YFree_VS_EDC01 ......................   Passed  329.35 sec
      Start 24: 5MW_OC3Spar_DLL_WTurb_WavesIrr
17/26 Test #18: 5MW_Land_DLL_WTurb .......................   Passed  338.01 sec
      Start 25: 5MW_OC4Semi_WSt_WavesWN
18/26 Test #15: SWRT_YFree_VS_EDG01 ......................   Passed  527.96 sec
      Start 26: 5MW_Land_BD_DLL_WTurb
19/26 Test #24: 5MW_OC3Spar_DLL_WTurb_WavesIrr ...........   Passed  223.36 sec
20/26 Test #23: 5MW_TLP_DLL_WTurb_WavesIrr_WavesMulti ....   Passed  234.01 sec
21/26 Test #25: 5MW_OC4Semi_WSt_WavesWN ..................   Passed  418.38 sec
22/26 Test #19: 5MW_OC3Mnpl_DLL_WTurb_WavesIrr ...........   Passed  698.45 sec
23/26 Test #17: SWRT_YFree_VS_WTurb ......................   Passed  913.59 sec
24/26 Test #26: 5MW_Land_BD_DLL_WTurb ....................   Passed  791.96 sec
25/26 Test #20: 5MW_OC3Trpd_DLL_WSt_WavesReg .............   Passed  1707.53 sec
26/26 Test #21: 5MW_OC4Jckt_DLL_WTurb_WavesIrr_MGrowth ...   Passed  3096.17 sec

100% tests passed, 0 tests failed out of 26

@jrood-nrel
Copy link
Collaborator

I didn't go too far in depth with reading anything, but I browsed around the documentation for a bit and it looks like there is plenty of it, and I could find my way around, and it looks good. 👌

Copy link
Collaborator

@gantech gantech left a comment

Choose a reason for hiding this comment

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

Looks great. Thanks. I just noticed a couple of things in the Aerodyn documentation.

  1. Random sentences appear in bold. For instance in the "Unsteady Airfoil Aerodynamics Options" section.
  2. Could we turn off the section numbering beyond a certain level. We have sections that are numbered as "4.1.2.3.4. Unsteady Airfoil Aerodynamics Options".
  3. All figures seem to be missing.

If we want to target these issues on the next release, that's fine too.

@ghost ghost removed the request for review from HaymanConsulting September 29, 2017 14:46
@ghost
Copy link
Author

ghost commented Sep 29, 2017

Thanks for the feedback, @gantech

Random sentences appear in bold. For instance in the "Unsteady Airfoil Aerodynamics Options" section.
Confirmed by @michaelasprague, these are intentional

Could we turn off the section numbering beyond a certain level. We have sections that are numbered as "4.1.2.3.4. Unsteady Airfoil Aerodynamics Options".
Noted, lets discuss this again for the next iteration of documentation updates

All figures seem to be missing.
This was a conflict with an ad blocker installed in @gantech's browser

@ghost ghost removed the request for review from sayerhs September 29, 2017 16:24
@ghost ghost merged commit 1248820 into OpenFAST:dev Sep 29, 2017
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants