/floris

A controls-oriented engineering wake model. Documentation at

Primary LanguagePythonApache License 2.0Apache-2.0

FLORIS Wake Modeling and Wind Farm Controls Software

FLORIS is a controls-focused wind farm simulation software incorporating steady-state engineering wake models into a performance-focused Python framework. It has been in active development at NREL since 2013 and the latest release is FLORIS v3.0 in March 2022. The new v3 version of the repository contains an architectural redesign of the software to enable improved performance in AEP calculation and controls optimization.

We are actively seeking beta testers for the new framework. If you are interested in using FLORIS to conduct studies of a wind farm or extending FLORIS to include your own wake model, please get in touch! Join the conversations at GitHub Discussions.

For more context and background on previous work in FLORIS, see the documentation at http://floris.readthedocs.io/.

Installation

❗ It is highly recommended that you install FLORIS V3 into a new clean virtual environment. Installing into the existing V2 environment has been seen to cause conflicts. Further, if you wish to use pyoptsparse with FLORIS, it is recommended to install pyoptsparse into your environment prior to FLORIS

FLORIS can be installed by downloading the source code or via the PyPI package manager with pip.

The simplest method is with pip by using this command:

pip install floris

Developers and anyone who intends to inspect the source code, install FLORIS by downloading the git repository from GitHub with git and use pip to locally install it. It is recommended to use a Python virtual environment such as conda in order to maintain a clean and sandboxed environment. The following commands in a terminal or shell will download and install FLORIS v3.0.

    # Download the source code from the `main` branch
    git clone -b main https://github.com/NREL/floris.git

    # If using conda, be sure to activate your environment prior to installing
    # conda activate <env name>
    
    # If you would like to use pyoptspare, recommend installing before FLORIS
    conda install -c conda-forge pyoptsparse

    # Install into your Python environment
    pip install -e floris

With both methods, the installation can be verified by opening a Python interpreter and importing FLORIS:

    >>> import floris
    >>> help(floris)

    Help on package floris:

    NAME
        floris - # Copyright 2021 NREL

    PACKAGE CONTENTS
        logging_manager
        simulation (package)
        tools (package)
        type_dec
        utilities

    DATA
        ROOT = PosixPath('/Users/rmudafor/Development/floris')
        VERSION = '3.0'
        version_file = <_io.TextIOWrapper name='/Users/rmudafor/Development/fl...

    VERSION
        3.0

    FILE
        ~/floris/floris/__init__.py

It is important to regularly check for new updates and releases as new features, improvements, and bug fixes will be issued on an ongoing basis.

Getting Started

A series of examples is included in the examples/ directory. These are ordered from simplest to most complex. They demonstrate various use cases of FLORIS, and generally provide a good starting point for building a more complex simulation.

Engaging on GitHub

FLORIS leverages the following features of GitHub to coordinate support and development efforts:

  • Discussions: Collaborate to develop ideas for new use cases, features, and software designs, and get support for usage questions
  • Issues: Report potential bugs and well-developed feature requests
  • Projects: Include current and future work on a timeline and assign a person to "own" it

Generally, the first entry point for the community will be within one of the categories in Discussions. Ideas is a great spot to develop the details for a feature request. Q&A is where to get usage support. Show and tell is a free-form space to show off the things you are doing with FLORIS.

License

Copyright 2022 NREL

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.