Update energy unit references from MeV/u to MeV/nucl across documenta…#93
Merged
nbassler merged 2 commits intoApr 1, 2026
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #93 +/- ##
=======================================
Coverage 75.44% 75.44%
=======================================
Files 30 30
Lines 2769 2769
Branches 396 396
=======================================
Hits 2089 2089
Misses 593 593
Partials 87 87 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the project’s documented energy-unit convention from “MeV/u” to the clearer “MeV/nucl (MeV per nucleon)” across public docs, headers, and generated embedded-data headers, and adds fallback version macros in the core C source.
Changes:
- Replace “MeV/u” wording with “MeV/nucl” in documentation, public headers, examples, and generator script comments/output.
- Regenerate embedded dataset headers so their energy-unit comments match the new convention.
- Add default
DEDX_VERSION_*compile-time macro fallbacks insrc/dedx.c.
Reviewed changes
Copilot reviewed 28 out of 28 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| tools/pdf2dat.py | Updates generator documentation to refer to MeV/nucl scaling. |
| tools/dat2c.py | Updates generator documentation and emitted header text to MeV/nucl. |
| src/dedx.c | Adds fallback DEDX_VERSION_* macros for builds without compile definitions. |
| src/dedx_embedded_data.h | Updates embedded-data struct field doc to MeV/nucl. |
| src/dedx_bethe.h | Updates API parameter doc to MeV/nucl. |
| src/data/embedded/dedx_pstar.h | Regenerated header comment uses MeV/nucl. |
| src/data/embedded/dedx_mstar.h | Regenerated header comment uses MeV/nucl. |
| src/data/embedded/dedx_icru90_pos.h | Regenerated header comment uses MeV/nucl. |
| src/data/embedded/dedx_icru90_p.h | Regenerated header comment uses MeV/nucl. |
| src/data/embedded/dedx_icru90_e.h | Regenerated header comment uses MeV/nucl. |
| src/data/embedded/dedx_icru90_C.h | Regenerated header comment uses MeV/nucl. |
| src/data/embedded/dedx_icru90_a.h | Regenerated header comment uses MeV/nucl. |
| src/data/embedded/dedx_icru73new.h | Regenerated header comment uses MeV/nucl. |
| src/data/embedded/dedx_icru73.h | Regenerated header comment uses MeV/nucl. |
| src/data/embedded/dedx_icru_pstar.h | Regenerated header comment uses MeV/nucl. |
| src/data/embedded/dedx_icru_astar.h | Regenerated header comment uses MeV/nucl. |
| src/data/embedded/dedx_estar.h | Regenerated header comment uses MeV/nucl. |
| src/data/embedded/dedx_bethe.h | Regenerated header comment uses MeV/nucl. |
| src/data/embedded/dedx_astar.h | Regenerated header comment uses MeV/nucl. |
| README.md | Updates quick-start example comment to MeV/nucl. |
| index.rst | Updates Sphinx docs to MeV/nucl. |
| include/dedx.h | Updates public API docs (min/max energy + energy params) to MeV/nucl. |
| include/dedx_wrappers.h | Updates wrapper API docs to MeV/nucl. |
| include/dedx_tools.h | Updates tools API docs to MeV/nucl. |
| examples/dedx_example.c | Updates example comment to MeV/nucl. |
| examples/dedx_csda.c | Updates example comment/print label to MeV/nucl. |
| examples/dedx_bethe.c | Updates example output string to MeV/nucl. |
| examples/dedx_bench_lookup.c | Updates benchmark output label to MeV/nucl. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
closes #53