Code for a minimal NIW-QG model
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.
niwqg MKL no longer default Jul 10, 2017
.gitignore Updates ignore Feb 27, 2017
LICENSE Updates license Feb 27, 2017
Makefile Adds requirements Apr 23, 2017 Updates readme Apr 27, 2017

Code for a special class of solutions of the Xie & Vanneste (2015) coupled model in a doubly periodic domain.

NIWQG organogram


This software is written in python3 and depends on numpy and h5py. I strongly recommend the python3 pre-packaged on Anaconda. This package comes with numpy. To install h5py, use Anaconda's package manager:

conda install h5py

For a more comprehensive installation or update with conda, run

make install

Installing niwqg

If you're a git user, fork and clone your fork of the niwqg repository. Alternatively, just download the repository by clicking on the link on the upper-right corner of this page.

Inside the root niwqg directory, install the package:

python install

If you plan to make changes to the code, then setup the development mode:

python develop

Testing niwqg

If you have pytest, then run

make test

Alternatively, to in the test directory

cd niwqg/tests

and run all unit tests using nose:


You can also run this simple example and verify the energy budget.


Some documentation is available here. Also check the docstrings of classes and methods.


The code is under rapid development by @crocha700 as part of the project "Stimulated Loss of Balance" (SLOB) with @glwagner and @wry55.

Please, submit contributions via pull-request of a cut-off branch (not master).


This project is funded by the National Aeronautics and Space Administration under grant NNX16AO5OH.