Inputs

Configuration files for FLORIS are stored in the .json format, which is then parsed by floris.simulation.input_reader.InputReader and stored in python dictionaries. The file begins with file type, name of the FLORIS configuration, and a brief description of the FLORIS configuration:

"type": "floris_input",
"name": "floris_input_file_Example",
"description": "Example FLORIS Input file",
"floris_version": "v2.0.0,

Conversion Utility

FLORIS contains an input file conversion tool to update older files with the latest API changes. This utility is included as a Python command-line program in floris/share/preprocessor. It is executed by “running” the directory itself, and the syntax can be obtained by passing the “help” flag:

# From the floris/share directory
python preprocessor -h

An example usage is to convert an input file from v1.1.0 to the latest, v2.0.0:

python preprocessor -i big_farm.json -o big_farm_v2.json

This utility can convert older files to a newer version of FLORIS, but not the other way. It can also be used to generate a starter input file containing default values for the latest supported version by running with no arguments.

Model Inputs

The input file contains model information in three primary sections:

The Wake section describes the wake models and their corresponding parameters. Turbine configures the turbine geometry and performance parameters. Finally, the Farm section describes the layout of the turbines within the farm and the atmospheric conditions throughout.

For model-specifics required in each section, see the example input files and corresponding class documentation.

Sample Input File

A series of example input files are available in examples/other_jsons. The most basic comprehensive example is given at examples/example_input.json and included below. It describes a 2x2 wind turbine array modeling the NREL 5-MW wind turbine.

{
  "description": "Example FLORIS Input file",
  "farm": {
    "description": "Example 2x2 Wind Farm",
    "name": "farm_example_2x2",
    "properties": {
      "__comment__": "specified_wind_height of -1 uses the first turbine's hub height; After initialization, specified_wind_height is a free parameter.",
      "air_density": 1.225,
      "layout_x": [
        0.0
      ],
      "layout_y": [
        0.0
      ],
      "specified_wind_height": -1,
      "turbulence_intensity": [
        0.06
      ],
      "wind_direction": [
        270.0
      ],
      "wind_shear": 0.12,
      "wind_speed": [
        9.0
      ],
      "wind_veer": 0.0,
      "wind_x": [
        0
      ],
      "wind_y": [
        0
      ]
    },
    "type": "farm"
  },
  "floris_version": "v2.0.0",
  "logging": {
    "console": {
      "enable": true,
      "level": "INFO"
    },
    "file": {
      "enable": false,
      "level": "INFO"
    }
  },
  "name": "floris_input_file_Example",
  "turbine": {
    "description": "NREL 5MW",
    "name": "nrel_5mw",
    "properties": {
      "TSR": 8.0,
      "blade_count": 3,
      "blade_pitch": 0.0,
      "generator_efficiency": 1.0,
      "hub_height": 90.0,
      "ngrid": 5,
      "pP": 1.88,
      "pT": 1.88,
      "power_thrust_table": {
        "power": [
          0.0,
          0.0,
          0.1780851,
          0.28907459,
          0.34902166,
          0.3847278,
          0.40605878,
          0.4202279,
          0.42882274,
          0.43387274,
          0.43622267,
          0.43684468,
          0.43657497,
          0.43651053,
          0.4365612,
          0.43651728,
          0.43590309,
          0.43467276,
          0.43322955,
          0.43003137,
          0.37655587,
          0.33328466,
          0.29700574,
          0.26420779,
          0.23839379,
          0.21459275,
          0.19382354,
          0.1756635,
          0.15970926,
          0.14561785,
          0.13287856,
          0.12130194,
          0.11219941,
          0.10311631,
          0.09545392,
          0.08813781,
          0.08186763,
          0.07585005,
          0.07071926,
          0.06557558,
          0.06148104,
          0.05755207,
          0.05413366,
          0.05097969,
          0.04806545,
          0.04536883,
          0.04287006,
          0.04055141
        ],
        "thrust": [
          1.19187945,
          1.17284634,
          1.09860817,
          1.02889592,
          0.97373036,
          0.92826162,
          0.89210543,
          0.86100905,
          0.835423,
          0.81237673,
          0.79225789,
          0.77584769,
          0.7629228,
          0.76156073,
          0.76261984,
          0.76169723,
          0.75232027,
          0.74026851,
          0.72987175,
          0.70701647,
          0.54054532,
          0.45509459,
          0.39343381,
          0.34250785,
          0.30487242,
          0.27164979,
          0.24361964,
          0.21973831,
          0.19918151,
          0.18131868,
          0.16537679,
          0.15103727,
          0.13998636,
          0.1289037,
          0.11970413,
          0.11087113,
          0.10339901,
          0.09617888,
          0.09009926,
          0.08395078,
          0.0791188,
          0.07448356,
          0.07050731,
          0.06684119,
          0.06345518,
          0.06032267,
          0.05741999,
          0.05472609
        ],
        "wind_speed": [
          2.0,
          2.5,
          3.0,
          3.5,
          4.0,
          4.5,
          5.0,
          5.5,
          6.0,
          6.5,
          7.0,
          7.5,
          8.0,
          8.5,
          9.0,
          9.5,
          10.0,
          10.5,
          11.0,
          11.5,
          12.0,
          12.5,
          13.0,
          13.5,
          14.0,
          14.5,
          15.0,
          15.5,
          16.0,
          16.5,
          17.0,
          17.5,
          18.0,
          18.5,
          19.0,
          19.5,
          20.0,
          20.5,
          21.0,
          21.5,
          22.0,
          22.5,
          23.0,
          23.5,
          24.0,
          24.5,
          25.0,
          25.5
        ]
      },
      "rloc": 0.5,
      "rotor_diameter": 126.0,
      "tilt_angle": 0.0,
      "use_points_on_perimeter": false,
      "yaw_angle": 0.0
    },
    "type": "turbine"
  },
  "type": "floris_input",
  "wake": {
    "description": "wake",
    "name": "wake_default",
    "properties": {
      "combination_model": "sosfs",
      "deflection_model": "gauss",
      "parameters": {
        "wake_deflection_parameters": {
          "gauss": {
            "dm": 1.0,
            "eps_gain": 0.2,
            "use_secondary_steering": true
          }
        },
        "wake_turbulence_parameters": {
          "crespo_hernandez": {
            "ai": 0.8,
            "constant": 0.5,
            "downstream": -0.32,
            "initial": 0.1
          }
        },
        "wake_velocity_parameters": {
          "gauss_legacy": {
            "calculate_VW_velocities": true,
            "eps_gain": 0.2,
            "ka": 0.38,
            "kb": 0.004,
            "use_yaw_added_recovery": true
          }
        }
      },
      "turbulence_model": "crespo_hernandez",
      "velocity_model": "gauss_legacy"
    },
    "type": "wake"
  }
}