.. _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.

General-purpose functions
=========================

.. autosummary::
   :toctree: general_autogen

   pywasp.raster_to_vector
   pywasp.vector_to_raster
   pywasp.LandCoverTable
   pywasp.polygons_to_lines
   pywasp.add_met_fields
   pywasp.estimate_sensitivity_factor
   pywasp.get_air_density
   pywasp.bwc_from_tswc
   pywasp.bwc_resample_like
   pywasp.bwc_resample_sectors
   pywasp.bwc_resample_wsbins_like
   pywasp.calc_temp_scale
   pywasp.stability_histogram
   pywasp.gross_aep
   pywasp.net_aep
   pywasp.potential_aep
   pywasp.px_aep
   pywasp.wind_farm_flow_map
   pywasp.weibull_fit


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

.. autosummary::
   :toctree: wasp_autogen

   pywasp.wasp
   pywasp.wasp.Config
   pywasp.wasp.TopographyMap
   pywasp.wasp.get_site_effects_cfd
   pywasp.wasp.predict_wwc
   pywasp.wasp.predict_wwc_from_site_effects
   pywasp.wasp.predict_bwc
   pywasp.wasp.predict_bwc_from_site_effects
   pywasp.wasp.downscale
   pywasp.wasp.downscale_from_site_effects
   pywasp.wasp.downscale_from_geostrophic_and_site_effects_to_wwc
   pywasp.wasp.downscale_from_geostrophic_and_site_effects_to_bwc
   pywasp.wasp.generalize
   pywasp.wasp.generalize_from_site_effects
   pywasp.wasp.generalize_from_site_effects_to_geowc
   pywasp.wasp.interpolate_gwc

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.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: user_config_autogen

   pywasp.user_config