windkit 0.6.3__tar.gz → 0.8.0__tar.gz

{windkit-0.6.3 → windkit-0.8.0}/.conda_env/dev_unix.yml

@@ -4,22 +4,22 @@ channels:
   - https://conda.windenergy.dtu.dk/channel/open
 dependencies:
   - dtu_config
-  - geopandas =0.11
+  - geopandas >=0.12
   - lxml =4
-  - matplotlib =3
-  - netcdf4 =1.5
-  - numpy =1.21.2
-  - packaging =21.0
-  - pandas =1
-  - plotly >=5.1.0
-  - pyproj >=2.2.2
-  - python >=3.8
-  - python-kaleido >=0.2.1
+  - matplotlib >=3.6
+  - netcdf4 >=1.5
+  - numpy >=1.24
+  - packaging >=22
+  - pandas >=2
+  - plotly >=5.12
+  - pyproj >=3.4
+  - python >=3.10
+  - python-kaleido >=0.2
   - rasterio =1
-  - scipy =1
-  - shapely =1
-  - xarray >=2022
-  - rioxarray >=0.12
+  - scipy >=1.9
+  - shapely =2
+  - xarray >=2023
+  - rioxarray >=0.13
   # Build dependencies all
   - pip
   - git

{windkit-0.6.3 → windkit-0.8.0}/.conda_env/dev_win.yml

@@ -4,22 +4,22 @@ channels:
   - https://conda.windenergy.dtu.dk/channel/open
 dependencies:
   - dtu_config
-  - geopandas =0.11
+  - geopandas >=0.12
   - lxml =4
-  - matplotlib =3
-  - netcdf4 =1.5
-  - numpy =1.21.2
-  - packaging =21.0
-  - pandas =1
-  - plotly >=5.1.0
-  - pyproj >=2.2.2
-  - python >=3.8
-  - python-kaleido >=0.2.1
+  - matplotlib >=3.6
+  - netcdf4 >=1.5
+  - numpy >=1.24
+  - packaging >=22
+  - pandas >=2
+  - plotly >=5.12
+  - pyproj >=3.4
+  - python >=3.10
+  - python-kaleido >=0.2
   - rasterio =1
-  - scipy =1
-  - shapely =1
-  - xarray >=2022
-  - rioxarray >=0.12
+  - scipy >=1.9
+  - shapely =2
+  - xarray >=2023
+  - rioxarray >=0.15
   # Build dependencies all
   - pip
   - setuptools

windkit-0.8.0/.conda_env/prod_unix.yml

@@ -0,0 +1,14 @@
+name: base
+channels:
+  - conda-forge
+  - https://conda.windenergy.dtu.dk/channel/open
+dependencies:
+  - boa
+  - build
+  - python >=3.10
+  - twine
+  - setuptools_scm
+  - git
+  - zip
+  - unzip
+  - rsync

{windkit-0.6.3 → windkit-0.8.0}/.gitignore

@@ -16,8 +16,8 @@ test/htmlcov
 .eggs/
 *,cover
 _version.py
-
-
+.devcontainer
+.pixi/
 
 # macOS files
 .DS_Store
@@ -38,3 +38,4 @@ test/vector*.*
 test/dummy*/
 test/dummy*.*
 test/data/
+examples/.ipynb_checkpoints/

{windkit-0.6.3 → windkit-0.8.0}/.gitlab/merge_request_templates/default.md

@@ -1,6 +1,7 @@
 Closes #xxx,#yyy
 
 * [ ] Documentation added
+* [ ] Developer documentation updated
 * [ ] Changelog updated
 * [ ] Tests added
 * [ ] Commits squashed

windkit-0.8.0/.gitlab/merge_request_templates/release.md

