Adding more sections to documentation.

deslaughter · May 14, 2024 · 87e2cb6 · 87e2cb6
1 parent 61bffb2
commit 87e2cb6
Show file tree

Hide file tree

Showing 15 changed files with 84 additions and 7 deletions.
diff --git a/docs/content/docs/analysis/aero-controller.png b/docs/content/docs/analysis/aero-controller.png
diff --git a/docs/content/docs/analysis/aero-curve.png b/docs/content/docs/analysis/aero-curve.png
diff --git a/docs/content/docs/analysis/case.png b/docs/content/docs/analysis/case.png
diff --git a/docs/content/docs/analysis/index.md b/docs/content/docs/analysis/index.md
@@ -0,0 +1,27 @@
+---
+title: 'Analysis'
+date: 2024-05-14T19:27:37+10:00
+weight: 6
+---
+
+The `Analysis` tab is where the user defines the operating points for the analysis. Multiple sets of operating points, or `Cases`, can be defined for the same model. `Cases` may include aerodynamic effects and a controller may be used adjust the pitch and torque to achieve steady state. Depending on if the `Aerodynamics` and `Controller` options are selected, the interface will include additional inputs for wind speed, trim gain, and rated wind speed. The following figure shows the interface for a `Case` without aerodynamics.
+
+![](case.png)
+
+### Operating Points
+
+For the case without aerodynamics, the operating points are defined by the number of points between a minimum and maximum rotor speed in RPMs. For the case with aerodynamics, the operating points are defined by an evenly spaced number of wind speeds between cut-in and cut-out. The rated wind speed is used to determine at which operating points to apply the controller 
+
+![](aero-controller.png)
+
+### Curve
+
+The `Curve` defines the relationship between `Rotor Speed` and `Blade Pitch` (no aerodynamics) or between `Wind Speed`, `Rotor Speed`, and `Blade Pitch` (with aerodynamics). The curve can be multiple points and the operating points at which the linearization is performed is calculated from this curve via spline interpolation. The curve may be imported from a CSV file by clicking the `Import` button. The file must have three columns:
+
+1. Wind Speed
+1. Rotor Speed
+1. Blade Pitch
+
+and comment rows may start with a `#`. For the structural case, the `Wind Speed` column is ignored. The `Curve` is plotted as shown in the following figure where the curve points are shown with `x` and the operating points are shown with lines and `o`.
+
+![](aero-curve.png)
diff --git a/docs/content/docs/evaluate/evaluate-error.png b/docs/content/docs/evaluate/evaluate-error.png
diff --git a/docs/content/docs/evaluate/evaluate-log.png b/docs/content/docs/evaluate/evaluate-log.png
diff --git a/docs/content/docs/evaluate/evaluate-openfast.png b/docs/content/docs/evaluate/evaluate-openfast.png
diff --git a/docs/content/docs/evaluate/evaluate-progress.png b/docs/content/docs/evaluate/evaluate-progress.png
diff --git a/docs/content/docs/evaluate/index.md b/docs/content/docs/evaluate/index.md
@@ -0,0 +1,46 @@
+---
+title: 'Evaluate'
+date: 2024-05-14T19:27:37+10:00
+weight: 7
+---
+
+The `Evaluate` tab runs a case to generate linearization files at each operating point. 
+
+### OpenFAST Executable
+
+The first step in performing an evaluation is to select the OpenFAST executable by clicking the `Browse` button as shown in the following figure. This action opens a dialog box to select the path to the executable. The dialog will default to the path of `openfast` in the system's path, if one is found.
+
+![evaluate-openfast](evaluate-openfast.png)
+
+
+### Evaluate Case
+
+The `Evaluate Case` card allows the user to evaluate the operating points in the selected case. The following figure shows the options:
+
+- Select Case: the analysis case for which the operating points will be evaluated
+- CPUs: the number of instances of OpenFAST to run in parallel to evaluate the operating points
+
+Clicking the `Start` button will launch OpenFAST to run each operating point. Clicking the `Cancel` button will stop any running operating point evaluations.
+
+![evaluate-progress](evaluate-progress.png)
+
+#### Operating Point Evaluations
+
+Each operating point is simulated using OpenFAST. Evaluations can have the following states:
+
+- Queued - waiting to run
+- Simulation - performing time-domain simulation to reach steady state
+- Linearization - linearizing the model at 1 or more points through a full rotor revolution
+- Complete - evaluation has completed successfully
+- Canceled - evaluation was canceled before completion
+- Error - OpenFAST encountered an error and aborted the evaluation
+
+All evaluations are terminated if OpenFAST encounters any errors. The dark blue progress bar indicates simulation progress with regards to the final time, `TMax`. The light blue progress bar indicates linearization progress which is based `NLinTimes`. 
+
+The following image shows the status when an error has occurred.
+
+![evaluate-error](evaluate-error.png)
+
+Clicking the `Log` button next to an operating point evaluation will display the output from OpenFAST as shown below.
+
+![evaluate-log](evaluate-log.png)
diff --git a/docs/content/docs/install-acdc/index.md → docs/content/docs/install/index.md b/docs/content/docs/install-acdc/index.md → docs/content/docs/install/index.md
@@ -1,5 +1,5 @@
 ---
