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

prmon_plot: don't use square brackets around units #236

Merged
merged 1 commit into from
Jan 8, 2024
Merged

Conversation

olifre
Copy link
Contributor

@olifre olifre commented Dec 1, 2023

Using square brackets around units hurts the heart of the physicist, as square brackets must only be used around quantities to denote their units (i.e. [F] = N). The correct notation recommended by SI, ISO and DIN standards is to divide by the unit instead.

see also https://academia.stackexchange.com/a/28918 for some more references on this matter

Using square brackets around units hurts the heart of the physicist, as square brackets must only be used around quantities to denote their units (i.e. [F] = N). 
The correct notation recommended by SI, ISO and DIN standards is to divide by the unit instead.
@amete
Copy link
Collaborator

amete commented Dec 4, 2023

Thanks for your contribution @olifre. This choice stems from the ATLAS Experiment's Style Guide, which reads:

All axes must be labelled, including units. Units should be given in square brackets,
e.g. ‘Energy [GeV]’.

under 3.3.3 General RULES and RECOMMENDATIONS for graphs and plots. Admittedly, it's an "ATLAS choice" and given the informal nature of the plots we produce here I'd be OK with anything as long as the message is clear. Let me ping @graeme-a-stewart to see if he has any preference either way.

@olifre
Copy link
Contributor Author

olifre commented Dec 4, 2023

@amete Thanks for the feedback!

My reasoning is that at our University we are asked to teach students to correctly indicate units (since there is an ISO and DIN standard which explicitly say that square brackets must not be used, and an SI recommendation to divide by the unit). I also know of cases in industry when official reports were sent back by an industry partner since the units were wrongly given in square brackets, and work had to be re-done.

As the scientific career (for many students) is only a part of their lives preparing them for a job in industry, it seems best to adhere to official standards whenever possible to best prepare them for their life out there, so they don't run into a similar kind of mess in their potential later career in industry.

Of course, giving units in a non-ISO non-SI non-DIN way is never "punished" in science — but since prmon is a tool which is of very general use, I'd love to see it be close to those standards to ease use of the produced plots outside of an experiment-specific context.

@graeme-a-stewart
Copy link
Member

graeme-a-stewart commented Jan 8, 2024

Hi both - sorry for not contributing here until now, this got a bit lost pre-Christmas holidays.

FMyI I had a quick look at some recent LHC papers and CMS follow the same standard as ATLAS. ALICE and LHCb seem to be a bit inconsistent, sometimes they use ()s, sometimes []s. APS and Nature journals very much favour ()s for the units.

That said, I'm mildly in favour of following the SI guidelines for prmon, even if they are not very much used in HEP - we're measuring s, GB, etc. here so the meaning is pretty clear.

@graeme-a-stewart graeme-a-stewart self-requested a review January 8, 2024 16:32
@amete amete merged commit 05939d1 into HSF:main Jan 8, 2024
1 check passed
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.

3 participants