Wavy
====

Welcome to **wavy**!

Introduction
============
**wavy** is an open source package with the main goal of easing the task of wave model validation and other metocean related tasks. The user can use in-situ observation or satellite altimeters for collocation, calibration, and validation. Variables that are commonly used are significant wave height, wind speed, and sea level anomaly but other variables can simply be added by the user.

.. |ex1| image:: ./docs_fig_sat_waves.png
   :scale: 50

.. |ex2| image:: ./docs_fig_sat_wind.png
   :scale: 50

.. |ex3| image:: ./docs_fig_sat_vs_mod_waves.png
   :scale: 50

.. |ex4| image:: ./docs_fig_sat_vs_mod_wind.png
   :scale: 50

+-------------------+------------------+
| |ex1|             | |ex2|            |
|                   |                  |
+-------------------+------------------+
| |ex3|             | |ex4|            |
|                   |                  |
+-------------------+------------------+

.. note::

   This project is under active development. I try to keep the documentation pristine. Please do not hesitate to contact me if you experience troubles, have questions, or would like to contribute.

Credits
=======
If you are using **wavy** please mention the repo under https://github.com/bohlinger/wavy and for info from the documentation refer to this page `https://wavyopen.readthedocs.io/ <https://wavyopen.readthedocs.io/en/latest/index.html>`_. Additionally, the collocation methodology should be referred to with the following article:

* Bohlinger, P., Breivik, Ø., Economou, T., Müller, M.: `A novel approach to computing super observations for probabilistic wave model validation <https://www.sciencedirect.com/science/article/pii/S1463500319300435>`_, Ocean Modelling, 139, `<https://doi.org/10.1016/j.ocemod.2019.101404>`_, 2019.

A selection of published studies and other work that use **wavy** can be found under :ref:`credits-label`.

Contents
========

.. toctree::
   :maxdepth: 4
   :glob:

   installation
   tutorials
   workshops
   oneocean
   credits
   gallery
   autoapi/index


Indices and tables
==================

* :ref:`genindex`
* :ref:`search`
* :doc:`autoapi/index`