Release Notes
Changelog
All major changes are listed here.
0.6.3 (2023-07-18)
New Features
Enhanced bounding box object
Several new methods were added to the BBox object to make it easier to work with.
Create BBox objects in more ways:
BBox.from_bounds
as alias toBBox.from_cornerpts
and set default crs toEPSG:4326
BBox.from_point_and_buffer
to create a bbox from a x,y-point, a buffer size, and a crsBBox.utm_bbox_from_geographic_coordinate
to create a bbox from a geographic coordinate (point) and a buffer in meters, projecting to the appropriate UTM coordinates.
Simplified reproject to geographic and UTM coordinates
Added method
BBox.reproject_to_geographic()
to reproject a bbox to geographic coordinatesAdded method
BBox.reproject_to_utm()
to reproject a bbox to UTM coordinates
Return data in common GIS formats using:
Added method
BBox.polygon
property to return a shapely polygonAdded method
BBox.envelope()
to return an enveloped bbox in the current crs
Create a simple plot of your BBox using
BBox.plot()
Formatting improvements when writing .wrg/.rsf files
windkit.to_rsffile
andwindkit.to_wrgfile
now attempts to match the WAsP formatting more closely and a newformatters
argument allows the user to specify the formatting for each column. This allows for more control over the formatting of the output file. Additional formatting checks have also been added to ensure that the formatting is correct.
Require regulation_type for wtg data structures
The WindTurbineGenerator now requires a regulation_type variable. When reading in a WTG using
windkit.read_wtg
, the default mode is pitch. You can set it to stall or have it autodetected using the newwindkit.wind_turbine.estimate_regulation_type
function.Validation functions have been added to the WTG object type, so you can now ensure that your Dataset has the correct format before using the WTG.
Allow use of Polygons for defining landcover data
windkit.read_vector_map
Now can read polygon based landcover vector map files ingpkg
format, which is commonly used in GIS tools. The function has a new parameterbackground_lc_id
that is needed to setup the background for polygon based vector maps.
Changes
windkit.read_vector_map
: For landcover data ingpkg
format,id
is now the default name used to identify landcover ID’s in the landcover table. For oldgpkg
files where the nameindex
is used,windkit.read_vector_map
will print aFutureWarning
.Remove dependency on
cf-xarray
, as we have our own metadata vocabulary. This fixes an issue where Pooch was an optional dependency ofcf-xarray
, but required for the functionality used by WindKit.
BugFixes
Prevent exception when running in the python interpreter and calling
windkit.metadata.update_history
. Now a the generic message “Unknown python interpreter command.” is added to the object history in this scenario. To get a correct history, it is recommended to use iPython for interactive sessions.Fixed a bug in
BBox.buffer
, which would cause negative buffering to not preserve bbox shape
0.6.2 (2023-06-20)
New Features
New file reading functions
windkit.read_timeseries_from_pandas
andwindkit.read_timeseries_from_csv
build a time-series wind climatexarray.Dataset
from time-series data in tabular form, either apandas
Dataframe or acsv
file. The functions attempt to auto-detect the wind speed and wind direction columns based on a standard list of names if they are not provided.windkit.read_cfdres
reads a WAsP CFD.cfdres
file into anxarray.Dataset
structure.
Detection of CRS from WAsP .map files
windkit.read_vector_map
and by extensionwindkit.read_elevation_map
andwindkit.read_roughness_map
now try to detect CRS information from the header of WAsP.map
files, which can be added using recent versions of the WAsP MapEditor. In case there is a problem (e.g. wrong format) it will raise an error.
Updates to vertical profile plotting
windkit.plot.vertical_profile
Function now works for data arrays without their attributes set. If the height coordinate does not have attributes,Height [m]
will be used for the y-axis. If the data variable to plot does not have attributes,DataArray.name
will be used for the x-axis.windkit.plot.vertical_profile
no longer allows plotting of objects with atime
coordinate. This is due to performance limitations when plotting potentially thousands of points when a time-series object is passed.
Breaking changes
When creating a file using
windkit.to_rsffile
andwindkit.to_wrgfile
or reading a file usingwk.read_rsffile
andwk.read_wrgfile
, the elevation variable has been renamed fromelevation
tosite_elev
. This now matches the variable name used in PyWAsP.class
windkit.WindTurbines
does not allow wind turbinexarray.Dataset
with more than one mode.
Changes
windkit.spatial.nearest_points
will issue a warning instead of aValueError
when it is used on datasets with geographical coordinates.windkit.to_rsffile
andwindkit.to_wrgfile
calculate necessary parameters met_fields, “power_density”, “combined_A”, “combined_k”, and “wspd”, from a wwc if they aren’t included.
Bug Fixes
Fixed a formatting bug in
wk.to_rsffile
andwk.to_wrgfile
that resulted in incorrect column widths.
0.6.1 (2023-03-16)
New Features
windkit.wtg_cp
function returns the power_coefficient for given wind speeds from an wind turbine generator.Added lookup table to convert WAsP Map Editor named projections to EPSG codes. This allows for projection to be autodetected from some GWC files.
Breaking changes
Removed
coords
fromwindkit.read_gwc
. Instead you should use the separatewest_east
,south_north
, andheight
arguments. Also removed**kwargs
, as there was only a single optionheader
, which is now its own argument.
Changes
Updated pyproj dependency to minimum 3.0
Added
gen_heights
andgen_roughnesses
arguments towindkit.empty.empty_gwc
to allow users to specify these coordinate values.Removed the
mode
argument fromwindkit.wtg_power
,windkit.wtg_ct
, andwindkit.wtg_cp
, as they now work with any number of modes in the WTG. If you wish to use a single mode from a wind turbine object, you should select using theisel
orsel
method.
Bug Fixes
Allow projections that don’t have an EPSG code to be added using
windkit.spatial.add_crs
.Scalar spatial datasets would fail in
windkit.spatial.count_spatial_points
.Ensured that
wk.Workspace.get_gwc
could parse GWC objects from WAsP 12.7 and 12.8 workspaces.Fixed bug in
windkit.spatial.to_stacked_point
, where the order of thewest_east
andsouth_north
coordinates would be flipped from expected. This caused an issue when converting topoint
and then back tostacked_point
.Prevent creation of NaN values for some curves when using
windkit.read_wtg
to read.wtg
files with different modes and different wind speed tables.Bug fix in
wind_climate._is_bwc
where an exception was not properly caught.
0.6.0 (2023-01-29)
Several new features in this release including support for Wind Turbines, the ability to convert roughness lines to roughness polygons, and the ability to read PWC files. Several important bug fixes also added.
New Features
Support for wind turbines and AEP data
New metadata attributes for annual energy production and wind farm flow map
New class
windkit.WindTurbines
to hold collections of turbine locations and WTGs (power/ct curves and other details).Added metadata for wind turbine generator
xarray.Dataset
.New plotting function
windkit.plot.plot_wind_turbine_locations
.
Ability to convert roughness lines to polygons and back
New module
windkit.map_conversion
That allows the user to both create polygons from lines and convert polygons to lines, based ongeopandas.GeoDataFrame
. It contains the following:LineMap
andPolyMap
classes: These classes enable conversion and nice plotting of their types.lines2poly
andpoly2lines
helper functions that perform the conversion from lines to polygons and from polygons to line respectively, using the librarygeopandas.GeoDataFrame
.
New module
windkit.plot.landcover_map
to plot thegeopandas.GeoDataFrame
polygons or lines as a map.New module
windkit.plot.color
to provide color functions for maps with a focus on roughness coloring.Class
windkit.LandCoverTable
has a new methodadd_colors_to_table
to store colors to be used in map plots.
New spatial functionality
New function
windkit.spatial.interpolate_to_grid
to resample data to a target grid.New function
windkit.spatial.get_latitude
that returns data-array of latitude values in wgs84.New function
windkit.spatial.count_spatial_points
counts how many points are in a windkit dataset or dataarray.
Enhancements to windkit.get_map.get_ee_map
Added NASADEM as elevation dataset
Added worldcover as landcover dataset
Added option to convert to vector in the cloud.
Ability to read PWC files
windkit.read_pwcfile
reads WAsP.pwc
predicted wind climate file in XML format and returns a weibull wind climatexarray.Dataset
Breaking changes
Requires
geopandas>=0.11
.Requires
rioxarray
for reading raster GIS files.
Deprecations
Changes
To support
pyproj
3.4.0, changed frompyproj.crs.CRS.is_exact_same
topyproj.crs.CRS.equals
, and dropped deprecatedskip_equivalent
kwargs.Drop
south_north
andwest_east
coords before reassigning them as required in futurexarray
version.Added height dependent wind direction frequencies to GWC I/O routines
For the .lib-file reader frequencies are duplicated across all gen_heights
For the .lib-file writer a check is made to ensure all frequencies are these same across heights. If they are not, a gen_height is required to be set by the user.
Improvements
Sped up creation of .lib strings for GWC objects. In testing 15 sites, went from 11s to <1.
Retain meta data of
wsbin
coordinates now also present after combiningbwc
’s
Bug Fixes
Windkit.wwc_mean_windspeed
andwindkit.wwc_power_density
previously calculated emergent wind case using all-sector A&k values. Now it is correctly calculated using sectorwise, and an error is thrown if bothemergent
andbysector
kwargs areTrue
.Fixed reading
tif
andgrd
files with negativedx
.Catch exception in
wind_climate._is_bwc
.Prevent modification of input dataset when calling
weibull_wind_climate.weibull_combined
.Return point or stacked-point dataset for when calling
windkit.spatial.create_dataset
with duplicatedwest_east
andsouth_north
values. Previously a cuboid was returned with duplicated points collapsed.Use fixed column parsing in
read_rsf/read_wrg
rather than space splitting, when reading the number of sectors.Ensure temporary file created when using
windkit/get_map.py
is always removed.Create correct BWC when reading data with with irregular bins (i.e. as exported from windpro).
0.5.1
Changed name of author’s attributes from name/email to author/author_email
Fixed bug for 1d nearest point estimation. The KDtree throws an error if we do not expand the 2d point [x,y] to [[x],[y]]
Removed unneeded dependencies
0.5.0
New Features
Added functions
read_wrgfile
andto_wrgfile
to read and write .wrf resource grid filesAdded functions for simple wind-related calculations:
windkit.wind_speed_and_direction
calculates wind speed and direction from horizontal wind vectors U and Vwindkit.wind_vectors
calculates horizontal wind vectors U and V from wind speed and directionwindkit.wind_direction_difference
calculates the smallest (signed) circular difference between wind directions in degrees.windkit.wind_speed
calculates horizontal wind speed from vectors U and Vwindkit.wind_direction
calculates horizontal wind direction from vectors U and Vwindkit.wd_to_sector
to calculate the bin-index for wind directions for a given number of bins/sectors
Support for new Xarray-based Wind Turbine Generator (WTG) object added
New wind climate dataset validator function and decorator.
The function receives an
xarray.Dataset
and returnsTrue
orFalse
.The decorator wraps a function that receives a wind climate dataset and raises a
WindClimateValidationError
if the dataset is not valid.It checks dimensions, attributes and data variables.
The functions available are:
bwc_validate
,bwc_validate_wrapper
for binned wind climate dataset, imported fromwindkit.binned_wind_climate
wwc_validate
,wwc_validate_wrapper
for weibull wind climate dataset, imported fromwindkit.weibull_wind_climate
gwc_validate
,gwc_validate_wrapper
for generalized wind climate dataset, imported fromwindkit.generalized_wind_climate
ts_validate
,ts_validate_wrapper
for time series wind climate dataset, imported fromwindkit.time_series_wind_climate
New
WindClimateValidationError
, raised by the newly introduced wind climate dataset validators.New method
BBox.to_geoseries()
that converts Bounding box togeopandas.Geoseries
New
empty
module that generatesxarray.Dataset
instances filled with eitherNaN
or meaningful values.Suitable for testing.
Current available functions are:
empty.empty_wasp_site_factors()
: Create empty site-factors datasetempty.empty_bwc()
: Create empty binned wind climate dataset filled with meaningful random numbers, i.e. they are generated with a weibull distribution, the sum ofwdfreq
is 1, etc.empty.empty_wwc()
: Create empty weibull wind climate dataset filled with meaningful random numbers, e.g.the values fromA
are generated from a uniform function between5
and10
and the values fork
from a uniform function between1.5
and2.5
.empty.empty_gwc()
: Create empty generalized wind climate dataset with the data variables are filled with meaningful random numbers, e.g. the values fromA
are generated from a uniform function between5
and10
and the values fork
from a uniform function between1.5
and2.5
.empty.empty_met_fields()
: Create empty dataset filed withmet_fields
empty.empty_z0meso()
: Create empty site_factors with onlyz0meso
andslfmeso
empty.empty_pwc()
: Create empty predicted wind climate with optional variables
New plotting functions in module
windkit.plot
windkit.plot.vertical_profile()
plots the vertical profile of the dataArray or dataArrays introduced.windkit.plot.time_series()
creates a time series plot.windkit.plot.single_curve()
andwindkit.plot.power_ct_curves()
add plots for electrical power output curve, thrust curve, RPM, Ct, Cp or any other curve the user wants to pass through.
New function
windkit.time_series.read_ts_windpro_txt
Reads windpro format txt file into a
xarray.Dataset
Removed
Removed
windkit.binned_wind_climate.dir_to_sec
in favor ofwindkit.wd_to_sector
Modules
WaspVectorMap
andWaspRasterMap
were moved topywasp
and are no longer available.
Removed legacy WTG objet
WindTurbine
Changes
windkit/windturbine.py
Added function
read_wtg
to create anxarray.Dataset
representation of a turbineAdded
wtg_power
andwtg_ct
to return power and ct for given wind speedAdded
wtg_to_pywake
, which makes a PyWake wind turbine class from the dataset
renamed
vectormap
tovector_map
renamed
rastermap
toraster_map
renamed
elevationmap
toelevation_map
renamed
roughnessmap
toroughness_map
windkit.read_elevation_map
andwindkit.read_roughness_map
now reads both raster and vector maps.Changed the default behavior of
windkit.spatial.clip
for rasters/cuboids so small padding is added to the mask, ensuring that raster/cuboid pixels/cells on the edge of the mask are included in the clipping. The previous behavior can be achieved by settingpad=False
Updated
windkit.spatial.clip
forpoint
xr.dataset
to always include points that are on the edges of the mask (previously only points inside were included)Updated BWC “header” and GWC “desc” to both be named “wasp_header” (only included for objects originating from WAsP files or methods).
Updated to always use “crs” as spatial reference argument name
Mirrored
spatial.to_raster
asspatial.to_cuboid
Improvements
Updated
read_rsffile
andread_wrgfile
to automatically infer the number of sectors in the data.Updated
windkit.spatial.clip
so it uses a faster clipping method (_clip_to_bbox_raster
) when the masking is provided as aBBox
object. This speeds up clipping speed significantly.Allowed
ws_bins
to be pythonrange
inwindkit.binned_wind_climate._freqs_to_dataset()
Functions
windkit.spatial.to_point
andwindkit.spatial.to_raster_point
now also work on scalar datasets.Fix bug in
metadata.update_var_attrs
to store “Object type” as the string “None” to properly write to netCDFLandcover GMLs use custom reader/write to ensure compatibility with WAsP & Map Editor
Plotting documentation improved by rendering jupyter notebooks on it using
nbsphinx
extension forsphinx
Plotting testing with jupyter notebooks