Plant Schema#

Type: object

A file used as input or output of a wind farm model

#

Name

Type: string

Name of the wind energy system

#

definition of a site

Type: object

A file used as input or output of a wind plant model (for overall energy production estimation)

#

Name

Type: string

Name of the plant site

#

Boundaries


Definition of the site boundaries

Type: object

The following properties are required:

  • polygons
Type: object

The following properties are required:

  • circle

#

Polygons

Type: array

A group of polygons that define the site boundary

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Coordinates

Type: object

Multi-point coordinates

#

X coordinates

Type: array

West-East coordinates

Units: m

No Additional Items

#

Y coordinates

Type: array

South-North coordinates

Units: m

No Additional Items

#

Circle

Type: object

A circle

#

Center

Type: object

The center coordinate of a circle

#

X coordinate

Type: number

West-East coordinate

Units: m

#

Y coordinate

Type: number

South-North coordinate

Units: m

#

(Optional) Z coordinate

Type: number

Height coordinate

Units: m

#

(Optional) Coordinate reference system

Type: string

Coordinate reference system described as a PROJ string

#

Radius

Type: number

The radius of a circle

Units: m

#

Exclusions


Definition of any site exclusions

Type: object

The following properties are required:

  • polygons
Type: object

The following properties are required:

  • circle

#

Polygons

Type: array of object

A group of polygons that define the site exclusions

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: object

#

Circle

Type: object

A circle

#

Center

Type: object

The center coordinate of a circle

#

X coordinate

Type: number

West-East coordinate

Units: m

#

Y coordinate

Type: number

South-North coordinate

Units: m

#

(Optional) Z coordinate

Type: number

Height coordinate

Units: m

#

(Optional) Coordinate reference system

Type: string

Coordinate reference system described as a PROJ string

#

Radius

Type: number

The radius of a circle

Units: m

#

Energy resource

Type: object

TODO

#

Name

Type: string

Name of the plant resource

#

Wind resource


Resource where data optionally depend on windspeed, winddirection and/or position

Type: object

The following properties are required:

  • probability
Type: object

The following properties are required:

  • weibull_a
  • weibull_k
  • sector_probability
Type: object

The following properties are required:

  • time
  • wind_speed
  • wind_direction

#

Type: object

Timestamps for the data points

Data with custom dimensions

Type: array
No Additional Items

Each item of this array must be:


Type: number
Type: stringFormat: date-time

Data with custom dimensions

Type: object

Type: number
Type: stringFormat: date-time

#

Wind directions


Wind directions in degrees, [0,360]

Type: object

Data with custom dimensions

Type: object

#

Type: array
No Additional Items

Each item of this array must be:

Type: array or number
No Additional Items

#

Type: array
No Additional Items

Data with custom dimensions

Type: object

#

Type: number

#

Type: array

Must contain a maximum of 0 items

No Additional Items
Type: object
Same definition as time

#

Wind turbine IDs

Type: object

Wind turbine id

Data with custom dimensions

Type: array
No Additional Items

Each item of this array must be:


Type: number
Type: stringFormat: date-time

Data with custom dimensions

Type: object

Type: number
Type: stringFormat: date-time

#

#

Weibull scale

Type: object

Data with custom dimensions

Type: object

#

Type: array
No Additional Items

Each item of this array must be:

Type: array or number
No Additional Items

#

Type: array
No Additional Items

Data with custom dimensions

Type: object

#

Type: number

#

Type: array

Must contain a maximum of 0 items

No Additional Items

#

Weibull shape

Type: object

Data with custom dimensions

Type: object

#

Type: array
No Additional Items

Each item of this array must be:

Type: array or number
No Additional Items

#

Type: array
No Additional Items

Data with custom dimensions

Type: object

#

Type: number

#

Type: array

Must contain a maximum of 0 items

No Additional Items

#

probability of wind directions

Type: object

Probability of wind sector [0,1]

Data with custom dimensions

Type: object

#

Type: array
No Additional Items

Each item of this array must be:

Type: array or number
No Additional Items

#

Type: array
No Additional Items

Data with custom dimensions

Type: object

#

Type: number

#

Type: array

