<commit_before>.. include:: references.txt

============
Installation
============

Requirements
============

root_numpy requires that both ROOT_ and NumPy_ are installed
and that ROOT is setup with the ``$ROOTSYS`` environment variable set before
installation. root_numpy's installation script depends on ROOT's
``root-config`` utility to determine the ROOT compiler/linker flags
and include paths. The installation attempts to run ``root-config`` and if
unsuccessful then ``$ROOTSYS/bin/root-config``. If ``root-config`` still cannot
be found, the installation aborts.

root_numpy has been tested with:

* ROOT 5.32, 5.34
* NumPy 1.6.1, 1.7.1
* Python 2.6, 2.7
* GNU/Linux, Mac OS

but it should work in most places.

Getting the Latest Source
=========================

Clone the repository with git::

   git clone git://github.com/rootpy/root_numpy.git

or checkout with svn::

   svn checkout https://github.com/rootpy/root_numpy/trunk root_numpy

Manual Installation
===================

If you have obtained a copy of `rootpy_numpy` yourself use the ``setup.py``
script to install.

To install in your `home directory
<http://www.python.org/dev/peps/pep-0370/>`_::

   python setup.py install --user

To install system-wide (requires root privileges)::

   sudo ROOTSYS=$ROOTSYS python setup.py install

Automatic Installation
======================<commit_msg>warning about Mac OS installation in docs<commit_after>.. include:: references.txt

============
Installation
============

Requirements
============

root_numpy requires that both ROOT_ and NumPy_ are installed
and that ROOT is setup with the ``$ROOTSYS`` environment variable set before
installation. root_numpy's installation script depends on ROOT's
``root-config`` utility to determine the ROOT compiler/linker flags
and include paths. The installation attempts to run ``root-config`` and if
unsuccessful then ``$ROOTSYS/bin/root-config``. If ``root-config`` still cannot
be found, the installation aborts.

root_numpy has been tested with:

* ROOT 5.32, 5.34
* NumPy 1.6, 1.7, 1.8
* Python 2.6, 2.7
* GNU/Linux, Mac OS

.. warning:: **Mac OS:** if you're compiling root_numpy with Clang and
   linking against libc++, you will also need to compile ROOT with Clang and
   libc++, because libstdc++ and libc++ are not ABI compatible.

   ROOT compiles with Clang and libc++ since version 5.34/11, but PyROOT has a
   bug which was fixed after that, so it is best to compile from the
   v5-34-00-patches branch of ROOT. You can do this easily with Homebrew via::

      brew install --HEAD root

Getting the Latest Source
=========================

Clone the repository with git::

   git clone git://github.com/rootpy/root_numpy.git

or checkout with svn::

   svn checkout https://github.com/rootpy/root_numpy/trunk root_numpy

Manual Installation
===================

If you have obtained a copy of `rootpy_numpy` yourself use the ``setup.py``
script to install.

To install in your `home directory
<http://www.python.org/dev/peps/pep-0370/>`_::

   python setup.py install --user

To install system-wide (requires root privileges)::

   sudo ROOTSYS=$ROOTSYS python setup.py install

Automatic Installation
======================
{'fraction_non_alphanumeric': 0.14660012476606363, 'fraction_numerical': 0.015595757953836557, 'mean_word_length': 4.444821731748727, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 2, 'lorem ipsum': 0, 'www.': 2, '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': '2798619', 'n_tokens_mistral': 995, 'n_tokens_neox': 922, 'n_words': 375}