Skip to content

Commit

Permalink
Adding documentation for this example
Browse files Browse the repository at this point in the history
  • Loading branch information
genevievestarke committed Apr 18, 2024
1 parent 3bfba36 commit 93aeb68
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/deploy-pages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ jobs:
cp -v example_case_folders/05_floris_wind_standin_and_electrolyzer/README.md docs/examples/05_floris_wind_standin_and_electrolyzer.md
cp -v example_case_folders/06_amr_wind_standin_and_battery/README.md docs/examples/06_amr_wind_standin_and_battery.md
cp -v example_case_folders/07_amr_wind_standin_and_solar_pysam/README.md docs/examples/07_amr_wind_standin_and_solar_pysam.md
cp -v example_case_folders/08_floris_only/README.md docs/examples/08_floris_only.md
cp -v example_case_folders/09_amr_wind_openfast/README.md docs/examples/09_amr_wind_openfast.md
ls -l docs/examples
# Build the book
Expand Down
17 changes: 17 additions & 0 deletions example_case_folders/08_floris_only/README.md
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.
27 changes: 27 additions & 0 deletions example_case_folders/09_amr_wind_openfast/README.md
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.

0 comments on commit 93aeb68

Please sign in to comment.