Master

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

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

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 already created directory and install all dependencies:

   $ pip install -r requirements.txt

3. Go back to stingray project directory and execute:

   $ python setup.py install

Is generated using Sphinx. Try:

$ sphinx-build docs docs/_build

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

Stingray uses py.test for testing. To run the tests, try:

$ python setup.py test 

All content © 2015 the authors. The code is distributed under the MIT license.

Pull requests are welcome! If you are interested in the further development of this project, please get in touch via the issues!