.. VIVyD documentation master file, created by
   sphinx-quickstart on Fri Apr 24 12:09:14 2026.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

VIVyD documentation
===================

Welcome to the documentation for VIVyD, a Python package for simulating vortex-induced vibrations (VIV) in a unified framework. This documentation provides an overview of the package's features, installation instructions, and usage examples.

.. toctree::
   :maxdepth: 1
   :caption: User Guide

   quickstart
..    quickstart
..    theory
..    models
..    solvers
..    data

.. toctree::
   :maxdepth: 1
   :caption: Reference

   api
   references