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

Fix #1004: beamdp axis labels are confusing #1170

Merged
merged 2 commits into from
Sep 4, 2024

Conversation

blakewalters
Copy link
Contributor

Addresses #1004.

Note: I find our method for specifying axis units in beamdp using a backslash in front of the unit (i.e., '/unit') confusing, especially for quantities which may also have a unit in the denominator (e.g., '/MeV cm^-2'). I wonder if we should move to just using brackets instead.

@blakewalters blakewalters requested a review from a team as a code owner August 19, 2024 21:21
@blakewalters blakewalters requested review from ftessier, mainegra and rtownson and removed request for a team August 19, 2024 21:21
@blakewalters blakewalters self-assigned this Aug 19, 2024
@blakewalters blakewalters changed the base branch from master to develop August 19, 2024 21:27
@ftessier
Copy link
Member

@blakewalters I agree with you about slash notation for units, for it becomes quite confusing, as you said, when the units themselves involve a quotient. I find that $v\ (\mathrm{m/s})$ clearer than $v / (\mathrm{m/s})$, for example.

However, the SI Brochure Section 5.4 is quite definitive in its recommendation for Rules and style conventions for expressing values of quantities:

Symbols for units are treated as mathematical entities. In expressing the value of a quantity as the product of a numerical value and a unit, both the numerical value and the unit may be treated by the ordinary rules of algebra. This procedure is described as the use of quantity calculus, or the algebra of quantities. For example, the equation p = 48 kPa may equally be written as p/kPa = 48. It is common practice to write the quotient of a quantity and a unit in this way for a column heading in a table, so that the entries in the table are simply numbers. (...) The axes of a graph may also be labelled in this way, so that the tick marks are labelled only with numbers, as in the graph below.

So you and I will probably just have to get used to it?

@ftessier
Copy link
Member

ftessier commented Aug 20, 2024

I fixed all the other occurrences of erroneous flags \S (superscript) and \N (normal) in Grace plot axes labels throughout the EGSnrc code base.

@ftessier
Copy link
Member

Commits should be squashed before merging.

@ftessier ftessier added this to the Release 2024 milestone Aug 20, 2024
@rtownson rtownson changed the title Fix beamdp axis labels Fix #1004: beamdp axis labels are confusing Sep 4, 2024
@rtownson rtownson merged commit a7ab9c3 into nrc-cnrc:develop Sep 4, 2024
rtownson added a commit that referenced this pull request Nov 20, 2024
Revert changes to units in the output of egs_fluence_scoring and cavity.
This was needed to avoid compiler errors when using newer compilers.
rtownson added a commit that referenced this pull request Jan 13, 2025
Revert changes to units in the output of egs_fluence_scoring and cavity.
This was needed to avoid compiler errors when using newer compilers.
rtownson added a commit that referenced this pull request Jan 14, 2025
Revert changes to units in the output of egs_fluence_scoring and cavity.
This was needed to avoid compiler errors when using newer compilers.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants