Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add docstrings to the diffusion problems #275

Merged
merged 1 commit into from
Sep 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions pyro/diffusion/problems/gaussian.py
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions pyro/diffusion/problems/test.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
"""A problem setup used for unit testing."""

DEFAULT_INPUTS = None

PROBLEM_PARAMS = {}
Expand Down