Falwa: Python Package to Implement Finite-Amplitude Local Wave Activity Diagnostics on Climate Data

Weather at the mid-latitudes is governed by cyclones and anticyclones mostly migrating eastward. These weather systems cause the jet streams to undulate; the meandering patterns are known as the Rossby waves. Occasionally, Rossby waves bring forth localised extreme weather phenomena. An example of a finite-amplitude wave phenomenon is atmospheric blocking, which is often associated with heat waves and droughts. Recent development of a finite-amplitude local wave activity (FALWA) theory by Nakamura and collaborators enables comprehensive analysis of the dynamics of finite-amplitude Rossby waves observed in climate data, which helps to understand the drivers of their life cycles. Despite the simplicity of interpretation it brings about, to apply the FALWA diagnostic to climate data requires more involved calculations than the traditional Eulerian framework. This article introduces the open-source Python package falwa, which encapsulates the FALWA diagnostics implemented on gridded climate data presented in the authors' previous publications. It reviews the essence of the FALWA theory, the corresponding components in the package that implement the calculations, and where users can find sample notebooks to start with. It aims to serve as a road map for new users to easily navigate through this package. The latter half of this article documents the practices of the developers, which include the documentation tools, continuous integration practice, and repository maintenance using automated GitHub functionalities. The authors also discuss existing numerical issues and future improvement plans. This open-source project aims to promote the broader application of FALWA diagnostics on climate data and model outputs by streamlining complex numerical computations.