.. _api:

=============
API Reference
=============

This page provides an auto-generated summary of pywasps's API. For more details
and examples, refer to the relevant chapters in the main part of the
documentation.

WAsP
====================

.. autosummary::
   :toctree: wasp_autogen

   pywasp.wasp
   pywasp.wasp.Config
   pywasp.wasp.TopographyMap
   pywasp.wasp.get_wasp_down
   pywasp.wasp.set_hgts
   pywasp.wasp.set_z0s
   pywasp.wasp.downscale
   pywasp.wasp.generalize
   pywasp.wasp.generalize_and_downscale
   pywasp.wasp.add_met_fields
   pywasp.wasp.probabilities
   pywasp.wasp.wtg_to_pywake
   pywasp.wasp.gross_aep
   pywasp.wasp.potential_aep
   pywasp.wasp.wind_farm_flow_map
   pywasp.wasp.get_air_density
   pywasp.wasp.bwc_from_timeseries
   pywasp.wasp.calc_temp_scale
   pywasp.wasp.stability_histogram
   pywasp.wasp.interpolate_gwc
   pywasp.wasp.get_climate
   pywasp.wasp.get_climate_by_config
   pywasp.wasp.weibull_fit

I/O
====================

.. autosummary::
   :toctree: io_autogen

   pywasp.io
   pywasp.io.WaspRasterMap
   pywasp.io.rastermap_to_vectormap
   pywasp.io.rastermap_to_waspformat
   pywasp.io.vectormap_to_rastermap
   pywasp.io.vectormap_to_waspformat


LINCOM
====================

.. autosummary::
   :toctree: lincom_autogen

   pywasp.lincom
   pywasp.lincom.calculate_fetchmap
   pywasp.lincom.roughness_to_landmask
   pywasp.lincom.FourierSpace
   pywasp.lincom.interpolate_gewc
   pywasp.lincom.open_raster
   pywasp.lincom.grid_from_wasp_rastermap
   pywasp.lincom.shear_exp_from_wspd
   pywasp.lincom.get_spec_corr_fac
   pywasp.lincom.get_return_wind
   pywasp.lincom.apply_lut
   pywasp.lincom.create_lut
   pywasp.lincom.create_wind
   pywasp.lincom.WindLevel
   pywasp.lincom.get_wind_points

User configuration
==================

.. autosummary::
   :toctree: pwconfig_autogen

   pywasp.config