Must contain a maximum of 0 items

No Additional Items

#

Turbulence intensity

Type: object

Data with custom dimensions

Type: object

#

Type: array
No Additional Items

Each item of this array must be:

Type: array or number
No Additional Items

#

Type: array
No Additional Items

Data with custom dimensions

Type: object

#

Type: number

#

Type: array

Must contain a maximum of 0 items

No Additional Items

#

Reference height

Type: number

#

Shear

Type: object

#

Monin-Obukhov length (m)

Type: object

Data with custom dimensions

Type: object

#

Type: array
No Additional Items

Each item of this array must be:

Type: array or number
No Additional Items

#

Type: array
No Additional Items

Data with custom dimensions

Type: object

#

Type: number

#

Type: array

Must contain a maximum of 0 items

No Additional Items

#

Roughness height (m)

Type: object

Data with custom dimensions

Type: object

#

Type: array
No Additional Items

Each item of this array must be:

Type: array or number
No Additional Items

#

Type: array
No Additional Items

Data with custom dimensions

Type: object

#

Type: number

#

Type: array

Must contain a maximum of 0 items

No Additional Items

#

Turbulent kinetic energy

Type: object

Data with custom dimensions

Type: object

#

Type: array
No Additional Items

Each item of this array must be:

Type: array or number
No Additional Items

#

Type: array
No Additional Items

Data with custom dimensions

Type: object

#

Type: number

#

Type: array

Must contain a maximum of 0 items

No Additional Items

#

Turbulent dissipation

Type: object

Data with custom dimensions

Type: object

#

Type: array
No Additional Items

Each item of this array must be:

Type: array or number
No Additional Items

#

Type: array
No Additional Items

Data with custom dimensions

Type: object

#

Type: number

#

Type: array

Must contain a maximum of 0 items

No Additional Items

#

Potential Temperature (K)

Type: object

Data with custom dimensions

Type: object

#

Type: array
No Additional Items

Each item of this array must be:

Type: array or number
No Additional Items

#

Type: array
No Additional Items

Data with custom dimensions

Type: object

#

Type: number

#

Type: array

Must contain a maximum of 0 items

No Additional Items

#

Friction velocity (m/s)

Type: object

Data with custom dimensions

Type: object

#

Type: array
No Additional Items

Each item of this array must be:

Type: array or number
No Additional Items

#

Type: array
No Additional Items

Data with custom dimensions

Type: object

#

Type: number

#

Type: array

Must contain a maximum of 0 items

No Additional Items

#

Ground Temperature (K)

Type: object

Temperature of the ground in Kelvin

Data with custom dimensions

Type: object

#

Type: array
No Additional Items

Each item of this array must be:

Type: array or number
No Additional Items

#

Type: array
No Additional Items

Data with custom dimensions

Type: object

#

Type: number

#

Type: array

Must contain a maximum of 0 items

No Additional Items

#

Stability of the atmosphere

Type: object

Roughness length in meters

Data with custom dimensions

Type: object

#

Type: array
No Additional Items

Each item of this array must be:

Type: array or number
No Additional Items

#

Type: array
No Additional Items

Data with custom dimensions

Type: object

#

Type: number

#

Type: array

Must contain a maximum of 0 items

No Additional Items

#

atmoshpheric boundary layer height

Type: object

Data with custom dimensions

Type: object

#

Type: array
No Additional Items

Each item of this array must be:

Type: array or number
No Additional Items

#

Type: array
No Additional Items

Data with custom dimensions

Type: object

#

Type: number

#

Type: array

Must contain a maximum of 0 items

No Additional Items

#

Capping inversion thickness in units of meters

Type: object

Data with custom dimensions

Type: object

#

Type: array
No Additional Items

Each item of this array must be:

Type: array or number
No Additional Items

#

Type: array
No Additional Items

Data with custom dimensions

Type: object

#

Type: number

#

Type: array

Must contain a maximum of 0 items

No Additional Items

#

capping inversion strength in units of Kelvin

Type: object

Data with custom dimensions

Type: object

#

Type: array
No Additional Items

Each item of this array must be:

Type: array or number
No Additional Items

#

