VANE documentation
==================

**VANE** — Visualization and Automated Natural-frequency Extraction — is a Python
library for automated OpenFAST linearization post-processing, physics-aware mode
identification, and digital-twin-ready state-space export for fixed-bottom and
floating offshore wind turbines.

.. note::

   VANE is in alpha. The public API may change before the first tagged release.

VANE turns a set of OpenFAST linearization (``.lin``) files into identified,
labelled, uncertainty-aware modes, a Campbell diagram with resonance crossings, and a
clean state-space model ready for a Kalman-filter digital twin — in a few lines of
code, with validation against analytical and reference solutions.

.. toctree::
   :maxdepth: 2
   :caption: User guide

   user_guide/installation
   user_guide/quickstart
   user_guide/theory
   user_guide/data_sources
   user_guide/coordinate_systems
   user_guide/units_conventions
   user_guide/limitations
   user_guide/validation_matrix
   user_guide/changelog

.. toctree::
   :maxdepth: 2
   :caption: Reference

   reference/api_reference
   reference/api_contract
   reference/model_card

.. toctree::
   :maxdepth: 2
   :caption: Developer guide

   developer_guide/contributing
   developer_guide/release_checklist
   developer_guide/deployment

Indices
-------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`