<commit_before>X-Ray Timing Made Easy
=======================
+------------------+-------------------------+----------------------------+
| Master           | |Build Status Master|   | |Coverage Status Master|   |
+------------------+-------------------------+----------------------------+

We are writing a general-purpose timing package for X-ray time series.

Contents
--------

The contents will be:

- make a light curve from event data
- make periodograms in Leahy and rms normalization
- average periodograms
- cross spectra and lags (time vs energy, time vs frequency)
- maximum likelihood fitting of periodograms/parametric models
- bispectra (?)
- cross correlation functions, coherence
- spectral-timing functionality
- Bayesian QPO searches
- power colours
- rms spectra

Documentation
-------------

Is generated using `Sphinx`_. Try::

   $ sphinx-build docs docs/_build

Then open ``./docs/_build/index.html`` in the browser of your choice.

.. _Sphinx: http://sphinx-doc.org

Test suite
----------

Try::

   $ nosetests

Copyright
---------<commit_msg>Added info about installation to Readme<commit_after>X-Ray Timing Made Easy
=======================
+------------------+-------------------------+----------------------------+
| Master           | |Build Status Master|   | |Coverage Status Master|   |
+------------------+-------------------------+----------------------------+

We are writing a general-purpose timing package for X-ray time series.

Contents
--------

The contents will be:

- make a light curve from event data
- make periodograms in Leahy and rms normalization
- average periodograms
- cross spectra and lags (time vs energy, time vs frequency)
- maximum likelihood fitting of periodograms/parametric models
- bispectra (?)
- cross correlation functions, coherence
- spectral-timing functionality
- Bayesian QPO searches
- power colours
- rms spectra

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

1. Clone our project from github (remember about including --recursive flag due to our submodule(s))::

    $ git clone --recursive https://github.com/StingraySoftware/stingray.git

2. Go to directory where you cloned project into and install astropy_helpers submodule::

    $ cd astropy_helpers
    $ python setup.py install

3. Go back to stingray project directory and execute::

    $ python setup.py install


Documentation
-------------

Is generated using `Sphinx`_. Try::

   $ sphinx-build docs docs/_build

Then open ``./docs/_build/index.html`` in the browser of your choice.

.. _Sphinx: http://sphinx-doc.org

Test suite
----------

Try::

   $ nosetests

Copyright
---------
{'fraction_non_alphanumeric': 0.22967791411042945, 'fraction_numerical': 0.0011503067484662577, 'mean_word_length': 2.0586166471277845, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 1, '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': '4372171', 'n_tokens_mistral': 684, 'n_tokens_neox': 632, 'n_words': 251}