Addition of the ALARM-CF-LAB experimental benchmark#545
Open
mcampos16 wants to merge 11 commits into
Open
Conversation
Contributor
|
Warning Review limit reached
Next review available in: 52 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughAdds the ALARM-CF-LAB benchmark across documentation, MCNP/OpenMC raw-processing configurations, Atlas and Excel outputs, simulation fixtures, and processor tests. Benchmark continuation traversal is also made deterministic by sorting subdirectories. ChangesALARM-CF-LAB benchmark
Estimated code review effort: 4 (Complex) | ~45 minutes Sequence Diagram(s)sequenceDiagram
participant RawProcessor
participant MCNP_OpenMC_Transformations
participant AtlasProcessor
participant ExcelProcessor
RawProcessor->>MCNP_OpenMC_Transformations: process ALARM-CF-LAB tally data
MCNP_OpenMC_Transformations->>AtlasProcessor: provide flux, spectra, and C/E results
MCNP_OpenMC_Transformations->>ExcelProcessor: provide count-rate tables
Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
tests/post/test_raw_processor.py (1)
545-574: 🗄️ Data Integrity & Integration | 🔵 Trivial | 🏗️ Heavy liftAssert generated results instead of only checking for exceptions.
RawProcessorskips missing tallies with a warning, so these tests can pass while expected CSVs are absent. Assert the 3B output filenames, row counts, and representative values; add fixtures or parameterized coverage for the other eightapply_tocases.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@tests/post/test_raw_processor.py` around lines 545 - 574, Strengthen test_ALARM_CF_LAB_mcnp and test_ALARM_CF_LAB_openmc to assert the generated 3B CSV filenames, row counts, and representative values after process_raw_data completes, rather than only relying on exceptions. Add fixtures or parameterized coverage for the remaining eight apply_to cases, ensuring missing tally outputs cannot pass silently.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/source/benchmarks/benchdesc/alarm-cf-lab.rst`:
- Line 92: Update the equation defining N_{k,i}^{m} to use the summed energy-bin
index g in the response-function term, replacing the undefined g' while
preserving the existing summation and notation.
In `@src/jade/resources/default_cfg/benchmarks_pp/excel/ALARM-CF-LAB.yaml`:
- Around line 49-60: Remove the two leading spaces before the top-level key 8"
Count Rates(%): in the YAML configuration, keeping its results and related
settings nested beneath it. Ensure it is defined as a sibling of the preceding
5" (no Cd) Count Rates(%) block so the configurations remain distinct.
---
Nitpick comments:
In `@tests/post/test_raw_processor.py`:
- Around line 545-574: Strengthen test_ALARM_CF_LAB_mcnp and
test_ALARM_CF_LAB_openmc to assert the generated 3B CSV filenames, row counts,
and representative values after process_raw_data completes, rather than only
relying on exceptions. Add fixtures or parameterized coverage for the remaining
eight apply_to cases, ensuring missing tally outputs cannot pass silently.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: d6ab30f0-4872-438a-a048-a1117035195b
⛔ Files ignored due to path filters (49)
docs/source/benchmarks/exp_overview.csvis excluded by!**/*.csvdocs/source/img/benchmarks/alarm-cf-lab.pngis excluded by!**/*.pngtests/dummy_structure/raw_data/_exp_-_exp_/ALARM-CF-LAB/ALARM-CF-LAB_3B Count rates 10 inches.csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_exp_-_exp_/ALARM-CF-LAB/ALARM-CF-LAB_3B Count rates 12 inches.csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_exp_-_exp_/ALARM-CF-LAB/ALARM-CF-LAB_3B Count rates 2 inches.csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_exp_-_exp_/ALARM-CF-LAB/ALARM-CF-LAB_3B Count rates 3 inches.csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_exp_-_exp_/ALARM-CF-LAB/ALARM-CF-LAB_3B Count rates 5 inches (without Cd).csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_exp_-_exp_/ALARM-CF-LAB/ALARM-CF-LAB_3B Count rates 5 inches.csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_exp_-_exp_/ALARM-CF-LAB/ALARM-CF-LAB_3B Count rates 8 inches.csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_mcnp_-_FENDL 3.2c_/ALARM-CF-LAB/ALARM-CF-LAB_3B 1 MeV Si equivalent fluence.csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_mcnp_-_FENDL 3.2c_/ALARM-CF-LAB/ALARM-CF-LAB_3B Count rates 10 inches.csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_mcnp_-_FENDL 3.2c_/ALARM-CF-LAB/ALARM-CF-LAB_3B Count rates 12 inches.csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_mcnp_-_FENDL 3.2c_/ALARM-CF-LAB/ALARM-CF-LAB_3B Count rates 2 inches.csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_mcnp_-_FENDL 3.2c_/ALARM-CF-LAB/ALARM-CF-LAB_3B Count rates 3 inches.csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_mcnp_-_FENDL 3.2c_/ALARM-CF-LAB/ALARM-CF-LAB_3B Count rates 5 inches (without Cd).csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_mcnp_-_FENDL 3.2c_/ALARM-CF-LAB/ALARM-CF-LAB_3B Count rates 5 inches.csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_mcnp_-_FENDL 3.2c_/ALARM-CF-LAB/ALARM-CF-LAB_3B Count rates 8 inches.csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_mcnp_-_FENDL 3.2c_/ALARM-CF-LAB/ALARM-CF-LAB_3B Neutron spectra (pos 1).csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_mcnp_-_FENDL 3.2c_/ALARM-CF-LAB/ALARM-CF-LAB_3B Neutron spectra (pos 10).csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_mcnp_-_FENDL 3.2c_/ALARM-CF-LAB/ALARM-CF-LAB_3B Neutron spectra (pos 2).csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_mcnp_-_FENDL 3.2c_/ALARM-CF-LAB/ALARM-CF-LAB_3B Neutron spectra (pos 3).csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_mcnp_-_FENDL 3.2c_/ALARM-CF-LAB/ALARM-CF-LAB_3B Neutron spectra (pos 4).csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_mcnp_-_FENDL 3.2c_/ALARM-CF-LAB/ALARM-CF-LAB_3B Neutron spectra (pos 5).csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_mcnp_-_FENDL 3.2c_/ALARM-CF-LAB/ALARM-CF-LAB_3B Neutron spectra (pos 6).csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_mcnp_-_FENDL 3.2c_/ALARM-CF-LAB/ALARM-CF-LAB_3B Neutron spectra (pos 7).csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_mcnp_-_FENDL 3.2c_/ALARM-CF-LAB/ALARM-CF-LAB_3B Neutron spectra (pos 8).csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_mcnp_-_FENDL 3.2c_/ALARM-CF-LAB/ALARM-CF-LAB_3B Neutron spectra (pos 9).csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_mcnp_-_FENDL 3.2c_/ALARM-CF-LAB/ALARM-CF-LAB_3B Total neutron flux.csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_openmc_-_FENDL 3.2b_/ALARM-CF-LAB/ALARM-CF-LAB_3B 1 MeV Si equivalent fluence.csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_openmc_-_FENDL 3.2b_/ALARM-CF-LAB/ALARM-CF-LAB_3B Count rates 10 inches.csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_openmc_-_FENDL 3.2b_/ALARM-CF-LAB/ALARM-CF-LAB_3B Count rates 12 inches.csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_openmc_-_FENDL 3.2b_/ALARM-CF-LAB/ALARM-CF-LAB_3B Count rates 2 inches.csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_openmc_-_FENDL 3.2b_/ALARM-CF-LAB/ALARM-CF-LAB_3B Count rates 3 inches.csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_openmc_-_FENDL 3.2b_/ALARM-CF-LAB/ALARM-CF-LAB_3B Count rates 5 inches (without Cd).csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_openmc_-_FENDL 3.2b_/ALARM-CF-LAB/ALARM-CF-LAB_3B Count rates 5 inches.csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_openmc_-_FENDL 3.2b_/ALARM-CF-LAB/ALARM-CF-LAB_3B Count rates 8 inches.csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_openmc_-_FENDL 3.2b_/ALARM-CF-LAB/ALARM-CF-LAB_3B Neutron spectra (pos 1).csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_openmc_-_FENDL 3.2b_/ALARM-CF-LAB/ALARM-CF-LAB_3B Neutron spectra (pos 10).csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_openmc_-_FENDL 3.2b_/ALARM-CF-LAB/ALARM-CF-LAB_3B Neutron spectra (pos 2).csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_openmc_-_FENDL 3.2b_/ALARM-CF-LAB/ALARM-CF-LAB_3B Neutron spectra (pos 3).csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_openmc_-_FENDL 3.2b_/ALARM-CF-LAB/ALARM-CF-LAB_3B Neutron spectra (pos 4).csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_openmc_-_FENDL 3.2b_/ALARM-CF-LAB/ALARM-CF-LAB_3B Neutron spectra (pos 5).csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_openmc_-_FENDL 3.2b_/ALARM-CF-LAB/ALARM-CF-LAB_3B Neutron spectra (pos 6).csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_openmc_-_FENDL 3.2b_/ALARM-CF-LAB/ALARM-CF-LAB_3B Neutron spectra (pos 7).csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_openmc_-_FENDL 3.2b_/ALARM-CF-LAB/ALARM-CF-LAB_3B Neutron spectra (pos 8).csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_openmc_-_FENDL 3.2b_/ALARM-CF-LAB/ALARM-CF-LAB_3B Neutron spectra (pos 9).csvis excluded by!**/*.csvtests/dummy_structure/raw_data/_openmc_-_FENDL 3.2b_/ALARM-CF-LAB/ALARM-CF-LAB_3B Total neutron flux.csvis excluded by!**/*.csvtests/dummy_structure/simulations/_mcnp_-_FENDL 3.2c_/ALARM-CF-LAB/ALARM-CF-LAB_3B/case_3B_00c.ois excluded by!**/*.otests/dummy_structure/simulations/_openmc_-_FENDL 3.2b_/ALARM-CF-LAB/ALARM-CF-LAB_3B/tallies.outis excluded by!**/*.out
📒 Files selected for processing (18)
docs/source/benchmarks/benchdesc/alarm-cf-lab.rstdocs/source/benchmarks/benchdesc/icbep_disclaimer.rstdocs/source/benchmarks/experimental.rstsrc/jade/resources/default_cfg/benchmarks_pp/atlas/ALARM-CF-LAB.yamlsrc/jade/resources/default_cfg/benchmarks_pp/excel/ALARM-CF-LAB.yamlsrc/jade/resources/default_cfg/benchmarks_pp/raw/mcnp/ALARM-CF-LAB.yamlsrc/jade/resources/default_cfg/benchmarks_pp/raw/openmc/ALARM-CF-LAB.yamlsrc/jade/run/benchmark.pytests/dummy_structure/raw_data/_mcnp_-_FENDL 3.2c_/ALARM-CF-LAB/metadata.jsontests/dummy_structure/raw_data/_openmc_-_FENDL 3.2b_/ALARM-CF-LAB/metadata.jsontests/dummy_structure/simulations/_mcnp_-_FENDL 3.2c_/ALARM-CF-LAB/ALARM-CF-LAB_3B/case_3B_00c.mtests/dummy_structure/simulations/_mcnp_-_FENDL 3.2c_/ALARM-CF-LAB/ALARM-CF-LAB_3B/metadata.jsontests/dummy_structure/simulations/_openmc_-_FENDL 3.2b_/ALARM-CF-LAB/ALARM-CF-LAB_3B/metadata.jsontests/dummy_structure/simulations/_openmc_-_FENDL 3.2b_/ALARM-CF-LAB/ALARM-CF-LAB_3B/statepoint.100.h5tests/dummy_structure/simulations/_openmc_-_FENDL 3.2b_/ALARM-CF-LAB/ALARM-CF-LAB_3B/volumes.jsontests/post/test_atlas_processor.pytests/post/test_excel_processor.pytests/post/test_raw_processor.py
| to obtain the corresponding count rates: | ||
|
|
||
| .. math:: | ||
| N_{k,i}^{m} = S \cdot \sum_{g=1}^{30} \Phi_{k,g}^{i} r_{i,g'} |
Contributor
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Use the summed energy-bin index in the response function.
g' is undefined; the response function should use g, matching the summation and description.
Proposed fix
- N_{k,i}^{m} = S \cdot \sum_{g=1}^{30} \Phi_{k,g}^{i} r_{i,g'}
+ N_{k,i}^{m} = S \cdot \sum_{g=1}^{30} \Phi_{k,g}^{i} r_{i,g}📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| N_{k,i}^{m} = S \cdot \sum_{g=1}^{30} \Phi_{k,g}^{i} r_{i,g'} | |
| N_{k,i}^{m} = S \cdot \sum_{g=1}^{30} \Phi_{k,g}^{i} r_{i,g} |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/source/benchmarks/benchdesc/alarm-cf-lab.rst` at line 92, Update the
equation defining N_{k,i}^{m} to use the summed energy-bin index g in the
response-function term, replacing the undefined g' while preserving the existing
summation and notation.
Codecov Report✅ All modified and coverable lines are covered by tests.
🚀 New features to boost your workflow:
|
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This pull request includes the addition the ALARM-CF-LAB experimental benchmark, which consists of 9 subcases/subruns: 1A, 1B, 2A, 2B, 3A, 3B, 4A, 4B, and 5A.
Specifically:
Additionally, 2 minor modifications were introduced:
Solves issue #341
No additional dependencies introduced.
Example screenshots of the post-processing proposed in this pull request:
Type of change
Please select what type of change this is.
Other changes
Testing
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Checklist:
Summary by CodeRabbit
Summary by CodeRabbit
New Features
Bug Fixes
Tests