Skip to content

Commit

Permalink
documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
gbarter committed Feb 10, 2021
1 parent be2efe8 commit a0a0c1e
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 16 deletions.
3 changes: 3 additions & 0 deletions CAD/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Out of date?
Ansys model?
[WindIO2CAD](https://github.com/IEAWindTask37/windio2cad)
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,20 @@ Data in this repository includes:

## Requirements

Requirements for using the OpenFAST model:
* The OpenFAST input files are compatable with OpenFAST-v2.3+. This can be compiled [from source here](https://github.com/OpenFAST/openfast.git) or precompiled Windows binaries are [available for download](https://github.com/OpenFAST/openfast/releases/latest/download/windows_openfast_binaries.zip). More information on installing and running OpenFAST is available in [OpenFAST documention](https://openfast.readthedocs.io/en/master/).
*OpenFAST*:
* The OpenFAST input files are compatable with OpenFAST-v2.6+. This can be compiled [from source here](https://github.com/OpenFAST/openfast.git) or precompiled Windows binaries are [available for download](https://github.com/OpenFAST/openfast/releases/latest/download/windows_openfast_binaries.zip). More information on installing and running OpenFAST is available in [OpenFAST documention](https://openfast.readthedocs.io/en/master/).
* NREL's Reference OpenSource Controller (ROSCO) is required. This can be compile [from source here](https://github.com/nrel/rosco) or the precompiled Windows .dll is [available for download](https://github.com/NREL/ROSCO/releases/tag/v2.0.1).

*HAWC2*:
* HAWC2 can be acquired from its [homepage](https://www.hawc2.dk/)

*WISDEM*:
* WISDEM can be installed from its Github [repository](https://github.com/WISDEM/WISDEM).
* See the [documentation](https://wisdem.readthedocs.io) for installation and usage guides.

## Design Updates

If the IEA Wind Task 37 authors deems it appropriate, design updates will be uploaded to the repository and tagged with version numbers appropriately. This will ensure that any design oversights are addressed and that the input files stay current with model updates.
The IEA Wind Task 37 authors endeavor to keep the model input decks current with the latest releases and API changes. Errors and other issues pointed out by the community are also addressed to the extent that available resources make that possible. See the [Release Notes](blob/master/ReleaseNotes.md) for a detailed description of changes.

We also encourage the broader wind community to submit design updates either through Pull Requests or by reaching out to the authors. Community contributions that we are aware of include:
* [OrcaFlex implementation](https://github.com/IEAWindTask37/IEA-15-240-RWT/wiki/Frequently-Asked-Questions-(FAQ)#is-orcaflex-supported)
Expand Down
42 changes: 29 additions & 13 deletions ReleaseNotes.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
## IEA Wind 15-MW Release Notes
# IEA Wind 15-MW Release Notes

v 1.1
----------
## v 1.1

This update to the IEA Wind 15-MW Reference Wind Turbine attempts to address some of the modeling issues that have been pointed out by users. Larger redesign requests, such as a smaller diameter monopile, or higher specific power for the floating turbine, are not included as that would require a more significant allocation of resources (see the [Wiki FAQ](https://github.com/IEAWindTask37/IEA-15-240-RWT/wiki/Frequently-Asked-Questions-(FAQ)) for some extended answers to those topics).

The main themes of this update are the following:
**Major Changes**

* Many of the modeling tools have undergone changes and updates, so the files here have been updated to keep pace with API changes.

Expand All @@ -25,7 +24,7 @@ The main themes of this update are the following:
Blade mass change due to material properties


*Detailed OpenFAST changes*
**Detailed OpenFAST changes**

For the monopile variant:

Expand Down Expand Up @@ -80,18 +79,35 @@ For the UMaine Volturn-S floating variant:
Also added input files that invoke OLAF, the OpenFAST vortex particle method for aerodynamics (monopile variant only)


*Detailed WISDEM changes*
**Detailed HAWC2 changes**

Words
(Jenni / DTU to-do items)

*Detailed ROSCO changes*

**Detailed WISDEM changes**

Three WISDEM scripts remain:

* `run_model.py` : WISDEM analysis (no design optimization) of the IEA Wind 15-MW RWT. Uses the WindIO ontology file directly as input, along with `modeling_options.yaml` and `analysis_options.yaml`. Script also includes automated plotting of blade geometry, rotor performance, and tower geometry. The tabular data Excel sheet is also generated.

* `optimize_monopile_tower.py` : Script that can be used to optimize the tower and monopile diameter and thickness schedule. Uses the WindIO ontology file directly as input, along with `modeling_options_monopile.yaml` and `analysis_options_monopile.yaml`.

* `optimize_generator.py` : Script that can be used to optimize the permanent magnet synchronous generator.

For more information about WISDEM and how these scripts can be run, please see the WISDEM [documentation](https://wisdem.readthedocs.io) and [repository](https://github.com/WISDEM/WISDEM).


**Detailed ROSCO changes**

(just point folks to the ROSCO repo and commit logs?)


v 1.0
---------
Jan 2021: Officially tagged the v1.0 release, although there are still some outstanding issues
Apr-Nov, 2020: Series of minor fixes in model input files (see closed pull requests for details)
March 30, 2020: Finalization of OpenFAST and HAWC2 models in conjuction with release of report and media pieces
## v 1.0

* Jan 2021: Officially tagged the v1.0 release, although there are still some outstanding issues

* Apr-Nov, 2020: Series of minor fixes in model input files (see closed pull requests for details)

* March 30, 2020: Finalization of OpenFAST and HAWC2 models in conjuction with release of report and media pieces


File renamed without changes.

0 comments on commit a0a0c1e

Please sign in to comment.