@@ -0,0 +1,43 @@
+# Release Process
+
+# Summary
+
+This MR contains the changes for the release [version].
+(add a brief description)
+
+## Checklist
+
+Once this checklist is completed, you can merge.
+
+- [ ] Update Changelog
+- [ ] Test Build
+- [ ] Merge with master
+- [ ] Add Tag
+
+
+### Update Changelog
+Follow all the steps below before checking the mark for Update changelog
+
+- The CHANGELOG.md subtitle "Unreleased" needs to be changed to the version being released, including the date
+- The content under "Unreleased" may need to be rewritten to be more friendly
+- Move the changelog content to the documentation website under "Release
+Notes / Changelog". (This is done by the CI platform)
+
+Follow all the steps below before checking the mark for Update changelog
+
+The CHANGELOG.md subtitle "Unreleased" needs to be changed the version being released
+here, including the date
+Restructure the content under "Unreleased" to be more userfriendly
+
+### Test Build
+Follow all the steps below before checking the mark for Test Build
+- Test must pass
+- -...
+
+### Merge with master
+Follow all the steps below before checking the mark for  Merge with master
+- ...
+
+### Add Tag
+Follow all the steps below before checking the mark for Add Tag
+- Add tag to the branch with the command `git tag ...`

{windkit-0.6.3 → windkit-0.8.0}/.gitlab-ci.yml

@@ -21,6 +21,8 @@ default:
 
 # Check that pre-commit has run
 run_precommit:
+  script:
+    - pre-commit clean
   extends: .verify_precommit
 
 # Build environments for testing
@@ -74,7 +76,9 @@ test_linux:
 build_wheel:
   extends: .build_wheel_template
 build_conda:
-  extends: .build_conda_template
+  extends: .build_rattler_template
+  variables:
+    PY_BUILD_CHANNELS: "-c conda-forge -c https://conda.windenergy.dtu.dk/channel/open"
 
 # Deploy
 deploy_pypi:
@@ -93,11 +97,15 @@ deploy_conda_dev:
 # Docs
 build_docs:
   extends: .build_docs
-  tags: ["doc_deploy"]
-deploy_docs_pages:
+  tags: ["ramtt_int-cluster", "linux-docker"]
+pages:
   extends: .deploy_docs_pages
   needs: ["build_docs"]
   tags: ["doc_deploy"]
+docs_deploy:
+  extends: .deploy_docs_wasp
+  needs: ["build_docs"]
+  tags: ["doc_deploy"]
 
 ###  MIGHT BE USED LATER ###
 

{windkit-0.6.3 → windkit-0.8.0}/.pre-commit-config.yaml

@@ -2,10 +2,11 @@
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v3.1.0
+    rev: v4.5.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
+        exclude: "test/data"
       - id: check-yaml
         exclude: .gitlab-ci.yml|meta.yaml|.ci-includes/run_pytest.yml|.ci-includes/py_deploy.yml
       - id: check-merge-conflict
@@ -17,18 +18,19 @@ repos:
       - id: check-json
       - id: pretty-format-json
         args: [--autofix, --no-ensure-ascii]
+        exclude: "test/"
   - repo: https://github.com/pycqa/isort
-    rev: 5.12.0
+    rev: 5.13.2
     hooks:
       - id: isort
         name: isort (python)
   - repo: https://github.com/psf/black
-    rev: 22.3.0
+    rev: 23.12.1
     hooks:
       - id: black
         exclude: examples
-  - repo: https://github.com/hadialqattan/pycln
-    rev: v1.3.1 # Possible releases: https://github.com/hadialqattan/pycln/releases
-    hooks:
-      - id: pycln
-        args: [--config=pyproject.toml]
+        #- repo: https://github.com/hadialqattan/pycln
+        #rev: v1.3.1 # Possible releases: https://github.com/hadialqattan/pycln/releases
+        #hooks:
+        #- id: pycln
+        #args: [--config=pyproject.toml]

{windkit-0.6.3 → windkit-0.8.0}/CHANGELOG.md

@@ -2,6 +2,175 @@
 
 All major changes are listed here.
 
+## Unreleased
+
+## 0.8.0 (2024-06-10)
+
+### New features
+
+#### Enhanced wind turbines class
+
+* New functions in `windkit.wind_turbines` to create point `xarray.Dataset` representation of WTGs from `pandas.DataFrame`, `geopandas.DataFrame` and raw point arrays. Additionally, the module adds a function `check_wtg_keys` to validate wtg keys and `wind_turbines_to_geodataframe` to convert the dataset back to a `geopandas.GeoDataFrame`.
+
+
+#### New Long Term Correction module
+
+The new module `ẁindkit.ltc` contains tools to perform long term correction of wind measurements. It is based on the windkit `xarray` time series wind climate dataset, therefore it
+is compatible with all the `windkit` toolset.
+* There are two methodologies available:
+  - class `LinRegMCP` implements a linear regression.
+  - class `VarRatMCP` implements a variance ratio linear regression.
+* There is also a  `ltc.scores` submodule to calculate scores such as `r2`, `rmse`, `bias` and `wasserstein distance`.
+
+
+#### Jupyer notebook examples
+
+The windkit package includes a folder with examples of use. currently there is one jupyter notebook example to use the long term correction module.
+
+
+#### New functions to handle wind data
+* New function `windkit.wd_to_sector` can return sectors of fixed width or sectors of equal probability (quantiles=True)
+* New function `resample_wind_and_direction` to resample a time series wind climate `xarray.Dataset` to a different sampling frequency.
+* New function `windkit.sector.create_sector_coords_from_edges` that returns a data array with sector coordinates for any array of sector edges, not necessarily equidistant.
+
+
+#### New function to implement cross prediction
+When implementing a cross prediction methodology, we need to create a combination of pair of spatial points with the different locations to predict.
+The new function `windkit.get_cross_predictions` allows that, from a `xarray.Dataset` with several points, return two aligned datasets with the points where we want
+to predict from and where we want to predict to.
+
+#### New functions on empty module
+* New function `windkit.empty.empty_raster_map` generates a `xarray.Dataset` raster map instance filled with either `NaN` or meaningful values.
+* New function  `windkit.empty.empty_wv_count` returns random meaningful values and it is more suitable for testing
+
+#### Improvements to get raster and vector source data
+* `get_vector_map` gets data in vector format from DTU servers (currently only support `CORINE`)
+* `get_raster_map`: added new source dtu, with access to `Viewfinder` and `ESA_CCI`, also allows non-geographic bounding boxes
+* Allow user to put `earth_engine.json` in home directory for authenticating to usage of google earth engine in `get_raster_map`.
+
+#### New functionality to handle conversion between geopandas dataframes and xarray datasets
+* New function `gdf_to_ds`, which converts a geopandas dataframe to a xr.Dataset in the best fitting windkit spatial structure.
+* New function `ds_to_gdf`, which converts a xr.Dataset in windkit spatial structure to a geopandas dataframe.
+
+
+### Changes
+
+* Added `flow_sep_height` argument in the metadata. This variable is used in pywasp to denote the height where flow separation occurs.
+* Added geostrophic wind climate variables `geo_turn` and `geo_wv_freq` to metadata
+* Moved `gwc_interpolate` to pywasp, because it relies on some code from pywasp and is only useful in a pywasp context
+* `get_roughness_map` and `get_raster_map` issues a warning if a landcover table is attempted to be read as roughness.
+* Removed constraint on first `gen_height` to be equal to 10. This is not a requirement for pywasp to work.
+* GML files with an empty description (the default) written by windkit can now be opened in the map editor
+* `bwc_to_tabfile` now creates the parent directory if does not exist, and formats the tab filename based on the dataset coordinates.
+* `windkit.Workspace.read_wwh` allows WAsP workspaces with displacement height maps (i.e. GML files, WAsP >12.7) to be imported.
+* New function `bwc_validate_structure` which checks only if the structure is OK for a `bwc` dataset, without checking for the actual values.
+* `windkit.bwc_to_tabfile` writes a default header "No Header" in the tab file if the dataset does not have the "wasp_header" attribute.
+* Added 'use_bounds' argument to `windkit.spatial.BBox.reproject` to allow the reprojection to respect the concave/convex shape of the bounding box due to reprojection.
+* The order of stacked point's is now preserved when round-trip via `windkit.spatial.spatial_stack` and `windkit.spatial.spatial_unstack`.
+* Added additional checks for consistency with PyWAsP use when reading in a roughness map with `windkit.read_raster_map`
+* Added method `windkit.WindTurbines.to_wtg_dict_and_turbines_ds` to convert the deprecated `WindTurbines` object to a dictionary and a `xarray.Dataset` of turbines.
+
+### Bug fixes
+
+* Fixed a bug in `windkit.read_bwc` , where it did not check correctly whether the requested crs matches the dataset crs.
+* `get_raster_map` no longer gives -9999 for areas where no data is available.
+* Fixed a bug in `windkit.bwc_to_tabfile`, where it allowed to write datasets with projected coordinates to a tab file, which is not allowed.
+* Fixed a bug in `windkit.bwc_from_timeseries` where it returned a point structure when the input was a stacked_point.
+* Fixed a bug in `LandCoverTable` that did not allow to instantiate an object when colors or labels are not `None`
+
+### Deprecations
+
+* `count_to_ws_freq_by_sector` is deprecated in favor of `bwc_from_counts`.
+* `binned_wind_climate.bwc_from_weibull` is removed in favor of `weibull_wind_climate.wwc_to_bwc` with simpler API passing in a `xr.Dataset` instead of weibull parameters one by one.
+* `WindTurbines` class is deprecated in favor of `wind_turbines.create_wind_turbines_from_*` functions to create `xr.Dataset` representation of WTGs.
+* `get_map` and `get_ee_map` are deprecated in favour of `get_raster_map`
+
+
+
+## 0.7.0 (2023-11-13)
+
+### New Features
+
+#### Additional interpolation functionality
+
+The interpolation functionality of windkit was expanded with the release, several low-level interpolation routines were added, allowing interpolation to and from all of windkit's spatial data structures.
+
+* Added `windkit.spatial.interp_structured_like` for interpolation from a "cuboid" to any spatial structure, using any of the interpolation methods available in `xarray.Dataset.interp`.
+* Added `windkit.spatial.interp_unstructured_like` and `windkit.spatial.interp_unstructured` and for interpolation between any spatial structures, using `nearest`, `linear`, or `cubic` methods. Additionally, the `natural` method can be used peform natural neighbor interpolation for 2D `point` structured target structures, using `metpy's implementation <https://unidata.github.io/MetPy/latest/examples/gridding/Natural_Neighbor_Verification.html>`.
+
+Additionally a few high level routines were added for interpolation specific fields.
+
+* Added `windkit.interpolate_gwc` to interpolate a generalized wind climate dataset.
+* Added `windkit.vinterp_wind_speed` for vertical interpolation of wind speeds
+* Added `windkit.vinterp_wind_direction` for vertical interpolation of wind directions
+
+#### Improvements to the map_conversion routines
+
+* Added `windkit.map_conversion.find_duplicate_lines` to identify duplicated lines in a GeoDataFrame, even if the line is reversed.
+* `windkit.poly2lines` now correctly sets the CRS to match the input data. Before it was `None`.
+* `windkit.poly2lines` and `windkit.lines2poly` now have an absolute tolerance argument, `atol`, which can be used to identify nearby points, which should be joined.
+
+#### Access to data from Microsoft's Planetary Computer platform
+
+* Elevation and landcover data obtained using `windkit.get_map` can now use either Microsoft's Planetary Computer platform or Google's Earth Engine.
+* Added `windkit.get_era5` to download ERA5 data from Microsoft's Planetary Computer platform.
+
+#### Calculate additional derived quantities from Weibull and Binned Wind climates
+
+* Added new functions `windkit.fit_weibull_wasp_m1_m3_fgtm`, `windkit.fit_weibull_wasp_m1_m3`, and `windkit.fit_weibull_k_sumlogm` for fitting weibull distributions to wind speed moments.
+* Added `windkit.weibull_cdf` and `windkit.weibull_pdf` calculate the cdf and pdf of a weibull distribution.
+* Added `windkit.weibull_freq_gt_mean` to calculate the fraction of probability mass above the mean of a weibull distribution.
+* Added `windkit.bwc_ws_cdf` and `windkit.bwc_freq_gt_mean` are similar functions for binned wind climates.
+
+#### Convenience functions to access standard land cover tables for common datasets
+* Added `windkit.LandCoverTable.get_table` and it's top-level alias `windkit.get_land_cover_table` to get a land cover table for a given land cover dataset. Landcover tables are currently provided for CGLS-LC100, CORINE, GlobCover, MODIS, WorldCover, and ESA_CCI.
+
+#### Even more spatial functionality
+
+* Added `windkit.spatial.clip_with_margin` to clip a raster-like dataset to the bounds of another dataset plus a margin. This is useful for clipping a dataset before doing other operations with it (e.g. interpolation) to reduce computation time.
+* Added `windkit.spatial.equal_spatial_shape`, to check if two xarray objects have the same struct and spatial shape. This differs from `windkit.spatial.are_spatially_equal`, which requires the values to also be the same.
+* Added `windkit.spatial.covers` to check if a cuboid dataset covers another spatial dataset (point, stacked_point,  or cuboid, or polygon).
+
+#### Further improvements to wrg and rsf file handling
+
+* `windkit.read_wrgfile`, `windkit.read_rsffile` have a new boolean argument `use_production`, where if it is True, the power colum in the file is interpreted as gross AEP, and when False, the power column in the file is interpreted as power density.
+* `windkit.read_wrgfile`, `windkit.read_rsffile` have a new boolean argument `use_production` where if it is True, the `gross_aep` data variable is written to the file, and if False, the `power_density` column is written to the file.
+
+
+### Bug fixes
+
+* `windkit.LandCoverTable.from_dict_ora`: Sets the correct values of `z0frac` and `dfrac` in the LandCoverTable description.
+* `windkit.BBox.buffer` now works with `shapely 2.0`.
+* Changed the default `nodata` value for `windkit.spatial.warp` from `np.nan` to `None`, which results in a value of `-9999` for integer fields, and `np.nan` for float fields. This fixes an issue with integer data, for which `np.nan` is undefined.
+* `windkit.read_rsffile` no longer returns a unneeded `point` coordinate, when `to_cuboid=False`.
+* `empty.empty_gwc` uses the same random number generator for all data variables, ensuring the same seed gives the same numbers.
+
+### Changes
+* `windkit.generalized_wind_climate.read_gwc` performs validations checks for all formats, not only `netCDF`
+* `windkit.generalized_wind_climate.to_libfile` detects if path is a file or a directory and creates subdirectories if they do not exist.
+* `windkit.generalized_wind_climate.to_libfile` formats `.lib` filename using the coordinates if no name is given, similar to what is done with multiple files.
+* function `gwc_validate` and decorator`gwc_validate_wrapper` perform extra validations on generalized wind climate datasets. The first generalized height must be 10.0, the first generalized roughness must be 0.0, and both must have at least 2 entries.
+* `windkit.read_cfdres`, now always returns a dataset with the coordinates `south_north` and `west_east` sorted from low to high.
+* `windkit.read_vector_map` will raise `RuntimeError` when trying to read a `.map` file with displacement height, which is not supported.
+* `wk.read_rsffile` now allows .rsf files with a single-point to be converted to cuboid.
+* Added `windkit.rotor_equivalent_wind_speed` function for calculating REWS
+* Added `windkit.read_wwc` that creates and validates a weibull wind climate `xarray.Dataset` from a file.
+* Added `datum_name` argument to `windkit.spatial.BBox.utm_bbox_from_geographic_coordinate` to allow the user to specify the datum name for the UTM projection.
+* `empty.empty_wasp_site_factors` and `empty.empty_met_fields` are filled with random numbers.
+* `empty.empty_pwc` can include any desired combination of met field and site factors. Defaults to `A_combined`, `k_combined`, `power_density` for met fields and `site_elev` for site factors.
+* `empty.empty_gwc` has a new boolean argument `wdfreq_constant`, which allows you to create a generalized wind climate object where `wdfreq` is constant along the `gen_height`. This is used to create datasets that can be written to the `.lib` file format.
+* `empty.empty_gwc` retains the shape of scalar structured datasets, i.e. a single point with no point dimension, only coordinate values. This structure is common when selecting a single location using `.sel` or `.isel`.
+* Added `windkit.empty.empty_tswc` that generates a time series wind climate `xarray.Dataset` with random but meaningful values.
+* Added `split_combomap` CLI utility, which reads a combo `.map` file and returns two `.gpkg` files, one for elevation and one for landcover.
+
+
+### Deprecations
+* `windkit.spatial.interpolate_to_grid` deprecated in favor of `windkit.spatial.interp_structured_like` and `windkit.spatial.interp_unstructured_like`
+
+### Breaking changes
+* `windkit.poly2lines` no longer has a `closed_map` argument. Instead, when `background_lc_id` is set, all empty space is filled with the provided id. This allows for maps that are no longer rectangular, e.g. due to reprojection, to be properly converted to line maps.
+* Removed accessors, which were previously registered for several wind climate data structures. You will need to use the functions instead.
+
 ## 0.6.3 (2023-07-18)
 
 ### New Features
