Adds documentation for implemented samplers
All threads resolved!
All threads resolved!
Compare changes
This adds a simple way to help users understand what options are available for different samplers.
sampler-help which prints the docstring for the
given samplerThis actually exposes a few inconsistencies in how different samplers are implemented. I'll create issues for this rather than try to fix them here.
: $ 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']$ 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