.. _pywasp:

######
PyWAsP
######

**Wind resource assessment and energy yield prediction in Python**

PyWAsP provides a Python API for the WAsP flow model - the industry-standard
software for wind resource assessment and siting of wind turbines developed
at DTU Wind Energy.

----

Key Features
------------

.. grid:: 1 2 3 3
    :gutter: 4

    .. grid-item-card:: Terrain Effects
        :class-card: feature-card

        Estimate the effects of terrain on the flow, including speed-up, turning,
        and directional effects using the WAsP IBZ model.

    .. grid-item-card:: Wind Resource Assessment
        :class-card: feature-card

        Extrapolate known wind climates to new locations using the generalization
        and downscaling routines from WAsP.

    .. grid-item-card:: AEP Estimation
        :class-card: feature-card

        Calculate annual energy production (AEP) of wind turbines, accounting for
        wakes (via PyWake), losses, and uncertainty.

----

Choose Your Path
----------------

.. grid:: 1 2 3 3
    :gutter: 4

    .. grid-item-card:: New to PyWAsP?
        :link: getting_started/getting_started
        :link-type: doc
        :class-card: pathway-card

        Start here if you're new to PyWAsP. Learn the basics of installation,
        key concepts, and run your first calculation.

        +++
        :bdg-primary:`Recommended for beginners`

    .. grid-item-card:: Coming from WAsP GUI?
        :link: getting_started/from_wasp_to_pywasp
        :link-type: doc
        :class-card: pathway-card

        Already familiar with WAsP? Learn how PyWAsP concepts map to what you
        already know from the WAsP graphical interface.

        +++
        :bdg-info:`For WAsP users`

    .. grid-item-card:: Python Developer?
        :link: getting_started/working_with_xarray_and_windkit
        :link-type: doc
        :class-card: pathway-card api

        Experienced Python developer? Jump straight into the data structures
        and learn about xarray/WindKit integration.

        +++
        :bdg-secondary:`For developers`

    .. grid-item-card:: Learn WindKit
        :link: https://docs.wasp.dk/windkit
        :class-card: pathway-card tutorial

        WindKit is the foundation of PyWAsP. Master its data structures, I/O
        functions, and spatial operations to work effectively with PyWAsP.

        +++
        :bdg-warning:`Essential foundation`

    .. grid-item-card:: Hands-on Tutorials
        :link: tutorials/tutorials
        :link-type: doc
        :class-card: pathway-card

        Follow step-by-step tutorials covering complete PyWAsP workflows,
        from basic WRA to advanced topics.

        +++
        :bdg-success:`Guided learning`

----

Quick Links
-----------

.. grid:: 2 3 4 4
    :gutter: 3

    .. grid-item::

        **Getting Started**

        - :doc:`getting_started/installation`
        - :doc:`getting_started/quick_overview`
        - :doc:`getting_started/why_pywasp`

    .. grid-item::

        **User Guide**

        - :doc:`user_guide/user_guide`
        - :doc:`user_guide/wind_climates`
        - :doc:`user_guide/calculate_aep`

    .. grid-item::

        **Learn**

        - :doc:`tutorials/tutorials`
        - :doc:`auto_examples/index`

    .. grid-item::

        **Reference**

        - :doc:`api_reference/api_reference`
        - :doc:`release_notes`
        - :doc:`faq/faq`

----

.. toctree::
    :hidden:
    :maxdepth: 2

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

----

References
----------

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