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

Include batch statistics discussion in methodology introduction #3076

Merged
merged 3 commits into from
Jul 16, 2024

Conversation

johvincau
Copy link
Contributor

Description

In #2562, it was pointed out that in the Theory and Methodology section of the docs, there were relatively few lines explaining that OpenMC uses batch statistics as the default (and only) mode of presenting variance. This could be problematic considering that it's possible for different codes that a user may be familiar with to use other methods (significantly MCNP, which uses "fast_history" as default for its tallies).

This PR adds a short snippet to the methodology introduction page stating the use of batch statistics. It also embeds some links to other statistics-relevant parts of the documentation, namely Statistics and Run Strategy.

Checklist

  • I have performed a self-review of my own code
  • I have run clang-format (version 15) on any C++ source files (if applicable)
  • I have followed the style guidelines for Python source files (if applicable)
  • I have made corresponding changes to the documentation (if applicable)
  • I have added tests that prove my fix is effective or that my feature works (if applicable)

Copy link
Contributor

@paulromano paulromano left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @johvincau!

@paulromano paulromano enabled auto-merge (squash) July 16, 2024 20:40
@paulromano paulromano merged commit 58f9092 into openmc-dev:develop Jul 16, 2024
15 checks passed
church89 pushed a commit to openmsr/openmc that referenced this pull request Jul 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants