.. _examples:

Examples
========

Below, you can find examples of how NetSSE functions are used for sea state estimation from
various observation platforms.

The examples are in the form of Python scripts (Jupyter notebooks) and can also be found in the `examples directory on GitLab
<https://gitlab.gbar.dtu.dk/regmo/NetSSE/-/tree/master/docs/examples>`_. If you would like to run the examples, you can download the notebooks and the corresponding data files from GitLab, and run them in a Python environment with the required dependencies installed.


Contents
--------

The examples are divided into three categories, depending on the scientific focus:

.. toctree::
    :caption: A. Modelling the ocean wave environment.
    :titlesonly:

    example1
    example2

.. toctree::
    :caption: B. Wave-induced response of surface-floating marine vessels.
    :titlesonly:

    example3
    example4

.. toctree::
    :caption: C. Inverse methods for sea state estimation from vessel measurements.
    :titlesonly:

    example5