@@ -22,6 +191,7 @@ Several new methods were added to the BBox object to make it easier to work with
     * Added 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` and `windkit.to_wrgfile` now attempts to match the WAsP formatting more closely and a new `formatters` 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.

{windkit-0.6.3 → windkit-0.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: windkit
-Version: 0.6.3
+Version: 0.8.0
 Summary: WindKit provides core functionalities for working with wind resource data
 Home-page: https://docs-wasp.ramtt.xyz/windkit
 Author: DTU Wind Energy
@@ -8,11 +8,28 @@ License: BSD-3-Clause
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.6
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: dtu_config<0.3.0,>=0.2.0
+Requires-Dist: lxml>=4
+Requires-Dist: netcdf4>=1.5
+Requires-Dist: numpy>=1.23
+Requires-Dist: packaging>=22
+Requires-Dist: pandas>=2
+Requires-Dist: pyproj>=3.4
+Requires-Dist: scipy>=1.9
+Requires-Dist: shapely>=2
+Requires-Dist: xarray>=2023
+Requires-Dist: rioxarray>=0.15
 Provides-Extra: plots
+Requires-Dist: matplotlib>=3.6; extra == "plots"
+Requires-Dist: plotly>=5.12; extra == "plots"
+Requires-Dist: kaleido>=0.2; extra == "plots"
 Provides-Extra: geospatial
-License-File: LICENSE
+Requires-Dist: geopandas>=0.12; extra == "geospatial"
+Requires-Dist: rasterio>=1; extra == "geospatial"
+Requires-Dist: rtree; extra == "geospatial"
 
 # WindKit
 

{windkit-0.6.3 → windkit-0.8.0}/docs/source/conf.py

@@ -51,6 +51,8 @@ extensions = [
     "nbsphinx",
     # to include notebooks outside the docs folder
     "nbsphinx_link",
+    "IPython.sphinxext.ipython_directive",
+    "IPython.sphinxext.ipython_console_highlighting",
     # Process markdown
     "myst_parser",
 ]

{windkit-0.6.3 → windkit-0.8.0}/docs/source/index.rst

@@ -35,6 +35,7 @@ Contact
     windkit
     wind_climate_objects
     topographic_data
+    wind_turbines
     plotting
     map_conversion
 

{windkit-0.6.3 → windkit-0.8.0}/docs/source/installation.rst

@@ -81,4 +81,9 @@ Plotting dependencies (optional):
   - `plotly <https://plotly.com/python/>`__
 
 Optional dependencies:
