Code for a special class of solutions of the Xie & Vanneste (2015) coupled model in a doubly periodic domain.
This software is written in
python3 and depends on
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
If you're a git user, fork and clone your fork of the
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 setup.py install
If you plan to make changes to the code, then setup the development mode:
python setup.py develop
If you have
pytest, then run
Alternatively, to in the test directory
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.
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.