<commit_before># wqio - Water Quality, Inflow/Outflow
[![Build Status](https://travis-ci.org/Geosyntec/wqio.svg?branch=master)](https://travis-ci.org/Geosyntec/wqio)
[![Coverage Status](https://coveralls.io/repos/Geosyntec/wqio/badge.svg?branch=master)](https://coveralls.io/r/Geosyntec/wqio?branch=master)
[![Binstar Badge](https://binstar.org/phobson/wqio/badges/version.svg)](https://binstar.org/phobson/wqio)
[![Binstar Badge](https://binstar.org/phobson/wqio/badges/license.svg)](https://binstar.org/phobson/wqio)<commit_msg>add blurb about installation and testing to readme [ci skip]<commit_after># wqio - Water Quality, Inflow/Outflow
[![Build Status](https://travis-ci.org/Geosyntec/wqio.svg?branch=master)](https://travis-ci.org/Geosyntec/wqio)
[![Coverage Status](https://coveralls.io/repos/Geosyntec/wqio/badge.svg?branch=master)](https://coveralls.io/r/Geosyntec/wqio?branch=master)
[![Binstar Badge](https://binstar.org/phobson/wqio/badges/version.svg)](https://binstar.org/phobson/wqio)
[![Binstar Badge](https://binstar.org/phobson/wqio/badges/license.svg)](https://binstar.org/phobson/wqio)


## Installation

### Stable
Through conda:

    $ conda install wqio --channel=phobson

Through pip (usually out of date)

    $ pip install wqio

### Development

From source:

    $ git clone <EMAIL>:Geosyntec/wqio.git
    $ cd wqio
    $ pip install -e .

## Running tests

### Install pytest and plugins

    $ conda install pytest pytest-cov
    $ conda install pytest-mpl --channel=conda-forge

### Run the tests with the test runner:

    $ python check_wqio.py --mpl --cov

### Run the tests from within python

    $ python
    >>> import wqio
    >>> wqio.test('--mpl', '--cov')
{'fraction_non_alphanumeric': 0.17314487632508835, 'fraction_numerical': 0.0, 'mean_word_length': 4.480645161290322, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 10, 'https://': 16, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7403705', 'n_tokens_mistral': 667, 'n_tokens_neox': 648, 'n_words': 98}