+  - `numba <https://numba.pydata.org/>`__ (Used to speed up some functions)
   - `earthengine-api <https://developers.google.com/earth-engine/guides/python_install>`__ (Google Earth Engine: provides access to geospatial data from google. Non-commercial uses only.)
+  - `planetary-computer <https://pypi.org/project/planetary-computer/>`_ (Microsoft Planetary Computer: provides access to geospatial and atmospheric data from Microsoft. Terms of use apply.)
+  - `pystac-client <https://pystac-client.readthedocs.io/en/stable/>`_ (Used to access SpatioTemporal Asset Catalogs (STAC) data on Microsofts Planetary Computer)
+  - `fsspec <https://filesystem-spec.readthedocs.io/en/latest/>`_ (Used for accessing ERA5 data from the Planetary Computer)
+  - `adlfs <https://pypi.org/project/adlfs/>`_ (Used for accessing ERA5 data from the Planetary Computer)

{windkit-0.6.3 → windkit-0.8.0}/docs/source/io/io.rst

@@ -14,7 +14,7 @@ The ``windkit`` module contains several modules for reading and writing WAsP spe
 Wind Climate objects
 --------------------
 
-WAsP works with a number of different :ref:`wind_climates`, which each have their own API. All wind climates have an xarray.Dataset backend, and the binned wind climate (**bwc**) and generalized wind climate (**gwc**) have `dataset accessors <http://xarray.pydata.org/en/stable/internals.html#extending-xarray>`_ that can be used to provide wind specific calculations.
+WAsP works with a number of different :ref:`wind_climates`, which each have their own API. All wind climates have an ``xarray.Dataset`` backend that can be used to provide wind specific calculations.
 
 .. autosummary::
     :toctree: wc_autogen
