foxes.core.WindFarm.map_turbines_to_areas(areas, set_cluster=True, geojson_name_key='name')[source]

Maps turbines to areas.

Parameters

areas: list or str or pathlib.Path or dict

The areas to map turbines to. Accepted forms are: - list of AreaGeometry objects - list of (name, AreaGeometry) tuples for named areas - dict mapping names to AreaGeometry objects - path to GeoJSON file - GeoJSON dictionary

set_cluster: bool

If True, set each mapped turbine’s cluster_name to the mapped area name.

geojson_name_key: str or list of str

Preferred GeoJSON feature property key(s) used to read area names from GeoJSON inputs.

Returns

mapping: dict

A dictionary, where keys are area names and values are lists of turbine indices belonging to that area.