-
foxes.input.states.SingleStateField(data_source, output_vars, var2ncvar=
{}, fixed_vars={}, x_coord='x', y_coord='y', h_coord='height', sel=None, isel=None, interp_pars={}, bounds_extra_space=1000, height_bounds=None, **kwargs)[source] Constructor.
Parameters¶
- data_source: xarray.Dataset or str
The NetCDF dataset to read from, or a path to it.
- output_vars: list of str
List of variable names to read.
- var2ncvar: dict
Mapping from variable names to netCDF variable names.
- fixed_vars: dict
Mapping from variable names to fixed values.
- x_coord: str
Name of the x coordinate.
- y_coord: str
Name of the y coordinate.
- h_coord: str
Name of the height coordinate.
- sel: dict, optional
Subset selection via xr.Dataset.sel()
- isel: dict, optional
Subset selection via xr.Dataset.isel()
- interp_pars: dict
Interpolation parameters, passed to the interpolation function.
- 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
- kwargs: dict
Keyword arguments passed to the base class.