forked from NREL/hercules
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding documentation for this example
- Loading branch information
1 parent
3bfba36
commit 93aeb68
Showing
4 changed files
with
46 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# Example 08: FLORIS Only | ||
|
||
## Description | ||
|
||
This example demonstrates how to use the FLORIS as the AMR Wind Standin model. This model uses the 'floris_runscript.py' in the bash file and still requires 'amr_input.inp' as an input file. | ||
|
||
## Running | ||
|
||
To run the example, execute the following command in the terminal: | ||
|
||
```bash | ||
bash sbash_script.sh | ||
``` | ||
|
||
## Notes | ||
|
||
Make sure hercules conda or venv is activated before running the example. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# Example 09: AMR Wind with OpenFAST | ||
## Description | ||
|
||
This example demonstrates how to run AMR Wind while also using OpenFAST and ROSCO as the turbine model. This example contains OpenFAST files for the NREL 5MW reference wind turbine. The support for this example in documentation is for running on an NREL supercomputer (either Eagle or Kestrel, both with sample bash files in the example). To run this example, you will need your own compiled version of AMR Wind, following the instructions in Section [Install via spack](install_spack). | ||
|
||
## Running | ||
|
||
To run the example, you will need to change some of the paths to match your own compilation of AMR Wind. You will need to follow the following steps to run this example: | ||
|
||
1) First, you will need to change line 36 in 'bash_kestrel.sh' to match your own path to your AMR Wind executable. | ||
|
||
2) Then, you will need to change line 77 in 'NRELOffshrBsline_5MW_Onshore_ServoDyn.dat' under the NREL-5MW folder to match your installation of the 'libdiscon.so' library in your ROSCO installation. | ||
|
||
3) Finally, you can submit your job to run on Kestrel using the following command in the terminal: | ||
|
||
|
||
```bash | ||
sbatch bash_kestrel.sh | ||
``` | ||
or run on Eagle using the following command in the terminal: | ||
|
||
```bash | ||
sbatch batch_script_eagle.sh | ||
``` | ||
|
||
## Notes | ||
This example uses precursor inflow files for AMR Wind from the SSC project on Kestrel and Eagle. Please let us know if you are interested in running this example and do not have access to these input files. |
File renamed without changes.