Skip to content

Commit

Permalink
Add OWENS software listing (#6)
Browse files Browse the repository at this point in the history
* OWENS software listing addition

* Update OWENS database file to conform with schema
  • Loading branch information
kevmoor authored Jun 10, 2024
1 parent d22e116 commit a2395d7
Show file tree
Hide file tree
Showing 9 changed files with 130 additions and 4 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ To build the site, run the following command:
```bash
pip install -r docs/requirements.txt

cd docs/

jupyter-book build .
```

Expand All @@ -33,3 +35,4 @@ Or paste this line directly into your browser bar:
file://<removed>/wetostack/docs/_build/html/index.html
```
Note that the docs/_build folder must be removed and a rebuild done if changes to the software_attributes/database/ yamls are made.
8 changes: 6 additions & 2 deletions docs/capabilities/aero.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ mindmap
ps(Engineering-fidelity Physics Models)
OpenFAST
FAST.Farm
OWENS
hfm(High Fidelity Models)
AMR Wind
Expand Down Expand Up @@ -61,8 +62,8 @@ flowchart TD
C["WindSE
RANS, LES, time accurate, actuator disk"]
D["OpenFAST/FAST.Farm
Engineering models, time accurate, BEM-derived models + FVW"]
D["OpenFAST/FAST.Farm/OWENS
Engineering models, time accurate, BEM-derived models + FVW for HAWTs and VAWTs"]
E["FLORIS
Analytical, steady state"]
Expand Down Expand Up @@ -98,12 +99,15 @@ It is coupled to optimization algorithms for use in wind farm layout design.

**OpenFAST** includes actuator disk-based aerodynamics models including Blade Element
Momentum theory (BEMT) and Dynamic BEM (DBEMT).

**FAST.Farm** is a farm-level simulator building on OpenFAST, and it includes
a free vortex wake (FVW) model to simulate the wake of wind turbines within
a farm.
OpenFAST also includes TurbSim, a stochastic turbulence model, and InflowWind,
a tool for generating wind inflow conditions or OpenFAST simulations.

**OWENS** includes Actuator Cylinder (AC) and Double Multiple Streamtube (DMS) aerodynamics models including 3-D and unsteady approximations, with corrections for curved and deforming blades. OWENS is also coupled to the OpenFAST free vortex wake model for higher fidelity and multi-turbine capabilities.

**FLORIS** is a low fidelity simulator that includes steady state analytical
wind turbine wake models.
While this is explicitly not aerodynamics, this tool is useful for
Expand Down
4 changes: 3 additions & 1 deletion docs/portfolio_analysis/software_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ mindmap
FAST.Farm
MoorPy
RAFT
OWENS
hfm(High Fidelity Models)
AMR Wind
Expand Down Expand Up @@ -78,6 +79,7 @@ These projects are actively supported and funded by WETO as of FY23.
- FAST.Farm: https://github.com/openfast/openfast
- MoorPy: https://github.com/nrel/moorpy
- RAFT: https://github.com/WISDEM/RAFT
- OWENS: https://github.com/sandialabs/OWENS.jl

**High fidelity models**
- AMR-Wind: https://github.com/exawind/amr-wind
Expand Down Expand Up @@ -129,7 +131,6 @@ These projects are either funded outside of WETO, are not actively funded, or ar
- PyFrame3DD: https://github.com/WISDEM/pyFrame3DD
- CACTUS: https://github.com/sandialabs/CACTUS
- WEC-Sim/MOST: https://github.com/WEC-Sim/WEC-Sim and http://www.morenergylab.polito.it/most/
- OWENS: https://www.nrel.gov/docs/fy23osti/83748.pdf

*Deprecated or no longer supported:*
- ADAMS2AD: The MSC.ADAMS-to-AeroDyn (ADAMS2AD) interface is a software package for simulating the coupled dynamic response of horizontal-axis wind turbines.
Expand Down Expand Up @@ -241,3 +242,4 @@ The following GitHub organizations house some of the software projects supported
- https://github.com/openfast
- https://github.com/wisdem
- https://github.com/erf-model
- https://github.com/sandialabs
2 changes: 2 additions & 0 deletions docs/technical_areas/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ mindmap
FAST.Farm
MoorPy
RAFT
OWENS
ps(" ")
hfm(" ")
Expand All @@ -33,6 +34,7 @@ mindmap
- FAST.Farm https://github.com/openfast/openfast - Mid-fidelity wind farm simulator that uses OpenFAST as a turbine model.
- MoorPy https://github.com/nrel/moorpy - Quasi-static mooring model and a suite of associated functions for mooring system analysis.
- RAFT https://github.com/WISDEM/RAFT - Library for frequency-domain analysis of floating wind turbines.
- OWENS https://github.com/sandialabs/OWENS.jl - Multi-physics aero-servo-elastic tool with coupling to OpenFAST hydrodynamics and mooring for the coupled dynamic response of VAWTs and crossflow turbines.
````


Expand Down
3 changes: 3 additions & 0 deletions model_descriptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ This is a list of WETO-supported software projects.
- https://github.com/openfast
- https://github.com/wisdem
- https://github.com/erf-model
- https://github.com/sandialabs

## Physics simulators
FLORIS
Expand All @@ -21,6 +22,8 @@ OpenFAST
- matlab-toolbox
- weio

OWENS: End to end aero-servo-elastic preprocessing, simulation, and post processing for VAWTs and crossflow turbines.

SOWFA: Simulator for Wind Farm Applications
Release Date: June 27, 2016
This is a modular tool for simulating wind plant aerodynamics with computational fluid dynamics and turbine structural and control response to the incoming flow.
Expand Down
110 changes: 110 additions & 0 deletions software_attributes/database/owens.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
# General
github_account: sandialabs
github_repo: OWENS.jl
primary_uses:
- simulation
- optimization
active_funding: true
development_status: new_features
programming_language: julia
license_type: lgpl-3.0
data_collection_methods:
- modeling
last_release_date: "2024-04-10"

# Modeling
scope:
- turbine
- farm
system_type:
- vawt
system_location:
- any
time_domain:
- dynamic
- steady
turbine_model:
- multibody_bem
- vortex_method
wake_model:
- vortex_method
loads: true
design_optimization: true
costs: true
tags:
- sectional property preprocessing
- mass based cost
- jointed multi-body
- multi-turbine
- nonlinear or linear time domain simulation
- steady state simulation
- hydrokinetic fluid corrections
- linearization and export to pseudal spectral methods
- automated campbell diagram generation
- composite level stress
- ultimate failure checks
- buckling checks
- rainflow counting
- miner's rule fatigue acumulation
- automatic gradients
- VTK outputs

# Distribution
supported_platforms:
- any
package_manager:
- julia
package_manager_url:
- [email protected]:sandialabs/OWENS.jl.git
installation_complexity: 5

# Documentation
documentation_url: https://sandialabs.github.io/OWENS.jl/stable/
has_user_docs: true
has_developer_docs: true
has_api_docs: true
has_cli_docs: false
has_installation_docs: true
has_getting_started_docs: true
has_examples_tutorials: true
has_design_intent_statement: false
readability: 2
project_coverage: 2

# Testing
testing_framework: true
continuous_testing: true
test_coverage: 50
test_documentation: false
performance_tests: false

# Interfaces
first_class_ui:
- input_files
- library_interface
has_cli: true
language_interfaces:
- julia
feature_accessibility: 98

# Input / Output
filetypes:
- custom
file_structure_stability: semantic_versioning

# WETO Integrations
dependencies:
- - AeroDyn
- direct
- - MoorDyn
- direct
- - HydroDyn
- direct
- - Turbsim
- direct

# # Community Health
# open_issues: 0..N
# open_pull_requests: 0..N
# average_time_to_engage: 0..N
# outside_contributors: 0..N
1 change: 1 addition & 0 deletions software_attributes/database_list.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ active:
- openoa
- openturbine
- orbit
- owens
- pynumad
- raft
- rosco
Expand Down
1 change: 1 addition & 0 deletions software_attributes/get_repo_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
("https://github.com", "erf-model", "erf"),
("https://github.com", "openfast", "kitefast"),
("https://github.com", "openfast", "openfast"),
("https://github.com", "sandialabs", "OWENS.jl"),
("https://github.com", "nrel", "rosco"),
("https://github.com", "nrel", "rosco_toolbox"),
("https://github.com", "wisdem", "wisdem"),
Expand Down
2 changes: 1 addition & 1 deletion software_attributes/schema.py
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@
"description": "List the package managers leveraged to distribute the software.",
"type": "array",
"items": {
"enum": ["homebrew", "pypi", "conda", "conda-forge", "spack_manager"]
"enum": ["homebrew", "pypi", "conda", "conda-forge", "spack_manager", "julia"]
}
},
"package_manager_url": {
Expand Down

0 comments on commit a2395d7

Please sign in to comment.