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

#

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

#

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


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

#

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

#

Capping Inversion

Type: boolean

#

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 the built environment (and other non-tangible components like O&M)

#

Type: string

Name of the wind farm

#

Type: object

Position of wind turbines

#

Wind turbine layout

Type: object

#

Wind turbine coordinate

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

#

Turbine Definition

Type: object

Turbine models installed in the WES

#

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: 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 aviable cable types

Units: mm2

No Additional Items

#

Cross section

Type: array

List of cables cross section

Units: mm2

No Additional Items

#

Cable capacity

Type: array

List of cable capacity

Units: WindTurbine / Cable

No Additional Items

#

Cable cost

Type: array

List of cables cost

Units: euro/meter

No Additional Items

#

Attributes

Type: object

Specific attributes of the entire wind energy system

#

Net AEP for the plant/site

Type: number

#

Gross AEP for the plant/site

Type: number

#

Wake array efficiency

Type: number

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

#

Type: object

#

Type: object