foxes.input.states.ICONStates(input_files_nc, height_coord_default='height', height_coord_tke='height_2', time_coord='time', lat_coord='lat', lon_coord='lon', output_vars=None, var2ncvar=None, load_mode='fly', time_format=None, bounds_extra_space=0.0, height_bounds=None, interp_pars=None, icon_point_plot=None, utm_zone=None, **kwargs)[source]

Constructor.

Parameters

input_files_nc: str

The input netcdf file(s) containing, can contain wildcards, e.g. ‘2025*_icon.nc’

height_coord_default: str, optional

The default height level coordinate name in the data

height_coord_tke: str, optional

The height level coordinate name for TKE in the data

time_coord: str

The time coordinate name in the data

lat_coord: str

The latitude coordinate name in the data

lon_coord: str

The longitude coordinate name in the data

output_vars: list of str, optional

The output variables to load, if None, the default variables are loaded (FV.WS, FV.WD, FV.TI, FV.RHO)

var2ncvar: dict, optional

A dictionary mapping foxes variable names to the corresponding netcdf variable names.

load_mode: str

The load mode, choices: preload, lazy, fly. preload loads all data during initialization, lazy lazy-loads the data using dask, and fly reads only states index and weights during initialization and then opens the relevant files again within the chunk calculations.

time_format: str

The datetime parsing format string

bounds_extra_space: float or str, optional

The extra space, either float in m, or str for units of D, e.g. ‘2.5D’

height_bounds: tuple, optional

The (h_min, h_max) height bounds in m. Defaults to H +/- 0.5*D

interp_pars: dict, optional

Additional parameters for scipy.interpolate.griddata, e.g. {‘method’: ‘linear’, ‘fill_value’: None, ‘rescale’: True}

icon_point_plot: str, optional

Path to a plot file, e.g. wrf_points.png, to visualize the selected ICON grid points and the layout of the farm.

utm_zone: str or tuple, optional

Method for setting UTM zone in config, if not already set. Options are: - “from_grid”: get UTM zone from the centre of the (lon, lat) grid - “XA”: use given number X, letter A - (lon, lat): use given lon, lat values - None: do not set UTM zone, assume it is already set, typically during the wind farm creation.

kwargs: dict, optional

Additional parameters for the base class