<commit_before>Installation
============

In order to use `openbandparams`, you must having a working python_
distribution installed. Python 3 support has not yet been tested,
so Python 2.7 is suggested. Here are a couple different ways to
install `openbandparams`:

1. Download the latest release `.zip` or `.tar.gz` source package from
   the `github page`_, extract its contents, and run
   `python setup.py install` from within the extracted directory
   (openbandparams is a pure-python library, so no compiling occurs
   during this installation).

2. Install from pypi_ by running "pip install openbandparams" from the
   command line.

Basic functionality has no prerequisites other than python, but several of
the examples make use of numpy_ and matplotlib_, so you may want to install
them, as well.

Once you have `openbandparams` installed, check out the :doc:`tutorial` to
get acquainted.

.. _`github page`: http://github.com/scott-maddox/openbandparams/releases/latest
.. _python: https://www.python.org/download/
.. _pypi: http://pypi.python.org/pypi
.. _numpy: http://docs.scipy.org/doc/numpy/user/install.html
.. _matplotlib: http://matplotlib.org/users/installing.html<commit_msg>small change to installation documentation<commit_after>Installation
============

In order to use `openbandparams`, you must having a working python_
distribution installed. Python 3 support has not yet been tested,
so Python 2.7 is suggested. Here are a couple different ways to
install `openbandparams`:

1. Download the latest release `.zip` or `.tar.gz` source package from
   the `github page`_, extract its contents, and run
   `python setup.py install` from within the extracted directory
   (openbandparams is a pure-python library, so no compiling occurs
   during this installation).

2. Install from pypi_ by running `pip install openbandparams` from the
   command line.

Basic functionality has no prerequisites other than python, but several of
the examples make use of numpy_ and matplotlib_, so you may want to install
them, as well.

Once you have `openbandparams` installed, check out the :doc:`tutorial` to
get acquainted.

.. _`github page`: http://github.com/scott-maddox/openbandparams/releases/latest
.. _python: https://www.python.org/download/
.. _pypi: http://pypi.python.org/pypi
.. _numpy: http://docs.scipy.org/doc/numpy/user/install.html
.. _matplotlib: http://matplotlib.org/users/installing.html
{'fraction_non_alphanumeric': 0.09641532756489493, 'fraction_numerical': 0.004120313143798929, 'mean_word_length': 4.383592017738359, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7017039', 'n_tokens_mistral': 715, 'n_tokens_neox': 678, 'n_words': 281}