Type: array
No Additional Items

Data with custom dimensions

Type: object

#

Type: number

#

Type: array

Must contain a maximum of 0 items

No Additional Items

#

capping inversion height in units of meters

Type: object

Data with custom dimensions

Type: object

#

Type: array
No Additional Items

Each item of this array must be:

Type: array or number
No Additional Items

#

Type: array
No Additional Items

Data with custom dimensions

Type: object

#

Type: number

#

Type: array

Must contain a maximum of 0 items

No Additional Items

#

lapse rate in units of K/m

Type: object

Data with custom dimensions

Type: object

#

Type: array
No Additional Items

Each item of this array must be:

Type: array or number
No Additional Items

#

Type: array
No Additional Items

Data with custom dimensions

Type: object

#

Type: number

#

Type: array

Must contain a maximum of 0 items

No Additional Items

#

Coriolis Parameter

Type: object

Data with custom dimensions

Type: object

#

Type: array
No Additional Items

Each item of this array must be:

Type: array or number
No Additional Items

#

Type: array
No Additional Items

Data with custom dimensions

Type: object

#

Type: number

#

Type: array

Must contain a maximum of 0 items

No Additional Items

#

Sheer stress x

Type: object

Data with custom dimensions

Type: object

#

Type: array
No Additional Items

Each item of this array must be:

Type: array or number
No Additional Items

#

Type: array
No Additional Items

Data with custom dimensions

Type: object

#

Type: number

#

Type: array

Must contain a maximum of 0 items

No Additional Items

#

Sheer stress y

Type: object

Data with custom dimensions

Type: object

#

Type: array
No Additional Items

Each item of this array must be:

Type: array or number
No Additional Items

#

Type: array
No Additional Items

Data with custom dimensions

Type: object

#

Type: number

#

Type: array

Must contain a maximum of 0 items

No Additional Items

#

Bathymetry

Type: object

x, y, and depth field of water depth

#

Coordinates

Type: object

An array of x and y coordinates associated with different depths

Same definition as Coordinates

#

Type: array of number
No Additional Items

Each item of this array must be:

Type: number

An array of depth values

Units: m

#

Elevation

Type: object

TODO

#

Roads

Type: object

TODO

#

Definition of the wind energy conversion system

Type: object

A file used to define either a single wind farm or multiple wind farms with turbine type mappings and additional built environment components

#

Type: string

Name of the wind farm or wind farm system

#


Position of wind turbines. Supports single or multiple layouts.

Type: object

#

Coordinates

Type: object

List of turbine coordinates for this layout

Same definition as Coordinates
Type: array of object
No Additional Items

Each item of this array must be:

Type: object

#

Coordinates

Type: object

List of turbine coordinates for this layout

Same definition as Coordinates

#

Type: array of integer

(Optional) List of turbine types corresponding to turbine positions.

 No Additional Items

Each item of this array must be:

Type: integer

#

Type: array of string

List of turbine id/tags

 No Additional Items

Each item of this array must be:

Type: string

#

Turbine Definition

Type: object

(Optional) The full turbine definition for the entire wind farm

#

Name

Type: string

Name of the turbine definition

#

Performance


Definition of the turbine performance characteristics

Type: object

The following properties are required:

  • Cp_curve
  • Ct_curve
Type: object

The following properties are required:

  • power_curve
  • Ct_curve
Type: object

The following properties are required:

  • rated_power
  • rated_wind_speed
  • cutin_wind_speed
  • cutout_wind_speed
  • Ct_curve

#

Cp curve

Type: object

A turbine Cp curve

#

Cp values

Type: array

An array of Cp values

 No Additional Items

#

Wind speed values

Type: array

Wind speed values for the matching Cp values

 No Additional Items

#

Power curve

Type: object

A tubine power curve

#

Power values

Type: array

An array of power values

 No Additional Items

#

Wind speed values

Type: array

Wind speed values for the matching power values

 No Additional Items

#

Ct curve

Type: object

A turbine Ct curve

#

Ct values

Type: array

An array of Ct values

 No Additional Items

#

Wind speed values

Type: array

Wind speed values for the matching Ct values

 No Additional Items

#

