windkit 2.1.0rc1__tar.gz → 2.2.0__tar.gz

{windkit-2.1.0rc1 → windkit-2.2.0}/.triage-policies.yml

@@ -1,4 +1,45 @@
 resource_rules:
+  merge_requests:
+    rules:
+      # Label merge requests as Stale after 6 months of inactivity
+      - name: Label stale merge requests
+        conditions:
+          state: opened
+          date:
+            attribute: updated_at
+            condition: older_than
+            interval_type: months
+            interval: 6
+          forbidden_labels:
+            - Stale
+        actions:
+          labels:
+            - Stale
+          comment: |
+            This merge request has been inactive for 6 months and has been labeled `~Stale`.
+
+            If it is still relevant, please rebase or comment to reset the
+            inactivity timer. Otherwise, it will be automatically closed in
+            3 months.
+
+      # Close merge requests 3 months after the Stale label was added
+      - name: Close stale merge requests
+        conditions:
+          state: opened
+          date:
+            attribute: updated_at
+            condition: older_than
+            interval_type: months
+            interval: 3
+          labels:
+            - Stale
+        actions:
+          status: close
+          comment: |
+            This merge request has been inactive and is being closed
+            automatically per our [stale merge request policy](CONTRIBUTING.md#stale-merge-requests).
+
+            If it is still relevant, feel free to reopen it.
   issues:
     rules:
       # Label issues as Stale after 6 months of inactivity

{windkit-2.1.0rc1 → windkit-2.2.0}/CHANGELOG.md

@@ -2,7 +2,138 @@
 
 All major changes are listed here.
 
-## Unreleased
+## [2.2.0 (2026-09-29)](https://docs.wasp.dk/windkit/v2.2.0/)
+
+windkit 2.2 contains breaking changes. Read *Upgrading from 2.1* before you upgrade.
+
+### Highlights
+
+* **More WAsP file formats**: `windkit.io.wasp` reads `.wtg`, `.map`, `.rsf`/`.wrg`, `.gwc` and `.wwh` files as plain dictionaries of numpy arrays, and writes `.map` and `.rsf`/`.wrg`.
+* **Results from WAsP workspaces**: `windkit.Workspace` reads the wind climates, site effects, AEP and turbines stored in a WAsP workspace, including workspaces whose projects use different CRSs.
+* **Radial basis function interpolation**: `interp_unstructured` and `interp_unstructured_like` gained `method="rbf"`, which, unlike `linear` and `cubic`, extrapolates beyond the source points.
+* **Wind directions relative to grid north**: `bwc_from_tswc` rotates true-north wind directions to the grid north of a projected CRS given as `wind_dir_crs`, and `windkit.spatial.grid_convergence` computes the angle between the two.
+* **`windkit` CLI**: `windkit configure` saves the name, email and institution that windkit stamps on datasets. windkit no longer prompts for them.
+
+### Upgrading from 2.1
+
+Most code runs unchanged. Check the following:
+
+* **Direction frequencies**: `validate_bwc`, `validate_wwc`, `validate_gwc`, `validate_geowc` and the functions that check their wind climate input now raise when `wdfreq` (`geo_wv_freq` for a geostrophic wind climate) does not sum to 1 at a location. Divide frequencies in percent by 100, or normalise them with `ds["wdfreq"] = ds["wdfreq"] / ds["wdfreq"].sum("sector")`.
+* **Net AEP**: `total_loss_factor` now compounds losses, so net AEP from a loss table with more than one loss is slightly higher than in 2.1.
+* **Author attributes**: datasets carry `author`, `author_email` and `institution` only if you set them, with `windkit configure` or the `WINDKIT_NAME`, `WINDKIT_EMAIL` and `WINDKIT_INSTITUTION` environment variables. windkit 2.1 and earlier still ask for any field left unset.
+* **Configuration**: `windkit.config.Settings` is removed; replace `windkit.config.CONFIG` with `windkit.config.get_config()`. windkit no longer installs `pydantic`, `pydantic-settings` or `toml`, so install them yourself if your code uses them.
+* **Nearest points**: `nearest_points` raises a `ValueError` when its result cannot keep the target's spatial structure, for example when two targets share a source point. Pass `windkit.spatial.to_point(target)` to get point output instead.
+* **Generated data**: the `create_*` functions that generate synthetic wind climates, site effects and time series return float32 variables, no longer add a size-one `height` or `point` dimension, and give different values for the same seed. Regenerate any stored reference output.
+* **Zip archives**: read a GeoPackage in a zip archive whose name lacks `.gpkg` with `spatial_format="vector"` and `file_format="gpkg"`.
+* **Errors**: import the exception classes from `windkit`, e.g. `windkit.WindkitValidationError`. Some functions now raise a different exception type; see *API Breaks*.
+
+### New features
+
+* `windkit.io.wasp` reads and writes more WAsP files as plain dictionaries of numpy arrays: `.wtg` (`read_wtg`, `parse_wtg_element`), `.map` (`read_map`, `write_map`, `format_map`), `.rsf`/`.wrg` (`read_rsf`, `write_rsf`, `format_rsf`), `.gwc` (`read_gwc`, `parse_gwc_element`) and `.wwh` workspaces (`read_wwh`, `parse_wwh_element`, `parse_wwh_member_element`).
+* `windkit.Workspace` reads the results WAsP stored in a workspace: `get_wwc`, `get_site_effects`, `get_aep` and `get_owc_weibull_fit` return one point per site, and warn when WAsP marked the results as out of date.
+* `windkit.Workspace` gained `get_wtg`, `get_mesoclimate`, `get_air_density_reference`, `get_parameters`, `get_ids` and `get_member`. The `ID` argument of the getters is optional when the workspace holds one object of that kind.
+* `windkit.Workspace` takes each object's CRS from its own WAsP project, and its getters accept `crs` for workspaces that state none. Workspace format 4.01.0002 is supported.
+* `ws_cdf` and `ws_freq_gt_mean` accept Weibull and time series wind climates; for these, `ws_cdf` takes `ws_bins`.
+* `mean_wind_speed`, `mean_power_density`, `mean_ws_moment`, `ws_cdf` and `ws_freq_gt_mean` accept `bysector=True` for time series wind climates, binning directions into `n_sectors` sectors (default 12). They used to ignore it.
+* `interp_unstructured` and `interp_unstructured_like` gained `method="rbf"`, based on scipy's `RBFInterpolator`. Unlike `linear` and `cubic`, it extrapolates beyond the source points. It interpolates horizontally only.
+* `bwc_from_tswc`, `create_bwc`, `read_bwc` and windIO BWC import accept `wind_dir_crs`. `bwc_from_tswc` rotates true-north directions to the grid north of that CRS; the others record the frame of the existing directions.
+* Added `windkit.spatial.grid_convergence`, which computes the grid convergence at a dataset's locations, or between two projections with `source=`.
+* Added `windkit.fill_elevation_nodata`, which fills NaN and infinite cells in an elevation raster.
+* `read_elevation_map`, `read_roughness_map` and `read_landcover_map` read a member of an open zip archive (`zipfile.ZipExtFile`) in the format its name gives.
+* Added the `windkit configure` command, which saves the name, email and institution stamped on datasets, and `windkit.config.get_config()`, which returns them.
+* `WindkitError`, `WindkitValidationError`, `WindkitFileFormatError` and `UnsupportedFileTypeError` can be imported from `windkit`.
+* `polygons_to_lines` and the `.map` writers accept `snap_tolerance`.
+* `nearest_points` gained `workers` for parallel queries (default 1).
+* `create_bwc` gained `wsbin_width`, `weibull_A` and `weibull_k` (each Weibull parameter a value or a `(low, high)` range), and `create_geowc` gained `weibull_A` and `weibull_k`.
+* `create_tswc` gained `fields`, which adds the stability variables `temp_scale` and `ustar_over_pblh`. Added `create_surface_fields`, which generates mesoscale surface fields.
+* Added `create_gewc`, `create_pewc` and `create_v50_lut`, which generate synthetic inputs for extreme wind calculations.
+
+### Bug fixes
+
+* `total_loss_factor` compounds losses as `prod(1 - p_i / 100)` instead of `1 - sum(p_i) / 100`, which understated the remaining energy and could go negative. `total_loss` still reports the plain sum; `loss_table_summary` shows both.
+* Reading a `.map` file applies the `z` scale and offset from its header, so elevations given in feet are converted to metres. A map whose header transforms `x` and `y` raises `NotImplementedError` instead of being misplaced.
+* Writing a `.map` file in a geographic CRS no longer rounds coordinates to one decimal, which moved them by up to 11 km.
+* Writing a `.map` file records a CRS without an EPSG code in the header instead of leaving it empty.
+* Writing a `.map` file with NaN in `elev`, `z0_left` or `z0_right` raises a `ValueError` instead of dropping those lines.
+* Reading a malformed `.map` file raises a `ValueError` naming the file and line instead of returning corrupted geometry.
+* `polygons_to_lines` accepts polygons with Z coordinates.
+* `snap_to_layer` no longer overwrites columns named `npoints`, `npoints_old` or `done`.
+* The deprecated `PolygonMap.to_line_map` works again with `complete_polys=True` and `complete_method="new"`.
+* `wwc_to_file` honours `use_production=True` for `.rsf`/`.wrg` files; it always wrote power density.
+* Writing `.rsf`/`.wrg` files no longer fails for heights of 100 m or more, large coordinates or a single-sector `wdfreq` of 1. `site_elev` is rounded instead of truncated, and non-integer WRG header values keep one decimal.
+* Reading an `.rsf`/`.wrg` file from an open file object no longer skips its first two lines.
+* `read_lib` reads rows wrapped across lines, and raises a `ValueError` for a truncated file instead of hanging.
+* `read_bwc` and the `windkit.io.wasp` readers read UTF-16 files without a byte-order mark, and ignore a UTF-8 byte-order mark.
+* `windkit.read_gwc` keeps the file's description, and raises a `ValueError` naming the element for a malformed `.gwc` file instead of filling in NaN or zeros.
+* `windkit.read_wtg` reads `.wtg` files that omit `StationaryThrustCoEfficient`, deriving it from the thrust curve. It rejects an invalid `FormatVersion`, which made a stall-regulated turbine read as pitch-regulated.
+* A GeoPackage read from a zip archive member picks its layer as for a file path, instead of taking the first one listed.
+* The Weibull fit functions return NaN where the moments cannot be fitted, instead of raising (without numba) or returning meaningless values (with numba).
+* The Weibull fit functions accept numpy arrays, scalars, 0-d and integer inputs with and without numba. `fit_weibull_k_sumlogm` respects `order_m_first` and `order_m_higher`, and `weibull_fit` no longer copies the attributes of the moments onto `A` and `k`.
+* `quantiles=True` works for the `windkit.ltc` MCP classes, which shifted every sector by one at `predict`. `wd_to_sector(quantiles=True)` accepts arrays of any shape, and puts a direction on an inner sector edge in the upper sector.
+* `ws_freq_gt_mean` of a time series skips missing samples instead of counting them as below the mean.
+* `shear_exponent` and `wind_veer` raise a `WindkitValidationError` for input without a vertical profile, instead of returning an empty result or an unrelated error. Duplicate heights at a location are dropped instead of giving `inf`.
+* `interp_unstructured` and `interp_unstructured_like` raise a clear `ValueError` for an unknown `method`, and for keyword arguments with `method="natural"`.
+* `wspd_deficit` and `wspd_deficit_sector` have units `-` instead of `m s-1`.
+* AEP and flow map datasets describe all their variables; gross AEP was described as potential AEP.
+* `create_bwc` no longer shifts its histogram half a bin low, which put the mean wind speed about 6 % below what `A` and `k` imply. It warns when the wind speed axis is too short for the distribution.
+* `create_geowc` honours `wsbin_width`, and its default wind speed axis (60 bins instead of 10) covers the distribution.
+* `create_wasp_site_effects` no longer fills `user_def_speedups` and `obstacle_speedups` with 0 or draws a `z0meso` of 0, which made downstream results NaN or degenerate. Its speedups are drawn from narrower, plausible ranges, and points of a `point` structure at the same location share their height-independent values, such as `site_elev` and `z0meso`.
+* `windkit.plot.histogram(style="interactive")` works again.
+* A missing optional dependency raises an `ImportError` naming the extra to install, e.g. `pip install "windkit[plots]"`.
+
+### API Breaks
+
+* Removed `windkit.config.Settings` and the conversion of `windkit.ini` files from before windkit 1.0.
+* windkit no longer depends on `pydantic`, `pydantic-settings` or `toml`.
+* Removed the `formatters` argument of `wwc_to_file` for `.rsf`/`.wrg` files. Unknown keyword arguments to the `.rsf`/`.wrg` readers and writers raise `TypeError`.
+* `elevation_map_to_file`, `roughness_map_to_file` and `landcover_map_to_file` raise `TypeError` for `mode="a"` when writing a `.map` file.
+* `mean_ws_moment` requires a scalar `moment`.
+* `nearest_points` with `n_nearest > 1` requires a point target.
+* `windkit.Workspace.catalogue` holds each object's XML element under `"Element"` instead of its XPath under `"XPATH"`.
+* The Google Earth Engine map functions raise `ImportError` when `earthengine-api` is missing (was `ValueError`) and `RuntimeError` when Earth Engine is not authenticated. Earth Engine is initialised on first use instead of at import.
+* `windkit.read_wtg` raises `lxml.etree.XMLSyntaxError` instead of `xml.etree.ElementTree.ParseError` for invalid XML (both subclass `SyntaxError`), and a `ValueError` naming the file for other malformed files.
+* A `.map` file with displacement heights raises `ValueError` instead of `RuntimeError`.
+
+### Breaking changes
+
+* `validate_bwc`, `validate_wwc`, `validate_gwc` and `validate_geowc` reject a wind climate whose `wdfreq` (`geo_wv_freq` for a geostrophic wind climate) does not sum to 1 at each location. All-NaN locations are exempt.
+* `combine_bwcs` raises a `ValueError` for inputs with different sectors, instead of returning an invalid dataset.
+* `nearest_points` keeps the target's spatial structure only when the selected source points represent it exactly, and raises a `ValueError` otherwise. It warns when `dims` leaves out a spatial coordinate of the source, and raises a `ValueError` for invalid lookups.
+* `snap_to_layer`, and so `polygons_to_lines`, raise a `ValueError` when `tolerance` is at least a ring's median vertex spacing, instead of returning invalid geometry.
+* `create_bwc`, `create_wwc`, `create_gwc`, `create_geowc`, `create_pwc`, `create_met_fields`, `create_tswc`, `create_tswc_pair` and `create_wasp_site_effects` keep a scalar height or a single location as given, instead of adding a size-one `height` or `point` dimension. Their data variables are float32, with the spatial dimensions first.
+* Converting between spatial structures no longer adds `height` to height-independent variables such as `elevation`, `roughness`, `z0meso` and surface fields like `T2`.
+* `create_wasp_site_effects` gives the effective displacement `displ` the height structure of the input, and `site_effects="all"` includes `flow_sep_height`.
+* User attribution is opt-in. windkit no longer prompts for a name, email and institution, which crashed non-interactive sessions, and no longer writes them to disk. Datasets carry `author`, `author_email` and `institution` only for fields set with `windkit configure` or the `WINDKIT_NAME`, `WINDKIT_EMAIL` and `WINDKIT_INSTITUTION` environment variables.
+* A zip archive member passed to `read_elevation_map`, `read_roughness_map` or `read_landcover_map` is read in the format its name gives, instead of as a GeoPackage.
+* `windkit.Workspace` places an observed or generalized wind climate at the met station that holds it, instead of at the last met station in the file. Printing a workspace shows a tree of all its objects.
+* The wind speed statistics name their results the same way for every wind climate type: `mean_wind_speed`, `mean_power_density`, `wind_speed_moment`, `wind_speed_cdf` and `wind_speed_fgtm`. Time series results are float64.
+
+### Deprecations
+
+* `windkit.Workspace.get_object`, and the `west_east`, `south_north`, `height` and `description` arguments of `windkit.Workspace.get_gwc`, will be removed in windkit 3.0. Use the getter for the object, and set coordinates or `description` on the returned dataset.
+* `windkit.config.CONFIG` will be removed in windkit 3.0; use `windkit.config.get_config()`. It now returns a frozen dataclass, so pydantic methods such as `model_dump()` are gone.
+
+### Performance
+
+* `polygons_to_lines` and `snap_to_layer` are several times faster, up to 70 times on maps with many small polygons. Output is unchanged, except that near-zero-area slivers get their sides assigned robustly.
+* `nearest_points` is faster and keeps the source data lazy.
+* `interp_unstructured` and `interp_unstructured_like` with `nearest`, `linear` or `cubic` build one interpolator for all sectors and wind speed bins instead of one per slice.
+* Reading and writing `.map` files, and writing `.rsf`/`.wrg` files, is faster.
+
+### Changes
+
+* Malformed WAsP files raise `WindkitFileFormatError` naming the file. It subclasses `ValueError`, so `except ValueError` still catches it. `UnsupportedFileTypeError` now subclasses `WindkitError`.
+* `read_owc` raises for malformed files, such as sectors with different numbers of bins or duplicate sectors, instead of zero-filling them.
+* `windkit.read_wtg` rejects a performance table without `StationaryThrustCoEfficient` whose thrust curve is all zeros.
+* `.map` files are read with any line ending and with automatic encoding detection, and written as UTF-8. Reading without `map_type` infers it, and a `map_type` that no `.map` file holds, such as `"speedup"`, raises.
+* Writing a `.map` file warns when its CRS has no name in the WAsP map editor.
+* `WindkitValidationError` lists every problem found in its `errors` attribute.
+* `raster_plot` no longer calls `plt.show()`; display the returned figure yourself.
+* `tswc_from_dataframe` and `get_tutorial_data` log instead of printing.
+* `bwc_from_tswc` lists the dataset's dimensions in the order of its `wsfreq` variable.
+* `affine>=3.0` is a declared dependency, and the `plots` extra requires `dash>=2.11`.
+* The development environment supports `linux-aarch64` and `osx-arm64`, and needs pixi 0.68 or newer.
+* The documentation has a version switcher and a page on how AI coding assistants are used in windkit's development.
 
 ## [2.1.0 (2026-04-22)](https://docs.wasp.dk/windkit/v2.1.0/)
 
@@ -77,6 +208,7 @@ Added support for reading and writing wind data in the [windIO format](https://i
 
 ### Breaking changes
 
+* `bwc_from_tswc` now preserves singleton dimensions selected from TSWC inputs instead of stacking and unstacking through point structure; for example, `create_tswc(ds).isel(height=0)` now returns a BWC with the selected spatial dimensions rather than restoring `height: 1` and `stacked_point: 1`.
 * Minimum supported dependency versions raised: numpy 2.0, xarray 2024.9, pandas 2.3, scipy 1.13, geopandas 1.0, rasterio 1.4, pyproj 3.7, lxml 5.2, netcdf4 1.7. Users on older versions must upgrade.
 
 ### Deprecations
@@ -87,6 +219,7 @@ Added support for reading and writing wind data in the [windIO format](https://i
 ### Performance
 
 * Preserve MultiIndex when converting between point and stacked_point/raster structures, avoiding unnecessary re-stacking and leading to small performance improvements for large datasets in many windkit and pywasp functions.
+* Small performance improvement in `bwc_from_tswc` due to using vectorized numpy and dropping stack/unstack pattern.
 
 ### Changes
 

{windkit-2.1.0rc1 → windkit-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: windkit
-Version: 2.1.0rc1
+Version: 2.2.0
 Summary: WindKit provides core functionalities for working with wind resource data
 Author: DTU Wind Energy
 License-Expression: BSD-3-Clause
@@ -9,6 +9,7 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: affine>=3.0
 Requires-Dist: geopandas>=1.0
 Requires-Dist: h5netcdf
 Requires-Dist: lxml>=5.2
@@ -17,8 +18,6 @@ Requires-Dist: numpy>=2.0
 Requires-Dist: packaging>=24.1
 Requires-Dist: pandas>=2.3
 Requires-Dist: platformdirs>=4.3
-Requires-Dist: pydantic>=2.7
-Requires-Dist: pydantic-settings>=2.3
 Requires-Dist: pyproj>=3.7
 Requires-Dist: pyyaml
 Requires-Dist: rasterio>=1.4
@@ -26,12 +25,12 @@ Requires-Dist: requests
 Requires-Dist: rioxarray>=0.17
 Requires-Dist: scipy>=1.13
 Requires-Dist: shapely>=2.0
-Requires-Dist: toml
 Requires-Dist: xarray>=2024.9
 Provides-Extra: plots
 Requires-Dist: matplotlib>=3.9; extra == "plots"
 Requires-Dist: plotly>=5.21; extra == "plots"
 Requires-Dist: kaleido>=1.0; extra == "plots"
+Requires-Dist: dash>=2.11; extra == "plots"
 Provides-Extra: performance
 Requires-Dist: numba>=0.60; extra == "performance"
 Provides-Extra: data-apis
@@ -42,8 +41,8 @@ Requires-Dist: planetary-computer>=1.0; extra == "data-apis"
 Requires-Dist: pystac-client>=0.8; extra == "data-apis"
 Requires-Dist: zarr>=3.0; extra == "data-apis"
 Provides-Extra: dev
-Requires-Dist: dash; extra == "dev"
 Requires-Dist: ipython; extra == "dev"
+Requires-Dist: jupytext>=1.16; extra == "dev"
 Requires-Dist: nbval; extra == "dev"
 Requires-Dist: pre-commit; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
@@ -53,7 +52,6 @@ Requires-Dist: windIO; extra == "dev"
 Provides-Extra: doc
 Requires-Dist: docutils; extra == "doc"
 Requires-Dist: jupyter; extra == "doc"
-Requires-Dist: jupyter-dash; extra == "doc"
 Requires-Dist: jupyter-sphinx; extra == "doc"
 Requires-Dist: myst-parser; extra == "doc"
 Requires-Dist: nbsphinx; extra == "doc"
@@ -93,7 +91,7 @@ pip install windkit
 
 **conda:**
 ```bash
-conda install -c https://conda.windenergy.dtu.dk/channel/open windkit
+conda install -c https://conda.windenergy.dtu.dk/channel/open/ -c conda-forge windkit
 ```
 
 ## Quick Start
@@ -106,7 +104,7 @@ bwc = wk.read_bwc("hovsore.tab")
 
 # Calculate mean wind speed
 mean_ws = wk.mean_wind_speed(bwc)
-print(f"Mean wind speed: {mean_ws.values:.2f} m/s")
+print(f"Mean wind speed: {mean_ws.item():.2f} m/s")
 
 # Fit Weibull distribution and convert to Weibull wind climate
 wwc = wk.weibull_fit(bwc)
@@ -114,11 +112,13 @@ wwc = wk.weibull_fit(bwc)
 
 ## Features
 
-- **Wind Climate I/O** - Read/write binned, Weibull, generalized, and time-series wind climates (NetCDF, .lib, .tab, .rsf, .wrg)
-- **Map I/O** - Read/write elevation, roughness, and landcover maps (raster and vector formats)
-- **WAsP Integration** - Read WAsP Workspace files and WAsP Engineering project files
+- **Wind Climate I/O** - Read/write binned, Weibull, generalized, and time-series wind climates (NetCDF, .tab, .owc, .lib, .gwc, .rsf, .wrg, windIO YAML)
+- **Map I/O** - Read/write elevation, roughness, and landcover maps (raster and vector formats, including WAsP .map)
+- **WAsP Integration** - Read the inputs and results of WAsP workspaces (.wwh) and WAsP Engineering project files, with low-level readers for the WAsP file formats
 - **Spatial Processing** - Clip, reproject, and interpolate spatial data with full CRS support
 - **Wind Statistics** - Calculate mean wind speed, power density, Weibull parameters, and more
+- **Long-Term Correction** - Measure-correlate-predict (MCP) methods for time series
+- **Losses and Uncertainty** - Net AEP and exceedance values (P90) from loss and uncertainty tables
 - **Plotting** - Interactive plots with Plotly, static plots with Matplotlib
 - **Remote Data Access** - Download ERA5 reanalysis data and satellite-derived maps
 

{windkit-2.1.0rc1 → windkit-2.2.0}/README.md

@@ -22,7 +22,7 @@ pip install windkit
 
 **conda:**
 ```bash
-conda install -c https://conda.windenergy.dtu.dk/channel/open windkit
+conda install -c https://conda.windenergy.dtu.dk/channel/open/ -c conda-forge windkit
 ```
 
 ## Quick Start
@@ -35,7 +35,7 @@ bwc = wk.read_bwc("hovsore.tab")
 
 # Calculate mean wind speed
 mean_ws = wk.mean_wind_speed(bwc)
-print(f"Mean wind speed: {mean_ws.values:.2f} m/s")
+print(f"Mean wind speed: {mean_ws.item():.2f} m/s")
 
 # Fit Weibull distribution and convert to Weibull wind climate
 wwc = wk.weibull_fit(bwc)
@@ -43,11 +43,13 @@ wwc = wk.weibull_fit(bwc)
 
 ## Features
 
-- **Wind Climate I/O** - Read/write binned, Weibull, generalized, and time-series wind climates (NetCDF, .lib, .tab, .rsf, .wrg)
-- **Map I/O** - Read/write elevation, roughness, and landcover maps (raster and vector formats)
-- **WAsP Integration** - Read WAsP Workspace files and WAsP Engineering project files
+- **Wind Climate I/O** - Read/write binned, Weibull, generalized, and time-series wind climates (NetCDF, .tab, .owc, .lib, .gwc, .rsf, .wrg, windIO YAML)
+- **Map I/O** - Read/write elevation, roughness, and landcover maps (raster and vector formats, including WAsP .map)
+- **WAsP Integration** - Read the inputs and results of WAsP workspaces (.wwh) and WAsP Engineering project files, with low-level readers for the WAsP file formats
 - **Spatial Processing** - Clip, reproject, and interpolate spatial data with full CRS support
 - **Wind Statistics** - Calculate mean wind speed, power density, Weibull parameters, and more
+- **Long-Term Correction** - Measure-correlate-predict (MCP) methods for time series
+- **Losses and Uncertainty** - Net AEP and exceedance values (P90) from loss and uncertainty tables
 - **Plotting** - Interactive plots with Plotly, static plots with Matplotlib
 - **Remote Data Access** - Download ERA5 reanalysis data and satellite-derived maps
 

{windkit-2.1.0rc1 → windkit-2.2.0}/pyproject.toml

@@ -17,6 +17,7 @@ classifiers = [
 dynamic = ["version"]
 requires-python = ">=3.11"
 dependencies = [
+    "affine>=3.0",
     "geopandas>=1.0",
     "h5netcdf",
     "lxml>=5.2",
@@ -25,8 +26,6 @@ dependencies = [
     "packaging>=24.1",
     "pandas>=2.3",
     "platformdirs>=4.3",
-    "pydantic>=2.7",
-    "pydantic-settings>=2.3",
     "pyproj>=3.7",
     "pyyaml",
     "rasterio>=1.4",
@@ -34,7 +33,6 @@ dependencies = [
     "rioxarray>=0.17",
     "scipy>=1.13",
     "shapely>=2.0",
-    "toml",
     "xarray>=2024.9",
 ]
 
@@ -43,6 +41,7 @@ plots = [
     "matplotlib>=3.9",
     "plotly>=5.21",
     "kaleido>=1.0",
+    "dash>=2.11",
 ]
 performance = [
     "numba>=0.60",
@@ -56,8 +55,8 @@ data_apis = [
     "zarr>=3.0",
 ]
 dev = [
-    "dash",
     "ipython",
+    "jupytext>=1.16",
     "nbval",
     "pre-commit",
     "pytest",
@@ -68,7 +67,6 @@ dev = [
 doc = [
     "docutils",
     "jupyter",
-    "jupyter-dash",
     "jupyter-sphinx",
     "myst-parser",
     "nbsphinx",
@@ -85,10 +83,15 @@ doc = [
 ]
 
 [project.scripts]
+windkit = "windkit._cli:main"
 split_combomap = "windkit.topography.vector_map:_split_combo"
 
 [tool.setuptools_scm]
 write_to = "windkit/_version.py"
+# Between releases master is the *next minor* (2.2.0.devN after v2.1.0), so
+# a dev build can satisfy a >=2.2 pin; the default scheme would call it
+# 2.1.1.devN. On a vX.Y.x release branch the scheme bumps the patch instead.
+version_scheme = "release-branch-semver"
 
 [tool.setuptools]
 include-package-data = true
@@ -111,8 +114,25 @@ markers = [
     "performance: marks tests as performance tests (run with '-m performance')",
 ]
 
-# Added warning filter for warnings that show up for min dependencies.
-# These do not produce any errors and once packages are upgraded, these are not emitted
+# Third-party warnings raised inside upstream packages, not by windkit's own
+# calls. Each entry is pinned to message, category and module so that it stops
+# matching -- and the warning resurfaces for re-triage -- if upstream rewords
+# or fixes it. Warnings aimed at windkit's own code are fixed at the call site,
+# never listed here.
+#
+# pytest.warns re-emits the warnings it did not match, attributed to the
+# module of warnings.WarningMessage (`warnings`, or `_py_warnings` on
+# Python >= 3.14) rather than to the emitting module, so entries that can
+# fire inside a pytest.warns block list those two modules as well. The cost:
+# inside a pytest.warns block, the same message raised by windkit's own code
+# is hidden too, so those call sites must be covered by tests outside one.
 filterwarnings = [
-  "ignore:The 'shapely.geos' module is deprecated:DeprecationWarning:geopandas._compat",
+  # rioxarray (and rasterio) multiply Affine objects with `*`, which affine
+  # 3.0.1 deprecates in favour of `@`. rioxarray raises it from
+  # rioxarray._spatial_utils and rioxarray.rioxarray (0.17 through 0.22).
+  'ignore:Use `@` matmul instead of `\*` mul operator:PendingDeprecationWarning:(rioxarray|warnings|_py_warnings)(\.|$)',
+  'ignore:Use `@` matmul instead of `\*` mul operator:PendingDeprecationWarning:rasterio\.transform',
+  # pyogrio < 0.12 imports the deprecated shapely.geos module at import time;
+  # seen in the default-min environment only.
+  "ignore:The 'shapely.geos' module is deprecated:DeprecationWarning:pyogrio(\\.|$)",
 ]

{windkit-2.1.0rc1 → windkit-2.2.0}/windkit/__init__.py

@@ -9,6 +9,8 @@ __all__ = [
     "spatial",
     # Subpackage - LTC
     "ltc",
+    # Subpackage - io (loaded lazily on first access)
+    "io",
     # Wind
     "wind_speed",
     "wind_direction",
@@ -32,6 +34,12 @@ __all__ = [
     "tswc_to_file",
     "tswc_from_dataframe",
     "create_tswc_pair",
+    # Extreme wind climates
+    "create_gewc",
+    "create_pewc",
+    "create_v50_lut",
+    # Mesoscale surface fields
+    "create_surface_fields",
     # Binned wind climate
     "validate_bwc",
     "is_bwc",
@@ -76,6 +84,7 @@ __all__ = [
     "get_landcover_table",
     # Raster map
     "create_raster_map",
+    "fill_elevation_nodata",
     # Vector map
     "create_vector_map",
     "add_landcover_table",
@@ -147,9 +156,23 @@ __all__ = [
     # tutorial_data
     "get_tutorial_data",
     "load_tutorial_data",
+    # Errors
+    "WindkitError",
+    "WindkitValidationError",
+    "WindkitFileFormatError",
+    "UnsupportedFileTypeError",
 ]
 
+import importlib
+from typing import TYPE_CHECKING
+
 from windkit._version import version as __version__
+from windkit._errors import (
+    WindkitError,
+    WindkitValidationError,
+    WindkitFileFormatError,
+    UnsupportedFileTypeError,
+)
 from windkit import spatial
 from windkit import ltc
 from windkit.wind import (
@@ -178,6 +201,14 @@ from windkit.wind_climate.time_series_wind_climate import (
     create_tswc_pair,
 )
 from windkit.wind_climate import time_series_wind_climate  # noqa: F401
+from windkit.wind_climate.extreme_wind_climate import (
+    create_gewc,
+    create_pewc,
+    create_v50_lut,
+)
+from windkit.wind_climate import extreme_wind_climate  # noqa: F401
+from windkit.wind_climate.stability import create_surface_fields
+from windkit.wind_climate import stability  # noqa: F401
 from windkit.wind_climate.binned_wind_climate import (
     validate_bwc,
     is_bwc,
@@ -264,6 +295,7 @@ from windkit.topography.get_map import _get_ee_map, get_raster_map, get_vector_m
 from windkit.topography.landcover import LandCoverTable, get_landcover_table
 from windkit.topography.raster_map import (
     create_raster_map,
+    fill_elevation_nodata,
 )
 from windkit.topography.vector_map import create_vector_map, add_landcover_table
 from windkit.topography.topography import (
@@ -311,3 +343,21 @@ from windkit.xarray_structures.wsbin import (
     create_wsbin_coords,
 )
 from windkit.tutorial_data import get_tutorial_data, load_tutorial_data
+
+if TYPE_CHECKING:
+    from windkit import io  # noqa: F401
+
+# Subpackages guaranteed reachable after `import windkit` via lazy import on
+# first attribute access (PEP 562), independent of whether internal imports
+# happen to load them as a side effect (#713).
+_LAZY_SUBPACKAGES = ("io",)
+
+
+def __getattr__(name):
+    if name in _LAZY_SUBPACKAGES:
+        return importlib.import_module(f"windkit.{name}")
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
+
+
+def __dir__():
+    return sorted(set(globals()) | set(_LAZY_SUBPACKAGES))

windkit-2.2.0/windkit/_cli.py

@@ -0,0 +1,95 @@
+"""Command-line interface for windkit."""
+
+import argparse
+import sys
+
+from windkit import config
+
+_LABELS = {"name": "Name", "email": "Email", "institution": "Institution"}
+
+
+def _configure(args) -> int:
+    """Write the user attribution file from flags, the existing file and prompts."""
+    path = config._CONFIG_FILE
+    existing = config._read_config_file(path)
+    # sys.stdin is None when stdin is closed or under pythonw
+    interactive = sys.stdin is not None and sys.stdin.isatty()
+
+    values = {}
+    missing = []
+    for name in config._FIELD_NAMES:
+        given = getattr(args, name)
+        if given is not None:
+            values[name] = config._clean(given)
+        elif interactive:
+            default = existing.get(name)
+            suffix = f" [{default}]" if default else ""
+            answer = input(f"{_LABELS[name]}{suffix}: ")
+            values[name] = config._clean(answer) or default
+        elif name in existing:
+            values[name] = existing[name]
+        else:
+            missing.append(name)
+
+    if missing:
+        flags = ", ".join(f"--{name}" for name in missing)
+        print(
+            f"windkit configure: there is no terminal to prompt for {flags}. "
+            "Pass them as flags; an empty value leaves a field unset.",
+            file=sys.stderr,
+        )
+        return 1
+
+    try:
+        config._write_config_file(path, config.Config(**values))
+    except (UnicodeEncodeError, OSError) as e:
+        print(
+            f"windkit configure: could not write {path}: {e}. The existing "
+            "configuration is unchanged.",
+            file=sys.stderr,
+        )
+        return 1
+    config.get_config.cache_clear()
+    print(f"Saved the windkit configuration to {path}")
+    return 0
+
+
+def main(argv: list[str] | None = None) -> int:
+    """Run the windkit command-line interface.
+
+    Parameters
+    ----------
+    argv : list of str, optional
+        Command-line arguments, excluding the program name. Defaults to
+        ``sys.argv[1:]``.
+
+    Returns
+    -------
+    int
+        Exit status.
+    """
+    parser = argparse.ArgumentParser(
+        prog="windkit", description="windkit command-line interface"
+    )
+    subparsers = parser.add_subparsers(dest="command", required=True)
+
+    configure_parser = subparsers.add_parser(
+        "configure",
+        help="Set the user attribution stamped on windkit datasets",
+        description=(
+            "Write the name, email and institution that windkit stamps on the "
+            "datasets it creates as author, author_email and institution. "
+            "Fields not given as flags are prompted for, with the current "
+            "values as defaults, and an empty answer keeps the current value. "
+            "Without a terminal, fields not given as flags keep their current "
+            'values. An empty flag value, such as --email "", leaves a field '
+            "unset. The WINDKIT_NAME, WINDKIT_EMAIL and WINDKIT_INSTITUTION "
+            "environment variables take precedence over the file."
+        ),
+    )
+    for name in config._FIELD_NAMES:
+        configure_parser.add_argument(f"--{name}", help=f"{_LABELS[name]} to stamp")
+    configure_parser.set_defaults(func=_configure)
+
+    args = parser.parse_args(argv)
+    return args.func(args)