windkit 1.0.2__tar.gz → 2.0.1__tar.gz

{windkit-1.0.2 → windkit-2.0.1}/CHANGELOG.md

@@ -2,7 +2,62 @@
 
 All major changes are listed here.
 
-## 1.0.2 (2025-07-21)
+## [2.0.1 (2026-01-29)](https://docs.wasp.dk/windkit/v2.0.1/)
+
+### Highlights
+
+#### Performance improvements
+* Significantly reduced import time by lazy loading some packages and data. Should be approx 1/3 of previous import time.
+
+#### Documentation
+* Restructured user guide into focused, object-based documentation pages:
+  - Wind climates section with dedicated pages for TSWC, BWC, WWC, and GWC including I/O formats and usage examples
+  - Topography section with elevation, roughness, and landcover map documentation including format support tables
+  - Spatial section explaining point, stacked_point, raster, and cuboid structures with operation examples
+  - Wind farms section documenting wind turbine datasets and WTG objects
+  - New overview section with data structures, schemas, and tutorial data documentation
+
+#### Sheer and veer functionality
+
+* Added new function `wk.shear_extrapolate` to extrapolate wind speeds to different heights using a power law shear profile.
+* Added new function `wk.shear_exponent` to calculate a shear exponent from wind speeds
+* Added guidance about `wk.shear_exponent` into shear extrapolation example. 
+
+* Added new function `wk.veer_extrapolate` to extrapolate wind direction linearly to different heights, accounting for circular discontinuities.
+* Added new function `wk.wind_veer` to calculate wind veer from wind direction
+* Added guidance about `wk.wind_veer` into shear extrapolation example. 
+
+### Support for PyWAsP's Geostrophic wind climate objects
+
+* new function `create_geowc`, which creates a dummy geostrophic wind climate
+* functions `mean_wind_speed`, `mean_power_density`, `ws_freq_gt_mean`, `ws_cdf` and `mean_ws_moment` are now also working when a geostrophic wind climate is passed.
+
+### New features
+* Added new function `wk.extrapolate_to_height` to extrapolate wind climate objects to different heights. Currently, only works for time-series wind climates (TSWC).
+* `wk.roughness_map_to_file` now allows to write to a old fashioned `.map` file for the special case where these is a single polygon and the external roughness length is not specified (None). For this case we assume that the external roughness length is the same as the roughness length inside the polygon.
+* `wk.roughness_map_to_file` now allows users to write to a `.map` as long all displacement heights in the map are zero.
+* For `wv_count` objects (thus also geostrophic wind climates) if all of the bins have nan's, the result of function `mean_wind_speed`, `mean_power_density`, `ws_freq_gt_mean` and `mean_ws_moment` operating on such a function is also nan, whereas before it would be 0.
+* Added new function `wk.load_tutorial_data` to download and load tutorial data directly into memory as windkit-compatible objects (xarray.Dataset and geopandas.GeoDataFrame).
+* Changed `wk.get_tutorial_data` to return a `Path` to the extracted tutorial data folder, allowing users to load files manually using windkit readers or generic loaders. The function now includes detailed docstrings describing all available files for each dataset, including .nc, .omwc, .wtg, .map, and .csv.
+* Added `wk.read_wind_turbines` and `wk.wind_turbines_to_file` functions to read and write wind turbine datasets in various formats. Both only support CSV for now. The CSV should follow the windkit wind turbine format specification.
+
+
+### Bug fixes
+* Fixed pixel misalignment when downloading raster maps from Google Earth Engine. Downloads now use `crs_transform` instead of `scale` to preserve exact pixel alignment with source datasets (e.g., Globcover, SRTM, WorldCover). This fixes half-pixel offsets (~150m for Globcover) and ~12-15m offsets for elevation data.
+* Bugfix in `read_bwc`: it now opens `bwc` stored in netcdf correctly.
+but some of this functionality was only available in pywasp, so it has been moved there.
+* Fixed bug where a point dataset with several horizontal locations would be converted to a single horizontal location when using the function `to_stacked_point`
+* bug fix to interpolation, which would create invalid spatial structures when a dimension was in exclude dims but not present in the target structure (e.g. when doing interpolation from `stacked_point` to `point`).
+
+
+### Changes
+* Changed default value of `use_bounds` to `True` in `wk.spatial.BBox.reproject` method.
+
+### Breaking changes
+
+* `spatial_interpolate_gwc` has been removed. This functionality is now only available in PyWAsP through its `interpolate_gwc` function.
+
+## [1.0.2 (2025-07-21)](https://docs.wasp.dk/windkit/v1.0.2/)
 
 WindKit 1.0.2 is a patch release to ensure consistent config and app data paths on windows. Both the config and app data paths are now set by default to ``C:\\Users\\<user>\\AppData\\Roaming\\DTU Wind Energy\\windkit``.
 