Rated wind speed

Type: number

Units: m/s

#

Cut-in wind speed

Type: number

Units: m/s

#

Cut-out wind speed

Type: number

Units: m/s

#

Rated speed

Type: number

Units: W

#

Generator Efficiency

Type: number

The efficiency of converting mechanical to electrical power

Value must be greater or equal to 0 and lesser or equal to 1

#

Hub height

Type: number

Units: m

#

Rotor diameter

Type: number

Units: m

#

Tip-speed ratio

Type: number

#

Type: object

(Optional) List of turbine types used for layouts. Required if turbine_types is used in layouts.

#

Each additional property must conform to the following schema

Turbine Definition

Type: object

A simplified (from the turbine schema) definition of the turbines used in the plant.

Same definition as turbines

#

Type: array of object

Information about electrical substations

 No Additional Items

Each item of this array must be:

Type: object

#

Electrical substation

Type: object

#

Substation coordinates

Type: object

Multi-point coordinates

#

X coordinates

Type: array

West-East coordinates

Units: m

No Additional Items

#

Y coordinates

Type: array

South-North coordinates

Units: m

No Additional Items

#

Substation capacity

Type: number

Capacity of the electrical substation in megawatts

Units: MW

#

Electrical collection array

Type: object

Definition of electrical collection array (cable layout) for wind farm.

#

Edges of cable layout

Type: array

List of edges (branches) in the cable layout [[fromnode, tonode, cable_type], ...].

 No Additional Items

#

Cables

Type: object

List of the cables

#

Cable type

Type: array

List of available cable types

Units: mm^2

No Additional Items

#

Cross section

Type: array

List of cable cross sections

Units: mm^2

No Additional Items

#

Cable capacity

Type: array

List of cable capacities

 No Additional Items

#

Cable cost

Type: array

List of cable costs

Units: USD/m

No Additional Items

#

Attributes

Type: object

Specific attributes of the entire wind energy system

#

Flow model

Type: object

Flow model used in wind farm design

#

Flow model name

Type: string

#

Type: object

#

Wind deficit model

Type: object

Wake wind deficit model used in AEP calculations

#

Wake model name

Type: enum (of string)

Must be one of:

  • "Jensen"
  • "Bastankhah2014"
  • "Bastankhah2016"
  • "TurbOPark"
  • "SuperGaussian"

#

wake expansion coefficient

Type: object

#

Wake expansion coefficient

Type: number

#

Factor to multiply TI

Type: number

#

Flag deciding to use freestream or waked TI

Type: boolean

#

Bastankhah c_epsilon factor

Type: number

#

flag to use freestream wind speed for deficit computation

Type: boolean

#

axial induction model

Type: enum (of string)

Must be one of:

  • "1D"
  • "Madsen"

#

Deflection model

Type: object

defines the deviation of the path of the wake centerline in the crossflow direction (only for wake steering)

#

Deflection model name

Type: enum (of string)

Must be one of:

  • "None"
  • "Jimenez"
  • "Batankhah2016"

#

Jimenez deflection coefficient

Type: number

#

Turbulence model

Type: object

Turbulence model used in AEP calculations

#

Turbulence model name

Type: enum (of string)

Must be one of:

  • "STF2005"
  • "STF2017"
  • "IEC-TI-2019"
  • "CrespoHernandez"
  • "GCL"
  • "None"

#

coefficients

Type: array
No Additional Items

#

Superposition model

Type: object

Superposition model used in AEP calculations

#

Speed superposition model name

Type: enum (of string)

Must be one of:

  • "Linear"
  • "Squared"
  • "Max"
  • "Product"

#

TI superposition model name

Type: enum (of string)

Must be one of:

  • "Linear"
  • "Squared"
  • "Max"
  • "Product"

#

Rotor average

Type: object

Rotor averaging model used in AEP calculations

#

Grid type

Type: string

#

Number of x grid points

Type: integer

#

Number of y grid points

Type: integer

#

Averaging model for background velocity and TI

Type: enum (of string)

Must be one of:

  • "center"
  • "grid"

#

Averaging model for wake velocity and TI deficit

Type: enum (of string)

