The Wind-Plant Integrated System Design and Engineering Model (WISDEM®) is a set of models for assessing overall wind plant cost of energy (COE). The models use wind turbine and plant cost and energy production as well as financial models to estimate COE and other wind plant system attributes. WISDEM® is accessed through Python, is built using OpenMDAO, and uses several sub-models that are also implemented within OpenMDAO. These sub-models can be used independently but they are required to use the overall WISDEM® turbine design capability. Please install all of the pre-requisites prior to installing WISDEM® by following the directions below. For additional information about the NWTC effort in systems engineering that supports WISDEM® development, please visit the official NREL systems engineering for wind energy website.

Author: NREL WISDEM Team

See local documentation in the docs-directory or access the online version at https://wisdem.readthedocs.io/en/master/

WISDEM® is a family of modules. The core modules are:

• CommonSE includes several libraries shared among modules
• FloatingSE works with the floating platforms
• DrivetrainSE sizes the drivetrain and generator systems (formerly DriveSE and GeneratorSE)
• TowerSE is a tool for tower (and monopile) design
• RotorSE is a tool for rotor design
• NREL CSM is the regression-based turbine mass, cost, and performance model
• ORBIT is the process-based balance of systems cost model for offshore plants
• LandBOSSE is the process-based balance of systems cost model for land-based plants
• Plant_FinanceSE runs the financial analysis of a wind plant

The core modules draw upon some utility packages, which are typically compiled code with python wrappers:

• Airfoil Preppy is a tool to handle airfoil polar data
• CCBlade is the BEM module of WISDEM
• pyFrame3DD brings libraries to handle various coordinate transformations
• MoorPy is a quasi-static mooring line model
• pyOptSparse provides some additional optimization algorithms to OpenMDAO

Installation with Anaconda is the recommended approach because of the ability to create self-contained environments suitable for testing and analysis. WISDEM® requires Anaconda 64-bit.

The installation instructions below use the environment name, "wisdem-env," but any name is acceptable. For those working behind company firewalls, you may have to change the conda authentication with conda config --set ssl_verify no. Proxy servers can also be set with conda config --set proxy_servers.http http://id:pw@address:port and conda config --set proxy_servers.https https://id:pw@address:port. To setup an environment based on a different Github branch of WISDEM, simply substitute the branch name for master in the setup line.

1. Setup and activate the Anaconda environment from a prompt (Anaconda3 Power Shell on Windows or Terminal.app on Mac)

   conda config --add channels conda-forge
   conda env create --name wisdem-env -f https://raw.githubusercontent.com/WISDEM/WISDEM/master/environment.yml python=3.9
   conda activate wisdem-env
   

2. In order to directly use the examples in the repository and peek at the code when necessary, we recommend all users install WISDEM in developer / editable mode using the instructions here. If you really just want to use WISDEM as a library and lean on the documentation, you can always do conda install wisdem and be done. Note the differences between Windows and Mac/Linux build systems. For Linux, we recommend using the native compilers (for example, gcc and gfortran in the default GNU suite).

   conda install -y petsc4py mpi4py                 # (Mac / Linux only)
   conda install -y gfortran                        # (Mac only without Homebrew or Macports compilers)
   conda install -y m2w64-toolchain libpython       # (Windows only)
   git clone https://github.com/WISDEM/WISDEM.git
   cd WISDEM
   pip install -e .
   

NOTE: To use WISDEM again after installation is complete, you will always need to activate the conda environment first with conda activate wisdem-env

Each package has its own set of unit tests. These can be run in batch with the test_all.py script located in the top level test-directory.

For software issues please use https://github.com/WISDEM/WISDEM/issues. For functionality and theory related questions and comments please use the NWTC forum for Systems Engineering Software Questions.