Adds documentation for implemented samplers

This adds a simple way to help users understand what options are available for different samplers.

• Adds a CLI arguments sampler-help which prints the docstring for the given sampler
• Documents each Sampler class with details of the commonly-used kwargs and information on where the kwargs are passed (except for pymc3)

This actually exposes a few inconsistencies in how different samplers are implemented. I'll create issues for this rather than try to fix them here.

Examples

Calling without any arguments

: $ python gaussian_example.py --sampler-help
09:37 tupak INFO    : Running tupak version: 0.2.2: (UNCLEAN) af1e374 2018-09-10 22:43:21 +0100
For help with a specific sampler, call sampler-help with the name of the sampler
Available samplers = ['Cpnest', 'Dynesty', 'Emcee', 'Nestle', 'Ptemcee', 'Pymc3', 'Pymultinest', 'Sampler']

Calling for nestle

$ python gaussian_example.py --sampler-help nestle
09:37 tupak INFO    : Running tupak version: 0.2.2: (UNCLEAN) af1e374 2018-09-10 22:43:21 +0100
Help for sampler "nestle":
tupak wrapper `nestle.Sampler` (http://kylebarbary.com/nestle/)

    All positional and keyword arguments (i.e., the args and kwargs) passed to
    `run_sampler` will be propogated to `nestle.sample`, see documentation for
    that function for further help. Under Keyword Arguments, we list commonly
    used kwargs and the tupak defaults

    Keyword Arguments
   ------------------
    npoints: int
        The number of live points, note this can also equivalently be given as
        one of [nlive, nlives, n_live_points]
    method: {'classic', 'single', 'multi'} ('multi')
        Method used to select new points
    verbose: Bool
        If true, print information information about the convergance during
        sampling

@matthew-pitkin I haven't added any documentation for pymc3 as I'm still a bit unsure how it all works.

added 1 commit

• 7b006e26 - Clean up sampler help

Compare with previous version

I'll take a look and add some documentation for PyMC3 if I can.

added 1 commit

• b15d6a7a - sampler.py: add help for PyMC3

Compare with previous version

added 107 commits

• b15d6a7a...d2bd4726 - 106 commits from branch master
• af703cfb - Merge remote-tracking branch 'origin/master' into add-sampler-help

Compare with previous version

added 1 commit

• 5ad0c83b - PEP8 fixes

Compare with previous version

This is all great! We should also add it into the docs, I'm ashamed to say I don't know how to do that, but can the docstrings be directly put into the docs?

resolved all discussions

added 1 commit

• 6f0bfe89 - typo fixes

Compare with previous version

resolved all discussions

mentioned in merge request !189 (merged)

@colm.talbot yes they can.

I think that the samplers docs needs more attention though than just plugging these in. I will get around to it, but lets merge this in for now.

approved this merge request

approved this merge request

mentioned in commit 69311d09

merged