From 3ac0de206b47450c2924ca9c357b9628c3b54981 Mon Sep 17 00:00:00 2001 From: markus Date: Tue, 9 Feb 2021 13:54:43 +0100 Subject: [PATCH] document present_model --- cara/montecarlo.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/cara/montecarlo.py b/cara/montecarlo.py index 6c813624..84caa616 100644 --- a/cara/montecarlo.py +++ b/cara/montecarlo.py @@ -401,6 +401,12 @@ def print_qr_info(log_qr: np.ndarray) -> None: def present_model(model: MCConcentrationModel, bins: int = 200) -> None: + """ + Displays a number of plots and prints a handful of key parameters and results of a given MCConcentrationModel + :param model: The MCConcentrationModel representing the scenario to be presented + :param bins: The number of bins (bars) to use for the histograms + :return: Nothing, graphs are displayed and parameters are printed + """ fig, axs = plt.subplots(2, 2, sharex=False, sharey=False) fig.set_figheight(8) fig.set_figwidth(10)