WEIS Documentation

WEIS, Workflow for Energy with Integrated Servo-control, performs multi-fidelity co-design of floating platforms and energy systems. WEIS is a framework that combines multiple NREL-developed tools to enable design optimization of energy systems.

Important Links:

• Source Code Repository

WEIS Capabilities

• How WEIS works
• Capabilities and Examples
  • Overview of Capabilities
  • 1. Simulate Own OpenFAST Model
  • 2. Generate an OpenFAST Model from a WISDEM Component Model
  • 3. Design with OpenFAST
  • 4. Design in the Frequency Domain
  • 5. Controller Optimization
  • 6. Parametric Analysis
  • 7. Postprocessing Notebooks
  • 8. Potential Flow Modeling

WEIS Installation

• Installation
  • Pre-requisites
  • Installation Instructions
  • Using WEIS After Installation
  • Installing SNOPT for use within WEIS

Running WEIS

• Running WEIS
  • The WEIS Driver
  • Starting optimizations from previous runs
  • Running WEIS in parallel
  • Advanced Users and Developers

WEIS Inputs

• WEIS Inputs
  • Geometry Inputs
  • Modeling Options Inputs
  • Analysis Options Inputs

WEIS Modules

• WEIS Models
  • WISDEM
  • RAFT
  • OpenFAST
  • pCrunch
  • ROSCO
• Design Load Cases in WEIS
  • How to Set Up DLCs in WEIS
  • Reviewing DLC Cases
  • Expected DLC Outputs in OpenFAST
  • User-defined mapping and groups in the modeling options
  • Setting Up DLCs (for developers)
  • DLC Option Input Listing
• Optimization in WEIS
  • General Setup
  • Available Optimization Solvers
  • Comparison of Optimizers
  • Optimization and parallel performance
  • Optimization case study: IEA22 Platform optimization
  • Optimization case study: IEA22 Controller optimization
  • Troubleshooting

WEIS Outputs

• WEIS Outputs
  • File Structure & Location
  • OpenFAST-related
  • WISDEM/WEIS-related
  • DLC-related
  • Optimization-related

WEIS Visualization Application

• WEIS Visualization APP
  • Installation
  • WEIS Outputs
  • WEIS Inputs
  • Reference

Developer Documentation

• How to contribute code to WEIS
  • Issues
  • Documentation
  • Developing Python Modules Used in WEIS
  • Testing
  • Pull requests
• How to write docs for WEIS code
  • Introduction
  • Getting started with the docs
  • Sphinx and rst
  • General guidelines for formatting
  • Where should files related to documentation live?
  • Where should you contribute docs to?
  • How to convert existing docs
  • How to request doc creation

Indices and Tables

• Index

• Module Index

• Search Page