From 64eb30e370cf5768f1d1e0b637c14bf731769ba2 Mon Sep 17 00:00:00 2001 From: markus Date: Tue, 9 Feb 2021 13:49:36 +0100 Subject: [PATCH] document buonanno_exposure_model --- cara/montecarlo.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/cara/montecarlo.py b/cara/montecarlo.py index 255e82fe..93f714df 100644 --- a/cara/montecarlo.py +++ b/cara/montecarlo.py @@ -503,7 +503,10 @@ def generate_boxplot(masked: bool = False, samples: int = 200000, qid: int = 100 plt.show() -def buaonanno_exposure_model(): +def buonanno_exposure_model() -> MCExposureModel: + """ + :return: An MCExposureModel object corresponding to one of the scenarios outlined in the paper of Buonanno et al. + """ return MCExposureModel( concentration_model=MCConcentrationModel( room=models.Room(volume=800),