<commit_before>.. py:currentmodule:: NonlinearTMM

Getting started
###############

Installation
************

Installation of NonlinearTMM package is possible through pip or from source
code.

Requirements:

* `Python >3.0 <https://www.python.org/>`_
* C++ compiler
* `Cython <http://cython.org/>`_ for wrapping C++ code to Python
* `Numpy <http://www.numpy.org/>`_ for general arrays
* `Eigency <https://github.com/wouterboomsma/eigency>`_ for Eigen and Numpy array conversion
* `Matplotlib <http://matplotlib.org/>`_ for plotting in examples
* `Pytest <http://doc.pytest.org/>`_ for testing

Dependencies:

* C++ code depends on `Eigen library <http://eigen.tuxfamily.org/>`_ (already included in package) 

Installation through pip is done like:

.. code-block:: bash

	pip install NonlinearTMM

Alternatively, it is possible to install the package form the source code by commands

.. code-block:: bash

	python setup.py install

or

.. code-block:: bash

	pip intall .<commit_msg>Added "tested on" information<commit_after>.. py:currentmodule:: NonlinearTMM

Getting started
###############

Installation
************

Installation of NonlinearTMM package is possible through pip or from source
code.

Requirements:

* `Python >3.0 <https://www.python.org/>`_
* C++ compiler
* `Cython <http://cython.org/>`_ for wrapping C++ code to Python
* `Numpy <http://www.numpy.org/>`_ for general arrays
* `Eigency <https://github.com/wouterboomsma/eigency>`_ for Eigen and Numpy array conversion
* `Matplotlib <http://matplotlib.org/>`_ for plotting in examples
* `Pytest <http://doc.pytest.org/>`_ for testing

Tested with Python 3.6, Windows 10 x64, Visual studio C++ 2015.

Dependencies:

* C++ code depends on `Eigen library <http://eigen.tuxfamily.org/>`_ (already included in package) 

Installation through pip is done like:

.. code-block:: bash

	pip install NonlinearTMM

Alternatively, it is possible to install the package form the source code by commands

.. code-block:: bash

	python setup.py install

or

.. code-block:: bash

	pip intall .
{'fraction_non_alphanumeric': 0.14320506575742814, 'fraction_numerical': 0.006819288845591817, 'mean_word_length': 4.348958333333333, 'pattern_counts': {'":': 0, '<': 17, '<?xml version=': 0, '>': 19, 'https://': 4, 'lorem ipsum': 0, 'www.': 4, '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': '6576629', 'n_tokens_mistral': 688, 'n_tokens_neox': 644, 'n_words': 218}