<commit_before>libqc++
=======

[![Build
Status](https://travis-ci.org/kdmurray91/libqcpp.svg?branch=master)](https://travis-ci.org/kdmurray91/libqcpp)
[![Documentation
Status](https://readthedocs.org/projects/qcpp/badge/?version=latest)](http://qcpp.readthedocs.org/en/latest/?badge=latest)

A C++11 library for sequence quality control.

Design features:

- Modularity
- Parallelisation
- Pipelined
- Simple API

Installation
------------

Statically compiled libraries and binaries are available from the
[GitHub releases page](https://github.com/kdmurray91/libqcpp/releases).

These can be uncompressed then copied to, for instance, `/usr/local/` or `~/`.

### From Source:

On Debian-like systems:

    sudo apt-get install git libboost-dev libyaml-cpp-dev zlib1g-dev \
                         libbz2-dev cmake build-essential
    git clone https://github.com/kdmurray91/libqcpp.git
    cd libqcpp
    mkdir build && cd build
    cmake ..
    make
    make install

License
-------

Library code is licensed under the Mozilla Public Licence, version 2.0.
`trimit` and other executables bundled with `libqcpp` are licensed under the
GNU General Public License, version 3 or higher.

Catch.hpp, seqan and libssw are licensed under their respective licenses, see<commit_msg>Update license statement in README<commit_after>libqc++
=======

[![Build
Status](https://travis-ci.org/kdmurray91/libqcpp.svg?branch=master)](https://travis-ci.org/kdmurray91/libqcpp)
[![Documentation
Status](https://readthedocs.org/projects/qcpp/badge/?version=latest)](http://qcpp.readthedocs.org/en/latest/?badge=latest)

A C++11 library for sequence quality control.

Design features:

- Modularity
- Parallelisation
- Pipelined
- Simple API

Installation
------------

Statically compiled libraries and binaries are available from the
[GitHub releases page](https://github.com/kdmurray91/libqcpp/releases).

These can be uncompressed then copied to, for instance, `/usr/local/` or `~/`.

### From Source:

On Debian-like systems:

    sudo apt-get install git libboost-dev libyaml-cpp-dev zlib1g-dev \
                         libbz2-dev cmake build-essential
    git clone https://github.com/kdmurray91/libqcpp.git
    cd libqcpp
    mkdir build && cd build
    cmake ..
    make
    make install

License
-------

All libqcpp code is licensed under the Mozilla Public Licence, version 2.0.

Catch.hpp, seqan and libssw are licensed under their respective licenses, see
{'fraction_non_alphanumeric': 0.12392988177741542, 'fraction_numerical': 0.011822258459029759, 'mean_word_length': 3.595505617977528, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 10, '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': '435706', 'n_tokens_mistral': 823, 'n_tokens_neox': 765, 'n_words': 211}