@@ -277,7 +332,7 @@ as required in the `stacked_point` structure.
 * Switched configuration file from ini to toml, old file will be automatically migrated
 
 
-## 0.8.0 (2024-06-10)
+## [0.8.0 (2024-06-10)](https://docs.wasp.dk/windkit/v0.8.0/)
 
 ### New features
 

windkit-2.0.1/PKG-INFO

@@ -0,0 +1,137 @@
+Metadata-Version: 2.4
+Name: windkit
+Version: 2.0.1
+Summary: WindKit provides core functionalities for working with wind resource data
+Author: DTU Wind Energy
+License-Expression: BSD-3-Clause
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: geopandas>=1.0
+Requires-Dist: h5netcdf
+Requires-Dist: lxml>=5.0
+Requires-Dist: netcdf4>=1.6
+Requires-Dist: numpy>=1.26
+Requires-Dist: packaging>=23
+Requires-Dist: pandas>=2.1
+Requires-Dist: platformdirs>=4.3
+Requires-Dist: pydantic>=2.7
+Requires-Dist: pydantic-settings>=2.3
+Requires-Dist: pyproj>=3.6
+Requires-Dist: pyyaml
+Requires-Dist: rasterio>=1.3
+Requires-Dist: requests
+Requires-Dist: rioxarray>=0.17
+Requires-Dist: scipy>=1.12
+Requires-Dist: shapely>=2.0
+Requires-Dist: toml
+Requires-Dist: xarray>=2023.9
+Provides-Extra: plots
+Requires-Dist: matplotlib>=3.8; extra == "plots"
+Requires-Dist: plotly>=5.12.0; extra == "plots"
+Requires-Dist: kaleido; extra == "plots"
+Provides-Extra: performance
+Requires-Dist: numba>=0.57.0; extra == "performance"
+Provides-Extra: data-apis
+Requires-Dist: adlfs; extra == "data-apis"
+Requires-Dist: earthengine-api; extra == "data-apis"
+Requires-Dist: fsspec; extra == "data-apis"
+Requires-Dist: planetary-computer; extra == "data-apis"
+Requires-Dist: pystac-client; extra == "data-apis"
+Requires-Dist: zarr>2.15; extra == "data-apis"
+Provides-Extra: dev
+Requires-Dist: dash; extra == "dev"
+Requires-Dist: ipython; extra == "dev"
+Requires-Dist: nbval; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pytest-xdist; extra == "dev"
+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"
+Requires-Dist: nbsphinx-link; extra == "doc"
+Requires-Dist: pydata-sphinx-theme; extra == "doc"
+Requires-Dist: recommonmark; extra == "doc"
+Requires-Dist: sphinx; extra == "doc"
+Requires-Dist: sphinx-argparse; extra == "doc"
+Requires-Dist: sphinx-copybutton; extra == "doc"
+Requires-Dist: sphinx-design; extra == "doc"
+Requires-Dist: sphinx-gallery; extra == "doc"
+Requires-Dist: sphinxcontrib-bibtex; extra == "doc"
+Requires-Dist: sphinxext-opengraph; extra == "doc"
+Dynamic: license-file
+
+# WindKit
+
+[![pipeline status](https://gitlab-internal.windenergy.dtu.dk/ram/software/pywasp/windkit/badges/master/pipeline.svg)](https://gitlab-internal.windenergy.dtu.dk/ram/software/pywasp/windkit/-/pipelines)
+[![coverage](https://gitlab-internal.windenergy.dtu.dk/ram/software/pywasp/windkit/badges/master/coverage.svg)](https://gitlab-internal.windenergy.dtu.dk/ram/software/pywasp/windkit/-/pipelines)
+[![release](https://gitlab-internal.windenergy.dtu.dk/ram/software/pywasp/windkit/-/badges/release.svg)](https://gitlab-internal.windenergy.dtu.dk/ram/software/pywasp/windkit/-/releases)
+[![License: BSD-3-Clause](https://img.shields.io/badge/License-BSD--3--Clause-blue.svg)](LICENSE)
+[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
+[![Docs](https://img.shields.io/badge/docs-docs.wasp.dk-blue?logo=readthedocs&logoColor=white)](https://docs.wasp.dk/windkit)
+
+[![PyPI](https://img.shields.io/pypi/v/windkit)](https://pypi.org/project/windkit/)
+[![Downloads-pypi](https://img.shields.io/pypi/dm/windkit)](https://pypi.org/project/windkit/)
+
+
+WindKit provides core functionalities for working with wind resource data, built on top of [xarray](https://xarray.dev/) and [geopandas](https://geopandas.org/).
+
+## Installation
+
+**pip:**
+```bash
+pip install windkit
+```
+
+**conda:**
+```bash
+conda install -c https://conda.windenergy.dtu.dk/channel/open windkit
+```
+
+## Quick Start
+
+```python
+import windkit as wk
+
+# Read a binned wind climate
+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")
+
+# Fit Weibull distribution and convert to Weibull wind climate
+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
+- **Spatial Processing** - Clip, reproject, and interpolate spatial data with full CRS support
+- **Wind Statistics** - Calculate mean wind speed, power density, Weibull parameters, and more
+- **Plotting** - Interactive plots with Plotly, static plots with Matplotlib
+- **Remote Data Access** - Download ERA5 reanalysis data and satellite-derived maps
+
+## Documentation
+
+Full documentation: [docs.wasp.dk/windkit](https://docs.wasp.dk/windkit)
+
+Community forum: [WAsP Python tools](https://www.wasptechnical.dk/forum/forum/19-wasp-python-tools/)
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and guidelines.
+
+## License
+
+BSD-3-Clause - see [LICENSE](LICENSE) for details.

windkit-2.0.1/README.md

@@ -0,0 +1,66 @@
+# WindKit
+
+[![pipeline status](https://gitlab-internal.windenergy.dtu.dk/ram/software/pywasp/windkit/badges/master/pipeline.svg)](https://gitlab-internal.windenergy.dtu.dk/ram/software/pywasp/windkit/-/pipelines)
+[![coverage](https://gitlab-internal.windenergy.dtu.dk/ram/software/pywasp/windkit/badges/master/coverage.svg)](https://gitlab-internal.windenergy.dtu.dk/ram/software/pywasp/windkit/-/pipelines)
+[![release](https://gitlab-internal.windenergy.dtu.dk/ram/software/pywasp/windkit/-/badges/release.svg)](https://gitlab-internal.windenergy.dtu.dk/ram/software/pywasp/windkit/-/releases)
+[![License: BSD-3-Clause](https://img.shields.io/badge/License-BSD--3--Clause-blue.svg)](LICENSE)
+[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
+[![Docs](https://img.shields.io/badge/docs-docs.wasp.dk-blue?logo=readthedocs&logoColor=white)](https://docs.wasp.dk/windkit)
+
+[![PyPI](https://img.shields.io/pypi/v/windkit)](https://pypi.org/project/windkit/)
+[![Downloads-pypi](https://img.shields.io/pypi/dm/windkit)](https://pypi.org/project/windkit/)
+
+
+WindKit provides core functionalities for working with wind resource data, built on top of [xarray](https://xarray.dev/) and [geopandas](https://geopandas.org/).
+
+## Installation
+
+**pip:**
+```bash
+pip install windkit
+```
+
+**conda:**
+```bash
+conda install -c https://conda.windenergy.dtu.dk/channel/open windkit
+```
+
+## Quick Start
+
+```python
+import windkit as wk
+
+# Read a binned wind climate
+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")
+
+# Fit Weibull distribution and convert to Weibull wind climate
+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
+- **Spatial Processing** - Clip, reproject, and interpolate spatial data with full CRS support
+- **Wind Statistics** - Calculate mean wind speed, power density, Weibull parameters, and more
+- **Plotting** - Interactive plots with Plotly, static plots with Matplotlib
+- **Remote Data Access** - Download ERA5 reanalysis data and satellite-derived maps
+
+## Documentation
+
+Full documentation: [docs.wasp.dk/windkit](https://docs.wasp.dk/windkit)
+
+Community forum: [WAsP Python tools](https://www.wasptechnical.dk/forum/forum/19-wasp-python-tools/)
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and guidelines.
+
+## License
+
+BSD-3-Clause - see [LICENSE](LICENSE) for details.

windkit-2.0.1/pyproject.toml

@@ -0,0 +1,113 @@
+[build-system]
+requires = ["setuptools>=45", "setuptools_scm[toml]>=6.2"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "windkit"
+description = "WindKit provides core functionalities for working with wind resource data"
+readme = "README.md"
+license = "BSD-3-Clause"
+authors = [
+    {name = "DTU Wind Energy"}
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+dynamic = ["version"]
+requires-python = ">=3.11"
+dependencies = [
+    "geopandas>=1.0",
+    "h5netcdf",
+    "lxml>=5.0",
+    "netcdf4>=1.6",
+    "numpy>=1.26",
+    "packaging>=23",
+    "pandas>=2.1",
+    "platformdirs>=4.3",
+    "pydantic>=2.7",
+    "pydantic-settings>=2.3",
+    "pyproj>=3.6",
+    "pyyaml",
+    "rasterio>=1.3",
+    "requests",
+    "rioxarray>=0.17",
+    "scipy>=1.12",
+    "shapely>=2.0",
+    "toml",
+    "xarray>=2023.9",
+]
+
+[project.optional-dependencies]
+plots = [
+    "matplotlib>=3.8",
+    "plotly>=5.12.0",
+    "kaleido",
+]
+performance = [
+    "numba>=0.57.0",
+]
+data_apis = [
+    "adlfs",
+    "earthengine-api",
+    "fsspec",
+    "planetary-computer",
+    "pystac-client",
+    "zarr>2.15",
+]
+dev = [
+    "dash",
+    "ipython",
+    "nbval",
+    "pre-commit",
+    "pytest",
+    "pytest-cov",
+    "pytest-xdist",
+    "windIO",
+]
+doc = [
+    "docutils",
+    "jupyter",
+    "jupyter-dash",
+    "jupyter-sphinx",
+    "myst-parser",
+    "nbsphinx",
+    "nbsphinx-link",
+    "pydata-sphinx-theme",
+    "recommonmark",
+    "sphinx",
+    "sphinx-argparse",
+    "sphinx-copybutton",
+    "sphinx-design",
+    "sphinx-gallery",
+    "sphinxcontrib-bibtex",
+    "sphinxext-opengraph",
+]
+
+[project.scripts]
+split_combomap = "windkit.topography.vector_map:_split_combo"
+
+[tool.setuptools_scm]
+write_to = "windkit/_version.py"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+namespaces = true
+
+[tool.setuptools.package-data]
+"windkit.data" = ["*.json"]
+"windkit.data.landcover_tables" = ["*.json"]
+"windkit.data.plot" = ["*.json"]
+"windkit.data.loss_tables" = ["*.csv"]
+"windkit.data.uncertainty_tables" = ["*.csv"]
+
+[tool.pytest.ini_options]
+minversion = "6.0"
+norecursedirs = "dist build .tox"
+testpaths = ["test",]
+markers = [
+    "slow: marks tests as slow (deselect with '-m \"not slow\"')",
+    "performance: marks tests as performance tests (run with '-m performance')",
+]

windkit-2.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

{windkit-1.0.2 → windkit-2.0.1}/windkit/__init__.py

@@ -20,6 +20,10 @@ __all__ = [
     "vinterp_wind_speed",
     "rotor_equivalent_wind_speed",
     "tswc_resample",
+    "shear_extrapolate",
+    "shear_exponent",
+    "veer_extrapolate",
+    "wind_veer",
     # Time Series Wind Climate
     "validate_tswc",
     "is_tswc",
@@ -50,10 +54,10 @@ __all__ = [
     "create_gwc",
     "read_gwc",
     "gwc_to_file",
-    "spatial_interpolate_gwc",
     # Geostrophic wind climate
     "validate_geowc",
     "is_geowc",
+    "create_geowc",
     # Predicted Wind Climate
     "create_pwc",
     # Wind Climate
@@ -64,6 +68,7 @@ __all__ = [
     "mean_wind_speed",
     "mean_power_density",
     "get_cross_predictions",
+    "extrapolate_to_height",
     # Landcover
     "LandCoverTable",
     "get_landcover_table",
@@ -100,6 +105,8 @@ __all__ = [
     "create_wind_turbines_from_dataframe",
     "create_wind_turbines_from_arrays",
     "wind_turbines_to_geodataframe",
+    "read_wind_turbines",
+    "wind_turbines_to_file",
     # workspace
     "Workspace",
     # weng_workspace
@@ -137,6 +144,7 @@ __all__ = [
     "total_uncertainty_factor",
     # tutorial_data
     "get_tutorial_data",
+    "load_tutorial_data",
 ]
 
 from windkit._version import version as __version__
@@ -153,6 +161,10 @@ from windkit.wind import (
     vinterp_wind_speed,
     rotor_equivalent_wind_speed,
     tswc_resample,
+    shear_extrapolate,
+    shear_exponent,
+    veer_extrapolate,
+    wind_veer,
 )
 from windkit.wind_climate.time_series_wind_climate import (
     validate_tswc,
@@ -190,13 +202,13 @@ from windkit.wind_climate.generalized_wind_climate import (
     create_gwc,
     read_gwc,
     gwc_to_file,
-    spatial_interpolate_gwc,
     _reproject_gwc,
 )
 from windkit.wind_climate import generalized_wind_climate  # noqa: F401
 from windkit.wind_climate.geostrophic_wind_climate import (
     validate_geowc,
     is_geowc,
+    create_geowc,
 )
 from windkit.wind_climate import geostrophic_wind_climate  # noqa: F401
 from windkit.wind_climate.predicted_wind_climate import create_pwc
@@ -209,6 +221,7 @@ from windkit.wind_climate.wind_climate import (
     mean_wind_speed,
     mean_power_density,
     get_cross_predictions,
+    extrapolate_to_height,
 )
 from windkit.cfd import read_cfdres
 from windkit.wind_farm.wind_turbine_generator import (
@@ -228,6 +241,8 @@ from windkit.wind_farm.wind_turbines import (
     create_wind_turbines_from_dataframe,
     create_wind_turbines_from_arrays,
     wind_turbines_to_geodataframe,
+    read_wind_turbines,
+    wind_turbines_to_file,
 )
 from windkit.workspace import Workspace
 from windkit.weng_workspace import WengWorkspace
@@ -291,4 +306,4 @@ from windkit.xarray_structures.direction import (
 from windkit.xarray_structures.wsbin import (
     create_wsbin_coords,
 )
-from windkit.tutorial_data import get_tutorial_data
+from windkit.tutorial_data import get_tutorial_data, load_tutorial_data

{windkit-1.0.2 → windkit-2.0.1}/windkit/_version.py

@@ -1,7 +1,14 @@
 # file generated by setuptools-scm
 # don't change, don't track in version control
 
-__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
 
 TYPE_CHECKING = False
 if TYPE_CHECKING:
@@ -9,13 +16,19 @@ if TYPE_CHECKING:
     from typing import Union
 
     VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
 else:
     VERSION_TUPLE = object
+    COMMIT_ID = object
 
 version: str
 __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
 
-__version__ = version = '1.0.2'
-__version_tuple__ = version_tuple = (1, 0, 2)
+__version__ = version = '2.0.1'
+__version_tuple__ = version_tuple = (2, 0, 1)
+
+__commit_id__ = commit_id = None