Skip to content

Commit 0a4e56d

Browse files
forgot the docstring
1 parent 861b4b5 commit 0a4e56d

1 file changed

Lines changed: 18 additions & 2 deletions

File tree

xpsi/Sample.py

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -411,8 +411,24 @@ def run_nautilus(
411411
MPI=True,
412412
out_filename="weighted_post_nautilus_xpsi"
413413
):
414-
"""
415-
Coucou
414+
""" Wrapper for the nautilus-sampler (https://nautilus-sampler.readthedocs.io/en/latest/)
415+
416+
:param likelihood: An instance of :class:`~.Likelihood.Likelihood`.
417+
418+
:param prior: An instance of :class:`~.Prior.Prior`.
419+
420+
:param sampler_params: A dictionary of the keyword arguments passed to the
421+
instance of :class:`~.NautilusSampler` to initialise the sampler.
422+
423+
:param runtime_params: A dictionary of the keyword arguments passed to the
424+
instance of :class:`~.NautilusSampler` to run the sampler.
425+
426+
:param bool MPI:
427+
Whether to use MPI or not for parallelized sampling.
428+
429+
:param out_filename: String specifying the name of the output file.
430+
431+
:returns: An instance of :class:`~.NautilusSampler`
416432
"""
417433

418434
# initialise the sampler

0 commit comments

Comments
 (0)