From 1e36d85d356fd7ef2462e14b5770bdc2c404d89c Mon Sep 17 00:00:00 2001
From: Gregory Ashton <gregory.ashton@ligo.org>
Date: Mon, 30 Apr 2018 09:40:29 +1000
Subject: [PATCH] Fix broken text and update documentation
---
peyote/sampler.py | 6 ++++++
test/tests.py | 4 ++--
2 files changed, 8 insertions(+), 2 deletions(-)
diff --git a/peyote/sampler.py b/peyote/sampler.py
index e926b8b90..be858d9a8 100644
--- a/peyote/sampler.py
+++ b/peyote/sampler.py
@@ -262,6 +262,12 @@ def run_sampler(likelihood, priors, label='label', outdir='outdir',
the loglikelhood.
**sampler_kwargs:
All kwargs are passed directly to the samplers `run` functino
+
+ Returns
+ ------
+ result, sampler
+ An object containing the results, and the sampler instance (useful
+ for creating plots etc)
"""
implemented_samplers = get_implemented_samplers()
diff --git a/test/tests.py b/test/tests.py
index fc5ec1e58..8ddf7ca3f 100644
--- a/test/tests.py
+++ b/test/tests.py
@@ -54,8 +54,8 @@ class Test(unittest.TestCase):
name='luminosity_distance', lower=dL - 10, upper=dL + 10)
}
- result = peyote.sampler.run_sampler(likelihood, priors, sampler='nestle',
- verbose=False)
+ result, sampler = peyote.sampler.run_sampler(
+ likelihood, priors, sampler='nestle', verbose=False)
self.assertAlmostEqual(np.mean(result.samples), dL,
delta=np.std(result.samples))
--
GitLab