Published March 15, 2026 | Version v2.3.3
Software Open

csyhuang/hn2016_falwa: Release v2.3.3 - barotropic flux vector calculation and bugfix for Southern Hemispheric eddy momentum divergence sign error (ep2/ep3 swapped)

Description

Major changes

  • This release includes a new feature to QGFieldBase - the flux_vector_lambda_baro and flux_vector_phi_baro properties respectively corresponds to the zonal and meridional components of the barotropic local wave activity flux vector, e.g., Lee & Nakamura (2024, eq. 6 and 7). Thanks Nicolas Lazaro @CooperBigFoot for constructing this feature and included comprehensive unit tests!
  • There was a sign error in computation of eddy momentum flux divergence, which involves a swap of ep2 and ep3 terms for the Southern Hemisphere. This has been fixed in both compute_lwa_and_barotropic_fluxes() and compute_layerwise_lwa_fluxes() methods. See revised plots in notebooks/demo_script_for_nh2018.ipynb and notebooks/nhn22_reference_states.ipynb for a comparison of QGField.divergence_eddy_momentum_flux and QGField.flux_vector_phi_baro as a verification.

Minor changes

  • Layerwise flux properties with guard checks
  • New Utility Function - meridional_divergence()
  • Data Storage Updates - New flux vector storage fields
  • Xarray Interface Updates - New variables, new compute_layerwise_lwa_fluxes() method
  • Documentation Improvements - Enhanced docstrings with LaTeX formulas for new public properties
  • Test Improvements - New parameterized tests for both QGField classes
  • CI/CD Improvements - Major overhaul of PyPI publishing workflow with cibuildwheel
  • Notebook Updates - Output regeneration across multiple notebooks

If you find any bugs/issues with this package, please submit an issue ticket to inform the developers. Thanks!

Files

csyhuang/hn2016_falwa-v2.3.3.zip

Files (72.1 kB)

Name Size Download all
md5:617f28f9110ed4362fbabda634825600
72.1 kB Preview Download

Additional details

Related works