API reference
=============

The reference is generated from the in-source NumPy-style docstrings. Only the public
entry points are shown; private helpers (leading underscore) are intentionally
omitted.

Package root
------------

For convenience the package root re-exports the most common entry points so they can
be imported directly as ``from vane import ...``:

* :class:`~vane.pipeline.ModalPipeline`, :class:`~vane.pipeline.PipelineResult`
* :func:`~vane.study.run_study`, :func:`~vane.study.discover_operating_points`,
  :class:`~vane.study.StudyResult`, :class:`~vane.study.Provenance`

Each is documented in its module section below.

I/O
---

.. automodule:: vane.io.lin_reader
   :members:

.. automodule:: vane.io.fst_reader
   :members:

.. automodule:: vane.io.mbc_transform
   :members:

Modal analysis
--------------

.. automodule:: vane.modal.eigensolver
   :members:

.. automodule:: vane.modal.mac
   :members:

.. automodule:: vane.modal.participation
   :members:

.. automodule:: vane.modal.identifier
   :members:

.. automodule:: vane.modal.labeler
   :members:

.. automodule:: vane.modal.uncertainty
   :members:

Configuration
-------------

.. automodule:: vane.config.dof_map
   :members:

Campbell diagram
----------------

.. automodule:: vane.campbell.builder
   :members:

.. automodule:: vane.campbell.excitation
   :members:

System identification
---------------------

.. automodule:: vane.sysid.state_space
   :members:

.. automodule:: vane.sysid.modal_to_ss
   :members:

.. automodule:: vane.sysid.covariance_init
   :members:

.. automodule:: vane.sysid.kalman_interface
   :members:

Visualization
-------------

.. automodule:: vane.viz.campbell_plot
   :members:

.. automodule:: vane.viz.damping_plot
   :members:

.. automodule:: vane.viz.modeshape_static
   :members:

.. automodule:: vane.viz.modeshape_3d
   :members:

Export
------

.. automodule:: vane.export
   :members:

Benchmark
---------

.. automodule:: vane.benchmark
   :members:

Pipeline
--------

.. automodule:: vane.pipeline
   :members:

Study and provenance
--------------------

.. automodule:: vane.study
   :members: