<commit_before>Derivation of non-thermal particle distribution
===============================================

``gammafit`` uses MCMC fitting of non-thermal X-ray, GeV, and TeV spectra to
constrain the properties of their parent relativistic particle distributions. 

The workhorse of ``gammafit`` is the powerful `emcee
<http://dan.iel.fm/emcee>`_ affine-invariant ensemble sampler for Markov chain
Monte Carlo.


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

For a system-wide installation, run

::

    sudo pip install gammafit

or, for a user-only installation, run

::

    pip install --user gammafit


If you want to install from the latest development source (recommended until a
version stable is released), clone this repository

::

    git clone https://github.com/zblz/gammafit

enter directory ``gammafit``, and run

::

    python setup.py install --user


Usage
-----

The package consists of several convenience functions to which you must provide
a model function, a probability function for the parameter priors, and the
spectral data to be fit enclosed in a dictionary. An example is shown in the
file ``velax_demo.py``. Preliminary documentation can be found at
`gammafit.readthedocs.org <http://gammafit.readthedocs.org>`_.

Attribution
-----------

A publication describing the radiation models and the method for derivation of
the particle distribution is in preparation. In the meantime, if you use
``gammafit`` for your research, please link back to this webpage when mentioning
``gammafit`` in your publication.<commit_msg>change example name in readme<commit_after>Derivation of non-thermal particle distribution
===============================================

``gammafit`` uses MCMC fitting of non-thermal X-ray, GeV, and TeV spectra to
constrain the properties of their parent relativistic particle distributions. 

The workhorse of ``gammafit`` is the powerful `emcee
<http://dan.iel.fm/emcee>`_ affine-invariant ensemble sampler for Markov chain
Monte Carlo.


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

For a system-wide installation, run

::

    sudo pip install gammafit

or, for a user-only installation, run

::

    pip install --user gammafit


If you want to install from the latest development source (recommended until a
version stable is released), clone this repository

::

    git clone https://github.com/zblz/gammafit

enter directory ``gammafit``, and run

::

    python setup.py install --user


Usage
-----

The package consists of several convenience functions to which you must provide
a model function, a probability function for the parameter priors, and the
spectral data to be fit enclosed in a dictionary. An example is shown in the
file ``examples/CrabNebula_function.py``. Preliminary documentation can be found
at `gammafit.readthedocs.org <http://gammafit.readthedocs.org>`_.

Attribution
-----------

A publication describing the radiation models and the method for derivation of
the particle distribution is in preparation. In the meantime, if you use
``gammafit`` for your research, please link back to this webpage when mentioning
``gammafit`` in your publication.
{'fraction_non_alphanumeric': 0.10935483870967742, 'fraction_numerical': 0.0, 'mean_word_length': 4.203020134228188, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 2, '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': '6017014', 'n_tokens_mistral': 829, 'n_tokens_neox': 757, 'n_words': 375}