<commit_before>[![Code Health](https://landscape.io/github/mulvrova/StagPy/master/landscape.svg?style=flat-square)](https://landscape.io/github/mulvrova/StagPy/master)

# StagPy

StagPy is a command line tool to read and process StagYY output files to
produce high-quality figures.

The aim is to have different cases in one file (Cartesian, Spherical Annulus,
etc).

The code to read the binary output files has been adapted from a matlab version
initially developed by Boris Kaus.

## Installation

StagPy uses the following non-standard modules: numpy, scipy, f90nml,
matplotlib, and seaborn (the latter is optional and can be turned off with the
`core.useseaborn` option). These dependencies will be checked and needed
installation performed by `setuptools` in a `virtualenv`.

The installation process is hence fairly simple:

    git clone https://github.com/mulvrova/StagPy.git
    cd StagPy
    make<commit_msg>Add install instructions to readme<commit_after>[![Code Health](https://landscape.io/github/mulvrova/StagPy/master/landscape.svg?style=flat-square)](https://landscape.io/github/mulvrova/StagPy/master)

# StagPy

StagPy is a command line tool to read and process StagYY output files to
produce high-quality figures.

The aim is to have different cases in one file (Cartesian, Spherical Annulus,
etc).

The code to read the binary output files has been adapted from a matlab version
initially developed by <NAME>.

## Installation

StagPy uses the following non-standard modules: numpy, scipy, f90nml,
matplotlib, and seaborn (the latter is optional and can be turned off with the
`core.useseaborn` option). These dependencies will be checked and needed
installation performed by `setuptools` in a `virtualenv`.

`virtualenv` is probably already installed on your computer, if this is not the
case `python2` will raise an error along the lines of `No module named
virtualenv`.  You can then install it by running `python -m pip install
virtualenv --user`. If this raise an error, see [this documentation to install
pip](http://python-packaging-user-guide.readthedocs.org/en/latest/installing/#install-pip-setuptools-and-wheel).

The installation process is hence fairly simple:

    git clone https://github.com/mulvrova/StagPy.git
    cd StagPy
    make
{'fraction_non_alphanumeric': 0.07793923381770146, 'fraction_numerical': 0.002201673271686482, 'mean_word_length': 4.737373737373737, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 4, 'https://': 6, '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': '1479423', 'n_tokens_mistral': 675, 'n_tokens_neox': 659, 'n_words': 267}