Commit 1980ba15 authored by Michael Williams's avatar Michael Williams

Add reference to git repo and documentation

parent e07e738c
Pipeline #192284 failed with stage
in 19 minutes and 31 seconds
......@@ -6,8 +6,14 @@ from ..utils import logger, check_directory_exists_and_if_not_mkdir, load_json
class Nessai(NestedSampler):
"""bilby wrapper of nessai
"""bilby wrapper of nessai (https://github.com/mj-will/nessai)
All positional and keyword arguments passed to `run_sampler` are propogated
to `nessai.flowsampler.FlowSampler`
See the documentation for an explanation of the different kwargs.
Documentation: https://nessai.readthedocs.io/
"""
default_kwargs = dict(
output=None,
......@@ -87,7 +93,7 @@ class Nessai(NestedSampler):
----------
names : list of str
List of parameters to sample
priors :
priors : :obj:`bilby.core.prior.PriorDict`
Priors to use for sampling. Needed for the bounds and the
`sample` method.
"""
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment