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.

User guide

• Installation
  • Requirements
  • From source (recommended during alpha)
  • Optional extras
  • Verifying the installation
• Quickstart
  • End-to-end pipeline
  • Grouping .lin files
  • Lower-level building blocks
  • Reproducible studies
  • Data-free demonstration
• Theory
  • Linearization
  • Multi-blade coordinate (MBC3) transform
  • Eigenanalysis
  • Mode identification
  • Cross-operating-point tracking
  • Uncertainty quantification
  • State-space export
• Data sources
  • Linearization files (.lin)
  • Model files (.fst and ElastoDyn)
  • Azimuth sweeps and operating points
  • What VANE never reads or stores
• Coordinate systems, origins & datums
  • Reference frames
  • Azimuth convention
  • State-space layout
  • Degree-of-freedom mapping
  • Origins and datums
• Units & conventions
  • Quantities and units
  • Sign and normalisation conventions
  • Confidence and uncertainty
  • Tabular export
• Limitations
  • Input format and rotor
  • Averaged-model assumptions
  • Mode tracking
  • Resonance detection
  • AI components are experimental
  • Scope
• Validation matrix
  • Validation
• Changelog
  • Changelog

Reference

• API reference
  • Package root
  • I/O
  • Modal analysis
  • Configuration
  • Campbell diagram
  • System identification
  • Visualization
  • Export
  • Benchmark
  • Pipeline
  • Study and provenance
• API contract
  • General guarantees
  • Entry-point guarantees
  • Exceptions
  • Stability
• Model card — default mode classifier
  • Model details
  • Training data
  • Intended use
  • Out-of-scope use
  • Metrics
  • Path to graduation

Developer guide

• Contributing
  • Contributing to VANE
• Release checklist
  • Pre-release
  • Cutting the release
  • Post-release
  • Versioning
• Deployment
  • Continuous integration
  • Documentation
  • Package publishing
  • Security scanning

Indices

• Index

• Module Index

• Search Page