Skip to content

Update energy unit references from MeV/u to MeV/nucl across documenta…#93

Merged
nbassler merged 2 commits into
mainfrom
53-range-for-ions-other-than-protons-seems-to-be-off-by-factor-2
Apr 1, 2026
Merged

Update energy unit references from MeV/u to MeV/nucl across documenta…#93
nbassler merged 2 commits into
mainfrom
53-range-for-ions-other-than-protons-seems-to-be-off-by-factor-2

Conversation

@nbassler
Copy link
Copy Markdown
Member

@nbassler nbassler commented Apr 1, 2026

closes #53

@nbassler nbassler linked an issue Apr 1, 2026 that may be closed by this pull request
Copilot AI review requested due to automatic review settings April 1, 2026 14:27
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 1, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 75.44%. Comparing base (f1a5a4f) to head (c1ded3c).
⚠️ Report is 1 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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 in src/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.

Comment thread README.md
@nbassler nbassler merged commit ae1f23d into main Apr 1, 2026
28 of 29 checks passed
@nbassler nbassler deleted the 53-range-for-ions-other-than-protons-seems-to-be-off-by-factor-2 branch April 1, 2026 14:39
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.

Range for ions other than protons seems to be off by factor 2

2 participants