README.md

Requirements * Installation * Testing

Wind Farm Plugin

Important

This software is Sandbox and subject to ECMWF's guidelines on Software Maturity.

The wind farm plume plugin implements wind farm models that run from an input wind field and wind turbine characteristics. It can be used to estimate the energy produced by a wind farm and (optionally) the system of interacting wakes that propagate behind each wind turbine. For more information on plume and plugins, see also:

• Plume: https://github.com/ecmwf/plume
• Plume example plugins: https://github.com/ecmwf/plume-examples

Requirements

Build dependencies:

• C/C++ compiler (C++17)
• Fortran 2008 compiler
• CMake >= 3.16 --- For use and installation see http://www.cmake.org/
• ecbuild >= 3.5 --- ECMWF library of CMake macros (https://github.com/ecmwf/ecbuild)

Runtime dependencies:

• eckit >= 1.18.0 (https://github.com/ecmwf/eckit)
• Atlas >= 0.36.0 (https://github.com/ecmwf/atlas)
• Plume >= 0.1.0 (https://github.com/ecmwf/plume)

Installation

The plugin employs an out-of-source build/install based on CMake. Make sure ecbuild is installed and the ecbuild executable script is found ( which ecbuild ). Now proceed with installation as follows:

# Environment --- Edit as needed
srcdir=$(pwd)
builddir=build
installdir=$HOME/.local

# 1. Create the build directory:
mkdir $builddir
cd $builddir

# 2. Run CMake
ecbuild --prefix=$installdir -- \
  -Deckit_ROOT=<path/to/eckit/install> \
  -Datlas_ROOT=<path/to/atlas/install> \
  -Dplume_ROOT=<path/to/plume/install> $srcdir

# 3. Compile / Install
make -j10
make install

Testing

To test the installation:

cd $builddir
make test

Licence

See LICENSE

Copyright

© 2025 ECMWF. All rights reserved.