<commit_before>.. _install:

Installation and Dependencies
=============================

Installing PySurfer is quite simple with
`easy_install <http://peak.telecommunity.com/DevCenter/EasyInstall>`_::

    easy_install -U pysurfer

or `pip <http://www.pip-installer.org/en/latest/index.html>`_::

    pip install pysurfer

To use PySurfer, you will need to have the following Python packages:

* `numpy <http://numpy.scipy.org/>`_
* `scipy <http://www.scipy.org/>`_
* `nibabel <http://nipy.sourceforge.net/nibabel/>`_
* `mayavi2 <http://http://github.enthought.com/mayavi/mayavi/index.html>`_
* `PIL <http://www.pythonware.com/products/pil/>`_ (Python Image Library)

An easy option to get all of these packages is to use the `Enthought
Python Distribution <http://www.enthought.com/products/epd.php>`_,
which is free for academic use.<commit_msg>DOC : adding ipython to the list of dependencies<commit_after>.. _install:

Installation and Dependencies
=============================

Installing PySurfer is quite simple with
`easy_install <http://peak.telecommunity.com/DevCenter/EasyInstall>`_::

    easy_install -U pysurfer

or `pip <http://www.pip-installer.org/en/latest/index.html>`_::

    pip install pysurfer

To use PySurfer, you will need to have the following Python packages:

* `numpy <http://numpy.scipy.org/>`_
* `scipy <http://www.scipy.org/>`_
* `ipython <http://ipython.scipy.org/>`_
* `nibabel <http://nipy.sourceforge.net/nibabel/>`_
* `mayavi2 <http://http://github.enthought.com/mayavi/mayavi/index.html>`_
* `PIL <http://www.pythonware.com/products/pil/>`_ (Python Image Library)

An easy option to get all of these packages is to use the `Enthought
Python Distribution <http://www.enthought.com/products/epd.php>`_,
which is free for academic use.
{'fraction_non_alphanumeric': 0.17249154453213078, 'fraction_numerical': 0.0011273957158962795, 'mean_word_length': 4.599369085173501, 'pattern_counts': {'":': 0, '<': 20, '<?xml version=': 0, '>': 20, 'https://': 0, 'lorem ipsum': 0, 'www.': 8, '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': '2919543', 'n_tokens_mistral': 640, 'n_tokens_neox': 600, 'n_words': 148}