<commit_before>ndhist
======

A multi-dimensional histogram object usable in C++ and Python.

Dependencies
------------

ndhist depends on the following libraries:

- cmake (>= 2.8.3)
- python (>= 2.7)
- python-numpy (>= 1.6)
- boost (including boost::python) (>= 1.38)
- BoostNumpy (>= 0.3)

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

An automated compilation and installation procedure is provided via cmake.
In order to create a build directory with the neccessary cmake and make files,
execute the ``configure`` script within the BoostNumpy source root directory::

    ./configure --prefix </path/to/the/installation/location>

The location of the final installation can be specified via the ``--prefix``
option. If this option is not specified, it will be installed inside the ./build
directory.

In cases where BoostNumpy is installed in special locations, one should provide
the include and library paths of the BoostNumpy installation via the configure
options ``--boostnumpy-include-path`` and ``--boostnumpy-library-path``.

After success, change to the build directory::

    cd build

Start the compilation process::

    make

Run all the tests::

    make test

After that, install ndhist by typing::

    make install

After ndhist has been installed successfully, Python has to be told where it can
find the ndhist Python module. The easiest way is to add that path to the
``PYTHONPATH`` environment variable::

    export PYTHONPATH=</path/to/the/installation/location>/lib:$PYTHONPATH

In order to make this setting permanent, one could add this line to the shell
configuration file, e.g. ``~/.bashrc``.
<commit_msg>Updated the README to reflect the current status.<commit_after>ndhist
======

A multi-dimensional histogram object usable in C++ and Python.

Dependencies
------------

ndhist depends on the following libraries:

- cmake (>= 2.8.3)
- python (>= 2.7)
- python-numpy (>= 1.6)
- boost (including boost::python) (>= 1.38)
- BoostNumpy (>= 0.3)

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

An automated compilation and installation procedure is provided via cmake.
In order to create a build directory with the neccessary cmake and make files,
execute the ``configure`` script within the BoostNumpy source root directory::

    ./configure --prefix </path/to/the/installation/location>

The location of the final installation can be specified via the ``--prefix``
option. If this option is not specified, it will be installed inside the ./build
directory.

In cases where BoostNumpy is installed in special locations, one should provide
the include and library paths of the BoostNumpy installation via the configure
options ``--boostnumpy-include-path`` and ``--boostnumpy-library-path``.

After success, change to the build directory::

    cd build

Start the compilation process::

    make

Run all the tests::

    make test

After that, install ndhist by typing::

    make install

{'fraction_non_alphanumeric': 0.10259965337954939, 'fraction_numerical': 0.008318890814558059, 'mean_word_length': 3.754530477759473, 'pattern_counts': {'":': 0, '<': 6, '<?xml version=': 0, '>': 16, 'https://': 0, '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': '5637331', 'n_tokens_mistral': 798, 'n_tokens_neox': 756, 'n_words': 360}