hn2016_falwa: Finite-amplitude local wave activity

https://github.com/csyhuang/csyhuang.github.io/raw/master/assets/img/hn2016_falwa_diagram.png

hn2016_falwa is a python library that provides tools to measure and study life cycle of large-scale extreme weather events. It implements the finite-amplitude local wave activity and flux diagnostic introduced in:

To users

If you are interested in using the package, please leave your contact here such that I can keep you updated of any changes made.

Installation

This current version works in both Python 2.7 and 3.6. Note that from v0.3.0 onword, some functions are having backend in Fortran. You will need a fortran compiler (e.g. gfortran) to implement the installation.

Dependencies include Numpy, Scipy and optionally Matplotlib. Since the package is still being actively developed, please use the develop mode for installation:

git clone https://github.com/csyhuang/hn2016_falwa.git
cd hn2016_falwa
python setup.py develop

To incorporate updates, pull the new version of the code by:

git pull

Developer v.s. Object-oriented Interfaces

There are two interfaces for this library. One is the developer interface; the other is the object-oriented interface, which is a wrapper for the basis functions in the developer interface.

The developer interface contains separate functions that users can alter the inputs more flexibly. Functions are added upon users’ request on new functionalities to test hypotheses (also see the test branch). The developer interface consists of 4 types of functions:

  • The basis functions are smallest unit of functions that make up the wrapper functions and object-oriented interface.
  • The wrapper functions implement particular analysis tasks for published work/manuscripts in preparation
  • The utility functions compute general quantities, such as static stability or quasi-geostrophic potential vorticity that are not specific to the finite-amplitude wave theory.
  • The beta-version functions include utilities that are not fully documented but has been used in research.

The object-oriented interface is an easy-to-use interface that takes in the climate field and coordinates as the attributes of an object, and implement the wrapper functions above as methods.

Issues Reporting

Please make inquiries about / report issues / with the package and suggest feature extensions on the Issues page.

If you need help analyzing output from particular model/analysis with our techniques, feel free to email me csyhuang@uchicago.edu with sample datasets and I can configure the code for you.

Indices and tables