Skip to content

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
Paul Miles committed Aug 7, 2018
1 parent 6a1dcf1 commit dff4582
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.rst
Expand Up @@ -3,7 +3,7 @@ mcmcplot

|docs| |build| |coverage| |license| |codacy|

Plotting routines for analyzing chains from a Markov chain Monte Carlo (MCMC) simulation.
The mcmcplot package is designed to assist in the analysis of sampling chains gathered during a Markov Chain Monte Carlo (MCMC) simulation. This package was designed with the MCMC code `pymcmcstat <https://prmiles.wordpress.ncsu.edu/codes/python-packages/pymcmcstat/>`_ in mind; however, the plotting routines are amenable to other data sets. The plotting routines use `matplotlib <https://matplotlib.org/>`_ and `seaborn <https://seaborn.pydata.org/>`_. User's are recommended to investigate other plotting routines available in `seaborn <https://seaborn.pydata.org/>`_ as it is specifically designed for this sort of analysis. The routines available in `mcmcplot` serve as a useful wrapper function for several `seaborn <https://seaborn.pydata.org/>`_ plots, but it is not an exhaustive demonstration.

Installation
============
Expand Down Expand Up @@ -35,6 +35,12 @@ Contributors
See the `GitHub contributor
page <https://github.com/prmiles/mcmcplot/graphs/contributors>`_

Feedback
========

- `Feature Request <https://github.com/prmiles/mcmcplot/issues/new?template=feature_request.md>`_
- `Bug Report <https://github.com/prmiles/mcmcplot/issues/new?template=bug_report.md>`_

.. |docs| image:: https://readthedocs.org/projects/mcmcplot/badge/?version=latest
:target: https://mcmcplot.readthedocs.io/en/latest/?badge=latest

Expand All @@ -48,4 +54,4 @@ page <https://github.com/prmiles/mcmcplot/graphs/contributors>`_
:target: https://www.codacy.com/app/prmiles/mcmcplot?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=prmiles/mcmcplot&amp;utm_campaign=Badge_Grade

.. |coverage| image:: https://coveralls.io/repos/github/prmiles/mcmcplot/badge.svg?branch=master
:target: https://coveralls.io/github/prmiles/mcmcplot?branch=master
:target: https://coveralls.io/github/prmiles/mcmcplot?branch=master

0 comments on commit dff4582

Please sign in to comment.