From dda3e96bd0c23f06932a9c3b872698a49e8513fd Mon Sep 17 00:00:00 2001 From: Michael Zingale Date: Sun, 15 Sep 2024 08:19:53 -0400 Subject: [PATCH] add docstrings to the diffusion problems --- pyro/diffusion/problems/gaussian.py | 7 +++++++ pyro/diffusion/problems/test.py | 2 ++ 2 files changed, 9 insertions(+) diff --git a/pyro/diffusion/problems/gaussian.py b/pyro/diffusion/problems/gaussian.py index 5ab52a10b..447d993e8 100644 --- a/pyro/diffusion/problems/gaussian.py +++ b/pyro/diffusion/problems/gaussian.py @@ -1,3 +1,10 @@ +"""Initialize the profile to a Gaussian. With a constant +conductivity, an initial Gaussian profile remains Gaussian, with the +peak lowering and width increasing with time. This allows this +problem to be used for verification. + +""" + import numpy from pyro.util import msg diff --git a/pyro/diffusion/problems/test.py b/pyro/diffusion/problems/test.py index b34c09a6d..8306c2213 100644 --- a/pyro/diffusion/problems/test.py +++ b/pyro/diffusion/problems/test.py @@ -1,3 +1,5 @@ +"""A problem setup used for unit testing.""" + DEFAULT_INPUTS = None PROBLEM_PARAMS = {}