Falwa

Latest version: v2.0.0

Safety actively analyzes 706267 Python packages for vulnerabilities to keep your Python projects secure.

Scan your dependencies

Page 2 of 5

0.7.2

This release requires **recompilation of fortran modules**.

Two weeks ago, we discovered that there is a mistake in the derivation of expression of nonlinear zonal advective flux term:
$$\frac{1}{a\cos\phi} \frac{\partial}{\partial \lambda} \int^{\Delta\phi}_0 u_e q_e \cos(\phi+\phi^\prime) d\phi^\prime$$

The correct definition of $u_e$ in the integral should be:

$$u_e(\lambda, \phi, \phi^\prime, z, t) \equiv \omega_e a \cos\phi = \frac{u(\lambda, \phi + \phi^\prime, z, t)\cos\phi}{\cos(\phi+\phi^\prime)} - u_{\text{REF}}(\phi, z, t)$$

where $\omega = \frac{u}{a\cos\phi}$ is the angular velocity (and $\phi^\prime \in [0, \Delta\phi]$).

The fix has been done in the following commit and will be published in release 0.7.2:

https://github.com/csyhuang/hn2016_falwa/commit/1995e1dfcd422c61b0a6728d1d54a6fbb2f2cf58#diff-7e797030d6c037af018d523e2e6a20f0d9f01c3dd8f41a2d7f044b4800684455

This error led to an *underestimation* of nonlinear component of advective flux ("ua2" in the code). Fixing this error indeed makes traffic jam mechanism (i.e. how waves are slowed down by the nonlinear effect that grows with wave amplitude) more robust.

We will submit corrigendums for [Neal et al. (2022, GRL)](https://agupubs.onlinelibrary.wiley.com/doi/full/10.1029/2021GL097699) and [Nakamura and Huang (2018, Science)](https://www.science.org/doi/10.1126/science.aat0721) to update the numerical results. The correct derivation of the flux expression can be found in the corrected supplementary materials of NH18. There is no change in conclusions in any of the articles.

Please refer to Issue 83 for a preliminary comparison between originally published figures and updated figures.

0.7.1

- Remove the use of `setuptools` in `setup.py`
- Dependencies in `environment.yml` matches MDTF
- Dependencies in `setup.py` changed (for the sake of MDTF incorporation)
- Deployment onto Conda channel (at least for Linux) is included in `notes/developer/conda_deployment.md`
- Deployment using pip (only include source code)
- Migrate completely to python 3.10 (TODO: fix GitHub workflow)
- Match MDTF package version requirements in pip
- Deployed on [https://pypi.org/project/hn2016-falwa/0.7.1/](https://pypi.org/project/hn2016-falwa/0.7.1/)

0.7.0

- Now `northern_hemisphere_results_only` becomes an input argument for `QGField`. Please initialize this when creating `QGField` object and remove this argument from the methods (`compute_reference_states` and `compute_lwa_and_barotropic_fluxes`).
- `eq_boundary_index` is now an input arguemnt merely for `QGFieldNHN22`, but not `QGFieldNH18`. Remove it if you are using `QGField`/`QGFieldNH18`. You can refer to the jupyter notebook examples for the updated usage.

0.6.6

This minor release include a fix in graph plot procedure `scripts/nhn_grl2022/graph_plot_module.py` - the plotting script for the residual plot is fixed such that it produces the same plot on different machines.

0.6.5

This is a minor release that fixes the issues with `setup.py` that cannot locate the compiled fortran modules. Thanks chpolste for fixing this!

The archive on PyPI has also been also fixed in v0.6.5.

0.6.4

This release includes the fix for the calculation of meridional flux component. See the [correction note](https://github.com/csyhuang/hn2016_falwa/blob/aa45499fcfb0bdc0236f93b39c83bd9f68ef9abb/notes/LWA-budget-on-the-sphere-revised-20221230.pdf) for details. The corrigendum on Neal et al 2022, GRL corresponds to this release.

The main change in the calculation can be found in this commit: 38d95f6202f2b0d052263437a61124fe3ace0d65

Please remove all the compiled fortran modules on your machine and `git pull` the newest version of fortran codes for installation (`python setup.py develop`).

Page 2 of 5

© 2025 Safety CLI Cybersecurity Inc. All Rights Reserved.