diff --git a/MANIFEST.in b/MANIFEST.in index 9561fb1..09998fa 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1 +1,2 @@ include README.rst +recursive-include fgivenx/test/baseline_images/ *.pdf diff --git a/README.rst b/README.rst index c0f13e9..ea4f0b5 100644 --- a/README.rst +++ b/README.rst @@ -3,7 +3,7 @@ fgivenx: Functional Posterior Plotter ===================================== :fgivenx: Functional Posterior Plotter :Author: Will Handley -:Version: 2.1.10 +:Version: 2.1.11 :Homepage: https://github.com/williamjameshandley/fgivenx :Documentation: http://fgivenx.readthedocs.io/ @@ -285,9 +285,10 @@ Pull requests are very welcome. Note that if you are going to propose drastic changes, be sure to open an issue for discussion first, to make sure that your PR will be accepted before you spend effort coding it. -.. |image0| image:: https://github.com/williamjameshandley/fgivenx/blob/master/plot.png -.. |image1| image:: https://github.com/williamjameshandley/fgivenx/blob/master/planck.png +.. |image0| image:: https://raw.githubusercontent.com/williamjameshandley/fgivenx/master/plot.png +.. |image1| image:: https://raw.githubusercontent.com/williamjameshandley/fgivenx/master/planck.png Changelog ========= +:v2.1.11: Documentation upgrades :v2.1.10: Added changelog diff --git a/docs/source/conf.py b/docs/source/conf.py index 4503934..f3ca50d 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -47,14 +47,11 @@ def get_version(short=False): # ones. extensions = [ 'sphinx.ext.autodoc', - 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', - 'sphinx.ext.todo', - 'sphinx.ext.coverage', 'sphinx.ext.mathjax', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode', - 'sphinx.ext.githubpages', + 'sphinx.ext.imgconverter', 'numpydoc', ] diff --git a/docs/source/fgivenx.rst b/docs/source/fgivenx.rst index 037a08e..a8a7782 100644 --- a/docs/source/fgivenx.rst +++ b/docs/source/fgivenx.rst @@ -1,6 +1,14 @@ fgivenx package =============== +Module contents +--------------- + +.. automodule:: fgivenx + :members: + :undoc-members: + :show-inheritance: + Submodules ---------- @@ -59,12 +67,3 @@ fgivenx.samples module :members: :undoc-members: :show-inheritance: - - -Module contents ---------------- - -.. automodule:: fgivenx - :members: - :undoc-members: - :show-inheritance: diff --git a/fgivenx/__init__.py b/fgivenx/__init__.py index 8340a9f..9688677 100644 --- a/fgivenx/__init__.py +++ b/fgivenx/__init__.py @@ -1,2 +1,29 @@ +""" + +The main driving routines for this package are: + +* :func:`plot_contours ` +* :func:`plot_lines ` +* :func:`plot_dkl ` +* :func:`samples_from_getdist_chains ` + +Example import and usage: + +>>> import numpy +>>> from fgivenx import plot_contours, plot_lines, plot_dkl, samples_from_getdist_chains +>>> +>>> file_root = '/my/getdist/file/root' +>>> params = ['m', 'c'] +>>> samples = samples_from_getdist_chains(params, file_root) +>>> x = numpy.linspace(-1, 1, 100) +>>> +>>> def f(x, theta): +>>> m, c = params +>>> y = m * x + c +>>> return y +>>> +>>> plot_contours(f, x, samples) +""" + from fgivenx.drivers import plot_contours, plot_lines, plot_dkl from fgivenx.samples import samples_from_getdist_chains diff --git a/paper/paper.bib b/paper/paper.bib index 4703cef..92459ca 100644 --- a/paper/paper.bib +++ b/paper/paper.bib @@ -110,13 +110,12 @@ @ARTICLE{Higson2018 @article{zenodo, Author = {Handley, W}, - Date-Modified = {2018-07-12 11:21:25 +0000}, - doi = {10.5281/zenodo.1310715}, - Month = {Jul}, + doi = {10.5281/zenodo.1344097}, + Month = {Aug}, Publisher = {Zenodo}, - Title = {fgivenx: v2.0}, + Title = {fgivenx: v2.1.10}, Year = {2018}, - Bdsk-Url-1 = {http://dx.doi.org/10.5281/zenodo.1310715} + Bdsk-Url-1 = {http://dx.doi.org/10.5281/zenodo.1344097} } @unpublished{Higson2018b, diff --git a/paper/paper.md b/paper/paper.md index 0703420..e9d1840 100644 --- a/paper/paper.md +++ b/paper/paper.md @@ -78,8 +78,8 @@ sensing [@Higson2018b]. used in astronomy, but will be of use to scientists performing any Bayesian analysis which has predictive posteriors that are functions. The source code for ``fgivenx`` is available on -[GitHub](https://github.com/williamjameshandley/fgivenx) and has been archived to -Zenodo with the linked DOI: [@zenodo] +[GitHub](https://github.com/williamjameshandley/fgivenx) and has been archived +as ``v2.1.11`` to Zenodo with the linked DOI: [@zenodo] # Acknowledgements