.. _pywasp:

PyWAsP
======

.. figure:: _static/speedups_animation.gif
    :align: center

    PyWAsP makes in easy to estimate terrain effects on the flow and generate maps
    like the directional speed-ups shown in this figure for a complex site on the Portuguese coast.
    For reference, the small sub-figures on the right (c-d) shows a sattelite picture, the elevation, and the surface roughness for the site.


PyWAsP provides a Python API for running the models included in WAsP.

The primary functionality of PyWAsP is: 

- **Terrain effects**: Estimate the effects of terrain on the flow, including speed-up and directional effects.
- **Wind resource assessment**: Estimate the wind resource at a site by extrapolating known wind climates to new locations. 
- **AEP estimation**: Estimate the annual energy production (AEP) of wind turbines at a site, taking into account the effects of wakes, losses, and uncertainty.

In addtion to the user guide, several examples and tutorials are available to show how to use the various WAsP routines. The goal of the API is to provide an easy-to-script interface.

Read more in :ref:`getting_started`


.. toctree::
    :hidden:
    :caption: Documentation
    :maxdepth: 2

    getting_started/getting_started
    user_guide/user_guide
    auto_examples/index
    tutorials/tutorials
    api_reference/api_reference
    release_notes
    pywasp_forum
    order_pywasp
    faq/faq

References
==================

.. bibliography:: WAsP.bib
   :cited:
   :style: plain