Diagnostic (rojak.turbulence.diagnostic)

Clear-air turbulence (CAT) diagnostics

This module implements the individual CAT diagnostics as Diagnostic subclasses (e.g. Frontogenesis3D, TurbulenceIndex1, GradientRichardson, DuttonIndex), each computing a diagnostic value from the underlying meteorological fields and physical quantities in rojak.turbulence.calculations. DiagnosticFactory constructs the appropriate Diagnostic for a given TurbulenceDiagnostics from a CATData source.

DiagnosticSuite and its subclasses (CalibrationDiagnosticSuite, EvaluationDiagnosticSuite) group together the diagnostics computed for a dataset, either freshly computed via a DiagnosticFactory or reloaded from zarr, and drive the higher-level post-processing in rojak.turbulence.analysis (percentile thresholds, EDR mapping, turbulent regions, and probabilities) across all diagnostics in the suite.

Classes

BrownIndex1(shear_deformation, ...)	Brown Index 1 CAT diagnostic
BrownIndex2(u_wind, v_wind, geopotential, ...)	Brown Index 2 CAT diagnostic
BruntVaisalaFrequency(potential_temperature, ...)	Brunt Väisälä frequency CAT diagnostic
CalibrationDiagnosticSuite(factory, diagnostics)	A DiagnosticSuite computed on a calibration dataset, used to derive severity thresholds and EDR distribution parameters for an EvaluationDiagnosticSuite
ColsonPanofsky(u_wind, v_wind, altitude, ...)	Colson-Panofsky CAT diagnostic
DeformationSquared(total_deformation)	Total Deformation Squared CAT diagnostic
Diagnostic(name)	Abstract class for diagnostic classes.
DiagnosticFactory(data)	Factory class for diagnostic calculations.
DiagnosticSuite(_factory, _diagnostics)	A collection of computed turbulence diagnostics
DirectionalShear(u_wind, v_wind, geopotential)	Directional Shear CAT diagnostic
DuttonIndex(u_wind, v_wind, geopotential[, ...])	Dutton's empirical index CAT diagnostic
EDRLunnon(u_wind, v_wind, shear_deformation, ...)	EDR Lunnon CAT diagnostic
Endlich(u_wind, v_wind, geopotential)	Endlich CAT Diagnostic
EvaluationDiagnosticSuite(factory, diagnostics)	A DiagnosticSuite computed on an evaluation dataset, with severity- and threshold-based post-processing
Frontogenesis2D(u_wind, v_wind, ...)	Two-dimensional frontogenesis CAT diagnostic
Frontogenesis3D(u_wind, v_wind, ...)	Three-dimensional frontogenesis CAT diagnostic
GradientPotentialVorticity(potential_vorticity)	Gradient potential vorticity CAT diagnostic
GradientRichardson(vws, brunt_vaisala[, ...])	Gradient Richardson Number CAT diagnostic
HorizontalDivergence(divergence)	Horizontal Divergence CAT diagnostic
HorizontalTemperatureGradient(temperature)	Horizontal temperature gradient CAT Diagnostic
LoadedFromZarr(name, computed_value)	A Diagnostic wrapping a value that has already been computed (e.g. reloaded from a zarr store), rather than one computed from raw meteorological fields.
MagnitudePotentialVorticity(potential_vorticity)	Magnitude potential vorticity CAT diagnostic
Ncsu1(u_wind, v_wind, ri, ...)	NCSU1 CAT diagnostic as defined in [Sharman2006]
NegativeVorticityAdvection(u_wind, v_wind, ...)	Negative vorticity advection CAT diagnostic
NestedGridModel1(u_wind, v_wind, ...)	Nested Grid Model 1 CAT Diagnostic
NestedGridModel2(temperature, geopotential, ...)	Nested Grid Model 2 CAT Diagnostic
TurbulenceIndex1(u_wind, v_wind, ...)	Turbulence Index 1 CAT diagnostic
TurbulenceIndex2(u_wind, v_wind, ...)	Turbulence Index 2 CAT diagnostic
UBF(u_wind, v_wind, geopotential, vorticity, ...)	Residual of the Unbalance Flow (UBF) Equation CAT diagnostic
VerticalVorticitySquared(vorticity)	Vertical Vorticity Squared CAT diagnostic
VerticalWindShear(u_wind, v_wind, geopotential)	Vertical wind shear CAT diagnostic
WindDirection(u_wind, v_wind)	Wind Direction CAT diagnostic
WindSpeed(u_wind, v_wind)	Wind Speed CAT diagnostic