@@ -38,6 +38,7 @@ Tools to work with windkit wind climate objects.
     weibull
     wind
     wind_climate
+    wind_data
 
 .. _topographic_data_api:
 
@@ -113,6 +114,30 @@ WindKit Plotting allows you to execute a number of different plotting functions
     plot.color
     plot.landcover_map
 
+.. _wind_turbine_api:
+
+Windkit's wind turbine API has routines to load both wind turbine generator power curves, and to create layouts of wind farms.
+
+.. autosummary::
+    :toctree: wind_turbine_autogen
+
+    wind_turbine_generator
+    wind_turbines
+
+.. _ltc_api:
+
+Long Term Correction
+--------------------
+
+Windkit allows to perform long term correction for wind time series using linear regresion or the variance ratio method.
+
+.. autosummary::
+    :toctree: ltc_autogen
+
+    ltc.mcp
+    ltc.regression
+    ltc.scores
+
 .. _other_data_api:
 
 Other data
@@ -124,7 +149,6 @@ Additional windkit functions.
     :toctree: other_autogen
 
     empty
-    wind_turbine
     workspace
 
 .. _metadata_handling_api:

{windkit-0.6.3 → windkit-0.8.0}/docs/source/topographic_data.rst

@@ -60,7 +60,17 @@ Topographic Data Download
 -------------------------
 
 WindKit provides an interface to the `Google Earth Engine
-<https://earthengine.google.com/>`_, which provides several land cover and elevation datasets for download. These can be accessed run through the :py:mod:`windkit.get_map.get_ee_map` function.
+<https://earthengine.google.com/>`_ and `Microsofts Planetary Computer <https://planetarycomputer.microsoft.com/>`_, through the :py:func:`windkit.get_map` function, which provides several land cover and elevation datasets for download.
 
-.. note:: :py:func:`windkit.get_map.get_ee_map` is not imported by default as it relies on the      `earthengine-api
-    <https://developers.google.com/earth-engine/guides/python_install>`_, which is not a dependency and needs to be installed if you wish to use this functionality. Additionally you will need to sign up for a Google Account, and accept their terms of service for the Google Earth Engine.
+.. note:: To acces the Earth Engine Platform, :py:func:`windkit.get_map` relies on the  `earthengine-api
+    <https://developers.google.com/earth-engine/guides/python_install>`_, which is an optional dependency and needs to be installed if you wish to use this functionality.
+
+    Additionally you will need to sign up for a Google Account, and accept their terms of service for the Google Earth Engine.
+
+    Similarly, to access Microsofts Planetary Computer Platform, you will need to install the optional dependencies `planetary-computer <https://pypi.org/project/planetary-computer/>`_ and `pystac_client <https://pystac-client.readthedocs.io/en/stable/>`_.
+
+    Please read the terms of service for both platforms before using download and using data from these platforms.
+
+    `Earth Engine Terms of service <https://earthengine.google.com/terms/>`_
+
+    `Microsofts Planetary Computer terms of service <https://planetarycomputer.microsoft.com/terms>`_