Must be one of:

  • "center"
  • "grid"

#

Type: number

#

Type: number

#

Blockage model

Type: object

Blockage averaging model used in AEP calculations

#

Blockage model name

Type: enum (of string)

Must be one of:

  • "None"
  • "RankineHalfBody"
  • "Rathmann"
  • "SelfSimilarityDeficit"
  • "SelfSimilarityDeficit2020"

#

Blockage Model Parameters

Type: array
No Additional Items

#

Information to handle parallel runs on HPC clusters

Type: object

#

number of nodes used to run the wind farm flow case

Type: integer

#

number of tasks per node

Type: integer

#

wall time for each run

Type: integer

#

run partition name

Type: string

#

wckey name if any

Type: string

#

number of nodes used to run the wind farm flow case

Type: integer

#

number of tasks per node

Type: integer

#

wall time for each run

Type: integer

#

run partition name

Type: string

#

meshing the wind farm domain for code_saturne calculation

Type: object

#

provide new mesh for the domain with farm characteristics

Type: boolean

#

mesh file path/name, existing if remesh is False

Type: string

#

type of run with the flow api

Type: enum (of string)

Must be one of:

  • "simulate"
  • "postprocess"

#

description of the layers needed for the APM model

Type: object

#

height of the layer containing the farm

Type: number

#

number of layers in the free atmosphere

Type: integer

#

list of terms added to the APM model

Type: object

#

momentum flux parametrization above the farm

Type: object

#

type of APM momentum flux parametrization

Type: enum (of string)

Must be one of:

  • "None"
  • "constant_flux"

#

APM momentum flux parametrization settings

Type: object

settings for APM momentum flux parametrization (only used when mfptype is "constantflux")

#

momentum flux scaling parameter

Type: number

#

momentum flux IBL growth scaling parameter

Type: number

#

dispersive stresses parametrization

Type: object

#

type of APM dispersive stresses parametrization

Type: enum (of string)

Must be one of:

  • "None"
  • "subgrid"

#

settings for the APM grid

Type: object

#

APM grid size in x-direction

Type: number

#

APM grid size in y-direction

Type: number

#

APM grid spacing

Type: number

#

APM grid filter length

Type: number

#

settings for wake model coupling in high-fidelity atmospheric models

Type: object

#

wake model coupling method

Type: enum (of string)