-title: 'Install ACDC'
+title: 'Install'
 date: 2024-05-14T19:27:37+10:00
 weight: 2
 ---

diff --git a/docs/content/docs/install-acdc/project.png → docs/content/docs/install/project.png b/docs/content/docs/install-acdc/project.png → docs/content/docs/install/project.png
diff --git a/docs/content/docs/model/index.md b/docs/content/docs/model/index.md
@@ -4,7 +4,7 @@ date: 2024-05-14T19:27:37+10:00
 weight: 4
 ---
 
-The `Model` section of the ACDC application handles importing and modifying OpenFAST turbine models. The following figure shows the `Model` section before a model has been imported. The `Import` button opens a dialog for the user to select the main `.fst` file of an OpenFAST model. The main file and all referenced files are read and stored in the `Project` file. Fields relevant to performing linearization are also extracted and made available for user modification inside `ACDC`.
+The `Model` tab handles importing and modifying OpenFAST turbine models. The following figure shows the `Model` tab before a model has been imported. The `Import` button opens a dialog for the user to select the main `.fst` file of an OpenFAST model. The main file and all referenced files are read and stored in the `Project` file. Fields relevant to performing linearization are also extracted and made available for user modification inside `ACDC`.
 
 ![model](model.png)
 
@@ -13,6 +13,10 @@ After a model is imported, the list of OpenFAST files that were read are present
 
 ![imported files](imported-files.png)
 
-Below the list of imported files is the `Linearization Quick Setup` subsection which contains the main OpenFAST fields relevant to linearization, see the following figure. Clicking the `Defaults` button applies predefined linearization settings to the model to aid the user. Not all defaults are applicable to all models and the user should review these settings for their specific model.
+Below the list of imported files is the `Linearization Quick Setup` card which contains the main OpenFAST fields relevant to linearization, see the following figure. Clicking the `Defaults` button applies predefined linearization settings to the model to aid the user. Not all defaults are applicable to all models and the user should review these settings for their specific model.
 
-![linearization settings](lin-settings.png)
+![linearization settings](lin-settings.png)
+
+The `Modify File` card is located below 1Linearization Quick Setup`, and lets the user modify any of the fields parsed from the OpenFAST input files. This functionality can be used to tune the model if there are issues with the linearization or to study the design. 
+
+![modify file](modify-file.png)
diff --git a/docs/content/docs/model/modify-file.png b/docs/content/docs/model/modify-file.png
diff --git a/docs/content/docs/project/index.md b/docs/content/docs/project/index.md
@@ -4,10 +4,10 @@ date: 2024-05-14T19:27:37+10:00
 weight: 3
 ---
 
-The `Project` section of ACDC handles creating and opening project files which contain the data for building the OpenFAST models, setting up linearization, describing the analysis operating points, and running the simulations. The following figure shows the ACDC application when it is first started, and without a project loaded. It presents the options to create a new project, which opens a dialog to save a new project file, or to open an existing project, which opens a dialog to select the project file. A list of recently opened projects is also provided which will load the project file at the given path (full paths removed). 
+The `Project` tab handles creating and opening project files which contain the data for building the OpenFAST models, setting up linearization, describing the analysis operating points, and running the simulations. The following figure shows the `ACDC` application when it is first started, and without a project loaded. It presents the options to create a new project, which opens a dialog to save a new project file, or to open an existing project, which opens a dialog to select the project file. A list of recently opened projects is also provided which will load the project file at the given path (full paths removed). 
 
 ![Project](project.png)
 
-The next figure shows the Project section after a project has been loaded and displays the current project path and the last time the project was updated. Once a project is created or opened, the menu bar changes to display the other sections of the application.
+The next figure shows the `Project` tab after a project has been loaded and displays the current project path and the last time the project was updated. Once a project is created or opened, the menu bar changes to display the other sections of the application.
 
 ![Project Opened](project-opened.png)
diff --git a/docs/hugo.toml b/docs/hugo.toml
@@ -10,7 +10,7 @@ pygmentsUseClasses = true
 
 # Controls how many words are printed in the content summary on the docs homepage.
 # See https://gohugo.io/content-management/summaries/
-summaryLength = 30
+summaryLength = 10
 
 [[menu.main]]
 name = "Home"