windkit.read_bwc
- windkit.read_bwc(filename, *, crs=None, file_format='infer', **kwargs)[source]
Creates binned wind climate xarray.Dataset from file.
- Parameters:
filename (str or Path) – Path to a file that can be opened as a bwc. This includes .tab, .owc, .omwc, and .nc that were created as bwc files. The script will use the file extension to determine the file type and then parse it into a bwc DataSet object.
crs (int, dict, str or pyproj.crs.CRS) – Value to initialize
pyproj.crs.CRS
Defaults to 4326 (Lat-Lon/WGS84 geodetic datum) for .tab, .owc and .omwc files.file_format (str) – The file format of the input file. If ‘infer’, the file format will be inferred from the file extension. Supported formats are ‘tab’, ‘owc’, and ‘omwc’. Defaults to ‘infer’.
**kwargs (dict) – Additional arguments to be passed to the file reader.
- Returns:
ds – binned wind climate dataset that is formatted to match the bwc description.
- Return type:
- Raises:
ValueError – If crs does not match dataset crs.
ValueError – If type of bwc is undetectable.