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

Prerequisites
-------------

You'll need a recent python 2.7+ or 3.3+ installation, and the
`Numpy <http://www.numpy.org/>`__,
`Matplotlib <http://matplotlib.org/>`__, `Scipy <http://scipy.org/>`__
and `Astropy <http://www.astropy.org/>`__ libraries. You should also
have a working `HEASoft <http://heasarc.nasa.gov/lheasoft/>`__
installation to produce the cleaned event files and to use
`XSpec <http://heasarc.nasa.gov/lheasoft/xanadu/xspec/index.html>`__.

An **optional but recommended** dependency is the `netCDF 4
library <http://www.unidata.ucar.edu/software/netcdf/>`__ with its
`python bindings <https://github.com/Unidata/netcdf4-python>`__.

Quick Installation(stable releases)
-----------------------------------
Run

::

    $ pip install maltpynt

and that's it!

Installing the Development version
----------------------------------

Download
~~~~~~~~<commit_msg>Add Numba to docs<commit_after>Installation Instructions
=========================

Prerequisites
-------------

You'll need a recent python 2.7+ or 3.3+ installation, and the
`Numpy <http://www.numpy.org/>`__,
`Matplotlib <http://matplotlib.org/>`__, `Scipy <http://scipy.org/>`__
and `Astropy <http://www.astropy.org/>`__ libraries. You should also
have a working `HEASoft <http://heasarc.nasa.gov/lheasoft/>`__
installation to produce the cleaned event files and to use
`XSpec <http://heasarc.nasa.gov/lheasoft/xanadu/xspec/index.html>`__.

An **optional but recommended** dependency is the `netCDF 4
library <http://www.unidata.ucar.edu/software/netcdf/>`__ with its
`python bindings <https://github.com/Unidata/netcdf4-python>`__.
An additional dependency that is now used only sparsely (if installed) but will
become important in future versions is `Numba <http://numba.pydata.org>`__.

Quick Installation(stable releases)
-----------------------------------
Run

::

    $ pip install maltpynt

and that's it!

Installing the Development version
----------------------------------

Download
~~~~~~~~
{'fraction_non_alphanumeric': 0.22709551656920077, 'fraction_numerical': 0.005847953216374269, 'mean_word_length': 3.2242798353909463, 'pattern_counts': {'":': 0, '<': 20, '<?xml version=': 0, '>': 20, 'https://': 2, 'lorem ipsum': 0, 'www.': 6, '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': '7509714', 'n_tokens_mistral': 666, 'n_tokens_neox': 637, 'n_words': 174}