VANE
User guide
Installation
Quickstart
Theory
Data sources
Coordinate systems, origins & datums
Units & conventions
Limitations
Validation matrix
Changelog
Reference
API reference
API contract
Model card — default mode classifier
Developer guide
Contributing
Release checklist
Deployment
VANE
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
|
X
|
Y
A
a (GroundTruthSystem attribute)
(KalmanModel attribute)
(LinFile attribute)
(StateSpace attribute)
avg_a (MBCResult attribute)
avg_b (MBCResult attribute)
avg_c (MBCResult attribute)
avg_d (MBCResult attribute)
azimuth (LinFile attribute)
azimuth_max_deg (OperatingPointProvenance attribute)
azimuth_min_deg (OperatingPointProvenance attribute)
azimuth_spread() (in module vane.modal.uncertainty)
azimuths_deg (MBCResult attribute)
(OperatingPointProvenance attribute)
AzimuthSpread (class in vane.modal.uncertainty)
B
b (KalmanModel attribute)
(LinFile attribute)
(StateSpace attribute)
blade (DofInfo attribute)
BLADE_EDGE_1 (DofCategory attribute)
BLADE_FLAP_1 (DofCategory attribute)
BLADE_FLAP_2 (DofCategory attribute)
blade_length (TurbineGeometry property)
BLADE_PITCH (DofCategory attribute)
build_campbell() (in module vane.campbell.builder)
build_kalman_model() (in module vane.sysid.kalman_interface)
C
c (KalmanModel attribute)
(LinFile attribute)
(StateSpace attribute)
calc_steady (LinearizationConfig attribute)
campbell (PipelineResult attribute)
campbell_from_solutions() (in module vane.campbell.builder)
campbell_table() (in module vane.export)
CampbellDiagram (class in vane.campbell.builder)
category (DofInfo attribute)
(ModeLabel attribute)
category_to_label() (in module vane.modal.labeler)
classify_dof() (in module vane.config.dof_map)
comp (FastModel attribute)
compute_mac() (in module vane.modal.mac)
compute_macxp() (in module vane.modal.mac)
compute_modes() (in module vane.modal.eigensolver)
compute_participation() (in module vane.modal.participation)
condition_numbers (ModalSolution attribute)
confidence (ModeLabel attribute)
(ModeTrack attribute)
covariances_from_confidence() (in module vane.sysid.covariance_init)
CovarianceSet (class in vane.sysid.covariance_init)
created_at (Provenance attribute)
D
d (KalmanModel attribute)
(LinFile attribute)
(StateSpace attribute)
damped_frequencies_hz (ModalSolution attribute)
damping_ratio (ResonanceCrossing attribute)
damping_ratio_std (AzimuthSpread attribute)
damping_ratios (GroundTruthSystem attribute)
(ModalSolution attribute)
(ModeTrack attribute)
dependencies (Environment attribute)
derivative_order (OperatingPointTable attribute)
descriptions (OperatingPointTable attribute)
discover_operating_points() (in module vane.study)
DiscoveredOperatingPoint (class in vane.study)
discretized() (StateSpace method)
dof_descriptions (ModalSolution attribute)
dof_mbc_coordinates (ModalSolution attribute)
DofCategory (class in vane.config.dof_map)
DofInfo (class in vane.config.dof_map)
dominant_dofs (ModeLabel attribute)
dominant_state (ParticipationResult attribute)
DRIVETRAIN_TORSION (DofCategory attribute)
dt (KalmanModel attribute)
(StateSpace attribute)
E
ed_file (FastModel property)
eigenvalues (ModalSolution attribute)
Environment (class in vane.study)
environment (Provenance attribute)
excitation_frequencies() (in module vane.campbell.excitation)
F
FastModel (class in vane.io.fst_reader)
files (DiscoveredOperatingPoint attribute)
(FastModel attribute)
find_blade_triplets() (in module vane.io.mbc_transform)
find_resonances() (in module vane.campbell.excitation)
frequency_hz (ResonanceCrossing attribute)
frequency_weight (Provenance attribute)
FstFileError
full_eigenvectors (ModalSolution attribute)
G
GENERATOR_AZIMUTH (DofCategory attribute)
GroundTruthSystem (class in vane.benchmark)
H
harmonic (ResonanceCrossing attribute)
harmonics (Provenance attribute)
HIGH (ResonanceSeverity attribute)
hub_radius (TurbineGeometry attribute)
I
identification (PipelineResult attribute)
IdentificationResult (class in vane.modal.identifier)
identify_modes() (in module vane.modal.identifier)
initialize_covariances() (in module vane.sysid.covariance_init)
input_names (StateSpace attribute)
is_ambiguous (ModeTrack attribute)
is_degenerate (ModalSolution attribute)
is_discrete (StateSpace property)
is_floating (FastModel property)
is_offshore (FastModel property)
is_stable() (StateSpace method)
is_velocity (DofInfo attribute)
J
jacobians (LinFile attribute)
jacobians_included (LinFile attribute)
K
KalmanModel (class in vane.sysid.kalman_interface)
L
label (ModeLabel attribute)
(ModeTrack attribute)
label_mode() (in module vane.modal.labeler)
label_modes() (in module vane.modal.labeler)
label_solution() (in module vane.modal.labeler)
lin (FastModel attribute)
lin_inputs (LinearizationConfig attribute)
lin_out_jac (LinearizationConfig attribute)
lin_out_mod (LinearizationConfig attribute)
lin_outputs (LinearizationConfig attribute)
lin_times (LinearizationConfig attribute)
LinearizationConfig (class in vane.io.fst_reader)
linearize (LinearizationConfig attribute)
LinFile (class in vane.io.lin_reader)
LinFileFormatError
LOW (ResonanceSeverity attribute)
M
mac_threshold (Provenance attribute)
magnitude (ParticipationResult attribute)
match_modes() (in module vane.modal.mac)
max_condition_number (ModalSolution property)
max_damping_error (ModeRecoveryScore attribute)
max_frequency_error (ModeRecoveryScore attribute)
mbc3_transform() (in module vane.io.mbc_transform)
mbc_coordinates (MBCResult attribute)
mbc_results (PipelineResult attribute)
MBCResult (class in vane.io.mbc_transform)
mean_mac (ModeRecoveryScore attribute)
MEDIUM (ResonanceSeverity attribute)
min_mac (ModeRecoveryScore attribute)
modal_state_space() (in module vane.sysid.modal_to_ss)
modal_state_space_from_solution() (in module vane.sysid.modal_to_ss)
ModalPipeline (class in vane.pipeline)
ModalSolution (class in vane.modal.eigensolver)
mode_indices (ModeTrack attribute)
mode_shapes (GroundTruthSystem attribute)
(ModalSolution attribute)
ModeLabel (class in vane.modal.labeler)
ModeRecoveryScore (class in vane.benchmark)
modes_from_mbc() (in module vane.modal.eigensolver)
modes_table() (in module vane.export)
ModeTrack (class in vane.modal.identifier)
module
vane.benchmark
vane.campbell.builder
vane.campbell.excitation
vane.config.dof_map
vane.export
vane.io.fst_reader
vane.io.lin_reader
vane.io.mbc_transform
vane.modal.eigensolver
vane.modal.identifier
vane.modal.labeler
vane.modal.mac
vane.modal.participation
vane.modal.uncertainty
vane.pipeline
vane.study
vane.sysid.covariance_init
vane.sysid.kalman_interface
vane.sysid.modal_to_ss
vane.sysid.state_space
vane.viz.campbell_plot
vane.viz.damping_plot
vane.viz.modeshape_3d
vane.viz.modeshape_static
module (DofInfo attribute)
modules (OperatingPointTable property)
multiblade (ModeLabel attribute)
N
n_azimuths (AzimuthSpread attribute)
(OperatingPointProvenance attribute)
n_blades (MBCResult attribute)
n_inputs (StateSpace property)
n_lin_times (LinearizationConfig attribute)
n_matched (ModeRecoveryScore attribute)
n_modes (ModalSolution property)
n_operating_points (CampbellDiagram attribute)
(IdentificationResult attribute)
n_outputs (StateSpace property)
n_overdamped (ModalSolution attribute)
n_resonances (Provenance attribute)
n_rigid_body_modes (ModalSolution attribute)
n_states (StateSpace property)
n_tracks (Provenance attribute)
n_u (LinFile property)
n_unstable (ModalSolution attribute)
n_x (LinFile property)
n_y (LinFile property)
NACELLE_YAW (DofCategory attribute)
name (DiscoveredOperatingPoint attribute)
(OperatingPointProvenance attribute)
natural_frequencies_hz (GroundTruthSystem attribute)
(ModalSolution attribute)
(ModeTrack attribute)
natural_frequencies_rad_s (ModalSolution property)
natural_frequency_std (AzimuthSpread attribute)
ndof1 (MBCResult attribute)
ndof2 (GroundTruthSystem attribute)
(MBCResult attribute)
num_blades (TurbineGeometry attribute)
O
operating_points (ModeTrack attribute)
(Provenance attribute)
OperatingPointProvenance (class in vane.study)
OperatingPointTable (class in vane.io.lin_reader)
output_names (KalmanModel attribute)
(StateSpace attribute)
P
p0 (CovarianceSet attribute)
(KalmanModel attribute)
parameter_name (CampbellDiagram attribute)
(PipelineResult attribute)
(Provenance attribute)
parameter_value (OperatingPointProvenance attribute)
parameter_values (CampbellDiagram attribute)
participation_from_modes() (in module vane.modal.participation)
ParticipationResult (class in vane.modal.participation)
path (FastModel attribute)
(LinFile attribute)
(SourceFile attribute)
per_azimuth_a (MBCResult attribute)
performed_transformation (MBCResult attribute)
phase_deg (ParticipationResult attribute)
pipeline (StudyResult attribute)
PipelineResult (class in vane.pipeline)
platform (Environment attribute)
PLATFORM_HEAVE (DofCategory attribute)
PLATFORM_PITCH (DofCategory attribute)
PLATFORM_ROLL (DofCategory attribute)
PLATFORM_SURGE (DofCategory attribute)
PLATFORM_SWAY (DofCategory attribute)
PLATFORM_YAW (DofCategory attribute)
plot_campbell() (in module vane.viz.campbell_plot)
plot_damping() (in module vane.viz.damping_plot)
plot_mode_3d() (in module vane.viz.modeshape_3d)
plot_mode_shape() (in module vane.viz.modeshape_static)
Provenance (class in vane.study)
provenance (StudyResult attribute)
python_version (Environment attribute)
Q
q (CovarianceSet attribute)
(KalmanModel attribute)
R
r (CovarianceSet attribute)
(KalmanModel attribute)
read_elastodyn_geometry() (in module vane.io.fst_reader)
read_fst_file() (in module vane.io.fst_reader)
read_lin_file() (in module vane.io.lin_reader)
ResonanceCrossing (class in vane.campbell.excitation)
resonances (PipelineResult attribute)
ResonanceSeverity (class in vane.campbell.excitation)
robustness_curve() (in module vane.benchmark)
rotating_frame (OperatingPointTable attribute)
ROTOR_FURL (DofCategory attribute)
rotor_speed (LinFile attribute)
rotor_speed_rpm (MBCResult attribute)
(OperatingPointProvenance attribute)
(ResonanceCrossing attribute)
run() (ModalPipeline method)
run_study() (in module vane.study)
S
score_recovery() (in module vane.benchmark)
severity (ResonanceCrossing attribute)
sha256 (SourceFile attribute)
signed_magnitude (ParticipationResult attribute)
sim_time (LinFile attribute)
solutions (PipelineResult attribute)
source_files (OperatingPointProvenance attribute)
(Provenance property)
SourceFile (class in vane.study)
state_descriptions (MBCResult attribute)
state_names (KalmanModel attribute)
(StateSpace attribute)
state_space() (PipelineResult method)
state_space_from_mbc() (in module vane.sysid.state_space)
StateSpace (class in vane.sysid.state_space)
StudyResult (class in vane.study)
synthetic_system() (in module vane.benchmark)
T
TAIL_FURL (DofCategory attribute)
TEETER (DofCategory attribute)
tip_radius (TurbineGeometry attribute)
to_dict() (Provenance method)
tower_base_height (TurbineGeometry attribute)
TOWER_FORE_AFT_1 (DofCategory attribute)
TOWER_FORE_AFT_2 (DofCategory attribute)
tower_height (TurbineGeometry attribute)
tower_length (TurbineGeometry property)
TOWER_SIDE_SIDE_1 (DofCategory attribute)
TOWER_SIDE_SIDE_2 (DofCategory attribute)
track_curve() (CampbellDiagram method)
track_index (ResonanceCrossing attribute)
tracks (CampbellDiagram attribute)
(IdentificationResult attribute)
(PipelineResult property)
trim_case (LinearizationConfig attribute)
trim_gain (LinearizationConfig attribute)
trim_tol (LinearizationConfig attribute)
TurbineGeometry (class in vane.io.fst_reader)
U
u (LinFile attribute)
unified_mode_confidence() (in module vane.modal.uncertainty)
UNKNOWN (DofCategory attribute)
V
values (OperatingPointTable attribute)
vane.benchmark
module
vane.campbell.builder
module
vane.campbell.excitation
module
vane.config.dof_map
module
vane.export
module
vane.io.fst_reader
module
vane.io.lin_reader
module
vane.io.mbc_transform
module
vane.modal.eigensolver
module
vane.modal.identifier
module
vane.modal.labeler
module
vane.modal.mac
module
vane.modal.participation
module
vane.modal.uncertainty
module
vane.pipeline
module
vane.study
module
vane.sysid.covariance_init
module
vane.sysid.kalman_interface
module
vane.sysid.modal_to_ss
module
vane.sysid.state_space
module
vane.viz.campbell_plot
module
vane.viz.damping_plot
module
vane.viz.modeshape_3d
module
vane.viz.modeshape_static
module
vane_version (Provenance attribute)
W
wind_speed (LinFile attribute)
(MBCResult attribute)
(OperatingPointProvenance attribute)
write_bundle() (StudyResult method)
write_table() (in module vane.export)
X
x (LinFile attribute)
xdot (LinFile attribute)
Y
y (LinFile attribute)