wake model coupling method (see https://dx.doi.org/10.1088/1742-6596/2767/9/092079)

Must be one of:

  • "VM"
  • "PB"
  • "US"

#

method-specific settings for wake model coupling in atmospheric model

Type: object

#

Ratio of filter length to shape function spacing

Type: number

Ratio of filter length to shape function spacing used by the VM method. Has to be specified when using "VM", no effect otherwise.

#

Upstream distance

Type: number

Upstream distance where the background velocity is evaluated. Has to be specified when using "US", no effect otherwise.

#

choice of wake tool for coupling to atmospheric flow model

Type: string

#

settings for the subgrid on which wake model velocities are defined

Type: object

#

Whether or not a subgrid is included

Type: boolean

Whether or not a subgrid is included. Can not be False when using VM or when using the "subgrid" dispersive stress parametrization.

#

Ratio of average turbine diameter to subgrid spacing

Type: number

#

Outputs

Type: object

Output parameters and configurations for the wind energy system

#

output folder name

Type: string

name of the folder where the output files are written

#

Handling of simulation runs


Type: object

#

Time-based run configuration

Type: object

#

active to run all the occurences from the time series

Type: boolean

#

list of times to run

Type: array
No Additional Items

Each item of this array must be:


Type: stringFormat: date-time
Type: integer
Type: object

#

Wind speeds configuration

Type: object

#

run all available wind speeds

Type: boolean

#

specific wind speeds to run

Type: array of number
No Additional Items

Each item of this array must be:

Type: number

#

Wind directions configuration

Type: object

#

run all available wind directions

Type: boolean

#

specific wind directions to run

Type: array of number
No Additional Items

Each item of this array must be:

Type: number

#

outputs related to each turbine

Type: object

outputs for each turbine as the individual turbine power, velocity..

#

Name of the file that will contain the turbine outputs

Type: string

this is an netcdf file containing the required outputs

#

Output Variables

Type: array of string

List of turbine variables to output

 No Additional Items

Each item of this array must be:

Type: string

#

configuration of the flow field outputs

Type: object

flow field output variables and files

#

Report

Type: boolean

Flag to output flow fields

#

Name of the file that will contain the flow field

Type: string

this is an netcdf file containing the required outputs

#

Output Variables

Type: array of string

List of flow field variables to output

 No Additional Items

Each item of this array must be:

Type: string

#

planes at which the flow field variables will be stored

Type: object

description of vertical planes

#

type of vertical discretization

Type: enum (of string)

Must be one of:

  • "hub_heights"
  • "plane_list"

#

z plane values for sample type 'grid'

Type: array of number
No Additional Items

Each item of this array must be:

Type: number

#

type of horizontal discretization

Type: enum (of string)

Must be one of:

  • "grid"
  • "original_grid"

#

x bounds for sample type 'grid'

Type: array of number
No Additional Items

Each item of this array must be:

Type: number

#

y bounds for sample type 'grid'

Type: array of number
No Additional Items

Each item of this array must be:

Type: number

#

number of points in the x direction for 'grid'

Type: integer

#

number of points in the y direction for 'grid'

Type: integer

#

x grid spacing for sample type 'grid'

Type: number

#

y grid spacing for sample type 'grid'

Type: number

#

Outputs

Type: object

Output parameters and configurations for the wind energy system

#

Output Name

Type: string

Name for the output configuration

#

Flow Field

Type: object

Configuration for flow field output

#

Time

Type: array of integer

Specific times for flow field output

 No Additional Items

Each item of this array must be:

Type: integer

#

Output Variables

Type: array of string

List of flow field variables to output

 No Additional Items

Each item of this array must be:

Type: string

#

Type: object

#

List of design variables

Type: object

Design variables of the system

#

Array of design variables

Type: object

😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️

#

Wind turbine types installed

Type: object

😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️

#

Number of turbines installed

Type: object

#

Hub heights of installed turbines

Type: object

#

Optimisation method

Type: object

Optimisation method used for layout design

#

Optimisation method name

Type: string

#

Optimisation constraints functions

Type: object

List of constraint functions

#

Minimum inter-turbine spacing


Ellipse min. spacing constraint

Type: object

#

Spacing along the ellipse major axis

Type: number

#

Spacing along the ellipse minor axis

Type: number

#

Orientation angle of the ellipse

Type: number

Circular min. spacing constraint

Type: object

#

Uniform spacing or radius of circle

Type: number

#

Parcels and exclusion zones

Type: object

#

List of parcel polygons

Type: object

Definition of the site boundaries

Type: object

The following properties are required:

  • polygons
Type: object

The following properties are required:

  • circle

#

Polygons

Type: array

A group of polygons that define the site boundary

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Coordinates

Type: object

Multi-point coordinates

Same definition as Coordinates

#

Circle

Type: object

A circle

#

Center

Type: object

The center coordinate of a circle

#

X coordinate

Type: number

West-East coordinate

Units: m

#

Y coordinate

Type: number

South-North coordinate

Units: m

#

(Optional) Z coordinate

Type: number

Height coordinate

Units: m

#

(Optional) Coordinate reference system

Type: string

Coordinate reference system described as a PROJ string

#

Radius

Type: number

The radius of a circle

Units: m

#

List of exclusion zone polygons

Type: object

Definition of any site exclusions

Type: object

The following properties are required:

  • polygons
Type: object

The following properties are required:

  • circle

#

Polygons

Type: array of object

A group of polygons that define the site exclusions

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: object

#

Circle

Type: object

A circle

#

Center

Type: object

The center coordinate of a circle

#

X coordinate

Type: number

West-East coordinate

Units: m

#

Y coordinate

Type: number

South-North coordinate

Units: m

#

(Optional) Z coordinate

Type: number

Height coordinate

Units: m

#

(Optional) Coordinate reference system

Type: string

Coordinate reference system described as a PROJ string

#

Radius

Type: number

The radius of a circle

Units: m

#

Type: object

#

Initial layout

Type: object

A file used to define either a single wind farm or multiple wind farms with turbine type mappings and additional built environment components

#

Type: string

Name of the wind farm or wind farm system

#


Position of wind turbines. Supports single or multiple layouts.

Type: object

#

Coordinates

Type: object

List of turbine coordinates for this layout

Same definition as Coordinates
Type: array of object
No Additional Items

Each item of this array must be:

Type: object

#

Coordinates

Type: object

List of turbine coordinates for this layout

Same definition as Coordinates

#

Type: array of integer

(Optional) List of turbine types corresponding to turbine positions.

 No Additional Items

Each item of this array must be:

Type: integer

#

Type: array of string

List of turbine id/tags

 No Additional Items

Each item of this array must be:

Type: string

#

Turbine Definition

Type: object

(Optional) The full turbine definition for the entire wind farm

Same definition as turbines

#

Type: object

(Optional) List of turbine types used for layouts. Required if turbine_types is used in layouts.

#

Each additional property must conform to the following schema

Turbine Definition

Type: object

A simplified (from the turbine schema) definition of the turbines used in the plant.

Same definition as turbines

#

Type: array of object

Information about electrical substations

 No Additional Items

Each item of this array must be:

Type: object

#

Electrical substation

Type: object
Same definition as electrical_substation

#

Electrical collection array

Type: object

Definition of electrical collection array (cable layout) for wind farm.

#

Edges of cable layout

Type: array

List of edges (branches) in the cable layout [[fromnode, tonode, cable_type], ...].

 No Additional Items

#

Cables

Type: object

List of the cables

#

Cable type

Type: array

List of available cable types

Units: mm^2

No Additional Items

#

Cross section

Type: array

List of cable cross sections

Units: mm^2

No Additional Items

#

Cable capacity

Type: array

List of cable capacities

 No Additional Items

#

Cable cost

Type: array

List of cable costs

Units: USD/m

No Additional Items

#

Initial turbine types

Type: object

#

Initial number turbines

Type: object

#

Initial turbine hub heights

Type: object

#

Type: object

#

Final layout

Type: object

A file used to define either a single wind farm or multiple wind farms with turbine type mappings and additional built environment components

#

Type: string

Name of the wind farm or wind farm system

#


Position of wind turbines. Supports single or multiple layouts.

Type: object

#

Coordinates

Type: object

List of turbine coordinates for this layout

Same definition as Coordinates
Type: array of object
No Additional Items

Each item of this array must be:

Type: object

#

Coordinates

Type: object

List of turbine coordinates for this layout

Same definition as Coordinates

#

Type: array of integer

(Optional) List of turbine types corresponding to turbine positions.

 No Additional Items

Each item of this array must be:

Type: integer

#

Type: array of string

List of turbine id/tags

 No Additional Items

Each item of this array must be:

Type: string

#

Turbine Definition

Type: object

(Optional) The full turbine definition for the entire wind farm

Same definition as turbines

#

Type: object

(Optional) List of turbine types used for layouts. Required if turbine_types is used in layouts.

#

Each additional property must conform to the following schema

Turbine Definition

Type: object

A simplified (from the turbine schema) definition of the turbines used in the plant.

Same definition as turbines

#

Type: array of object

Information about electrical substations

 No Additional Items

Each item of this array must be:

Type: object

#

Electrical substation

Type: object
Same definition as electrical_substation

#

Electrical collection array

Type: object

Definition of electrical collection array (cable layout) for wind farm.

#

Edges of cable layout

Type: array

List of edges (branches) in the cable layout [[fromnode, tonode, cable_type], ...].

 No Additional Items

#

Cables

Type: object

List of the cables

#

Cable type

Type: array

List of available cable types

Units: mm^2

No Additional Items

#

Cross section

Type: array

List of cable cross sections

Units: mm^2

No Additional Items

#

Cable capacity

Type: array

List of cable capacities

 No Additional Items

#

Cable cost

Type: array

List of cable costs

Units: USD/m

No Additional Items

#

Final turbine types

Type: object

#

Final number turbines

Type: object

#

Final turbine hub heights

Type: object

This Page