Skip to content

Latest commit

 

History

History
executable file
·
34 lines (19 loc) · 1.15 KB

README.md

File metadata and controls

executable file
·
34 lines (19 loc) · 1.15 KB

pyproffit

Pyproffit is a python package for the analysis of X-ray brightness profiles of clusters of galaxies. It is the python equivalent of the popular Proffit C++ package (Eckert et al. 2011).

The paper describing the code is now published in the Open Journal of Astrophysics and available on arXiv:

https://arxiv.org/abs/2009.03944

Installation

pyproffit is available on PyPI. The easiest way of installing pyproffit is obviously to use pip:

pip3 install pyproffit

The PyPI repository should contain the latest stable release (as judged by the developer), it may not be the latest version thus some features may be missing. To install the latest version from Github:

git clone https://github.com/domeckert/pyproffit.git
cd pyproffit
pip3 install .

pyproffit depends on numpy, scipy, astropy, matplotlib, iminuit, pymc3, and pystan.

Documentation

An extensive documentation is available on Read The Docs:

https://pyproffit.readthedocs.io

A test dataset and a validation script are also available in the validation directory. To run the validation script,

cd validation
python3 test_script.py

Enjoy!