<commit_before>Two Layer QG Model
=========

This is a cleaned-up version of Malte Jansen's python two-layer quasigeostrophic model.

So far it only supports two layers and a flat bottom.<commit_msg>new readme<commit_after># pyqg - A Python Quasigeostrophic Model #

This is a pure-python implementation of the classic doubly-periodic pseudo-spectral quasigeostrophic model. So far it only supports two layers and a flat bottom.

## Installation ##

This is a legitimate python package. To use it, you should install it on your system by running
	python setup.py install
If you are helping to develop the code, you might prefer to install it in [development mode](http://stackoverflow.com/questions/19048732/python-setup-py-develop-vs-install):
	python setup.py develop

## Usage ##

We are working on filling in some [examples][examples/].
{'fraction_non_alphanumeric': 0.0761904761904762, 'fraction_numerical': 0.009523809523809525, 'mean_word_length': 4.644295302013423, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1384896', 'n_tokens_mistral': 247, 'n_tokens_neox': 223, 'n_words': 107}