Skip to content

Added ParticleSpeciesNames.md #177

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.

Sign up for GitHub

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

Closed
DavidSagan wants to merge 8 commits into from
Closed

Added ParticleSpeciesNames.md #177

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
b3090a7
Added ParticleSpeciesNames.md
DavidSagan Jan 30, 2018
c4635da
Update Draft of SpeciesType Extension
DavidSagan Feb 1, 2018
e0c830d
EXT SpeciesType: Reference in Std
ax3l Feb 1, 2018
d2fe642
EXT SpeciesType: Update
ax3l Feb 1, 2018
9cb0d47
Remove Prefixes
ax3l Feb 1, 2018
57fece3
Fix Typos
ax3l Feb 1, 2018
0bb1615
Clarification Charge State
DavidSagan Feb 1, 2018
6563438
Elementary Particles & Gauge+Higgs Bosons
ax3l Feb 6, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
94 changes: 94 additions & 0 deletions EXT_SpeciesType.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
Convention for Specifying Particle Species
==========================================

openPMD extension name: `SpeciesType`

openPMD extension ID: `4`
Copy link
Copy Markdown
Member

@ax3l ax3l Feb 1, 2018

Choose a reason for hiding this comment

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

note: this will be removed in 2.0.0 but we have to assign it since we are still in 1.X



Introduction
------------

This convention is for standardizing the names of particle species, e.g. in
particle physics.


Additional Record Attribute
---------------------------

The following additional attribute for openPMD `records` is defined in this
extension:

- `SpeciesType`
- type: *(string)*
- scope: *optional*
- description: particle species in this record. If there are multiple
species to be specified, they can be specified using a
semicolon separated list.
- allowed values:
- *see the lists below* and additionally
- `other` if none of the ones below applies, user are free to append a
free text after a colon, e.g. `other:neutralino` or `other:cherry`
- examples:
- `electron` (e.g. on an electron `particle record` or an electron
density `mesh record`)
- `electron;proton;#12C` (e.g. on a `mesh record` for a plasma's
local charge density)
- `other:apple;other:orange` (for a `record` mixing apples & oranges)

This attribute can be used with any `record` (including `mesh records`).

### SubAtomic Particles

- `antimuon`
Copy link
Copy Markdown
Member

@RemiLehe RemiLehe Feb 5, 2018

Choose a reason for hiding this comment

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

Should we add antitau? (See remark below on the tau lepton.)

Copy link
Copy Markdown
Collaborator Author

@DavidSagan DavidSagan Feb 6, 2018

Choose a reason for hiding this comment

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

Yes we should add antitau. And tao is a typo. Should be tau everywhere.

- `antiproton`
Copy link
Copy Markdown
Member

@RemiLehe RemiLehe Feb 5, 2018

Choose a reason for hiding this comment

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

Should we add antineutron?

Copy link
Copy Markdown
Collaborator Author

@DavidSagan DavidSagan Feb 6, 2018

Choose a reason for hiding this comment

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

Yes.

- `bottom`
Copy link
Copy Markdown
Member

@RemiLehe RemiLehe Feb 5, 2018

Choose a reason for hiding this comment

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

Shouldn't this be bottom-quark and bottom-antiquark for consistency?

Copy link
Copy Markdown
Collaborator Author

@DavidSagan DavidSagan Feb 6, 2018

Choose a reason for hiding this comment

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

Yes.

- `charm-antiquark`
- `charm-quark`
- `deuteron`
Copy link
Copy Markdown
Member

@RemiLehe RemiLehe Feb 5, 2018

Choose a reason for hiding this comment

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

It seems that deuteron could be expressed as #2H. Using the convention below. Therefore, I suggest that we remove it from this list.

Copy link
Copy Markdown
Collaborator Author

@DavidSagan DavidSagan Feb 6, 2018

Choose a reason for hiding this comment

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

Correct that deuteron is the same as #2H with a charge state of 1. In terms of having the name in the standard I don't care either way. @ax3l: Do you have an opinion?

Copy link
Copy Markdown
Member

@ax3l ax3l Feb 6, 2018

Choose a reason for hiding this comment

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

sure, Deuterium should not be here

- `down-antiquark`
- `down-quark`
- `electron`
- `electron-neutrino`
Copy link
Copy Markdown
Member

@RemiLehe RemiLehe Feb 5, 2018

Choose a reason for hiding this comment

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

Should we add electron-antineutrino?

Copy link
Copy Markdown
Collaborator Author

@DavidSagan DavidSagan Feb 6, 2018

Choose a reason for hiding this comment

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

Sure.

- `gluon`
- `graviton`
- `higgs-boson`
- `muon`
- `muon-neutrino`
Copy link
Copy Markdown
Member

@RemiLehe RemiLehe Feb 5, 2018

Choose a reason for hiding this comment

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

Should we add muon_antineutrino?

Copy link
Copy Markdown
Collaborator Author

@DavidSagan DavidSagan Feb 6, 2018

Choose a reason for hiding this comment

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

Yes.

Copy link
Copy Markdown
Member

@ax3l ax3l Feb 6, 2018

Choose a reason for hiding this comment

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

And I thought you wanted to point to Majorana neutrinos here ;)

- `neutron`
- `photon`
- `pion`
Copy link
Copy Markdown
Member

@RemiLehe RemiLehe Feb 5, 2018

Choose a reason for hiding this comment

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

Is there a reason to standardize the name of the pion, but not of all the other mesons?
(If the reason is that the pion is the most common, I am fine with this ; I am definitely not a specialist... I was just wondering.)

Copy link
Copy Markdown
Collaborator Author

@DavidSagan DavidSagan Feb 6, 2018

Choose a reason for hiding this comment

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

The list I came up with was meant to get the discussion going rather then being complete (I am definitely not a specialist either). Do you have a list of names for the other mesons? By all means let us put them in.

- `positron`
- `proton`
- `strange-antiquark`
- `strange-quark`
- `tao-antiquark`
- `tao-quark`
Copy link
Copy Markdown
Member

@RemiLehe RemiLehe Feb 5, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

Also, I am not sure whether a tao-quark and tao-antiquark exist in the standard model... (If I remember well, the quarks of the standard model are up, down, strange, charm, bottom, top.)

Copy link
Copy Markdown
Collaborator Author

@DavidSagan DavidSagan Feb 6, 2018

Choose a reason for hiding this comment

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

Correct. That is a typo and should be removed.

- `tao-neutrino`
Copy link
Copy Markdown
Member

@RemiLehe RemiLehe Feb 5, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

Shouldn't this be tau-neutrino (and adding tau-antineutrino) instead of tao-neutrino ? In addition, we should probably add tau as a particle (for the counterpart of muon and electron).

Copy link
Copy Markdown
Collaborator Author

@DavidSagan DavidSagan Feb 6, 2018

Choose a reason for hiding this comment

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

Yes. The change should be made.

- `top-antiquark`
- `top-quark`
- `up-antiquark`
- `up-quark`
- `w-boson`
- `z-boson`

### Atoms & Isotopes

Element namings follow the abbreviated namings of the periodic table, defined
by *The International Union of Pure and Applied Chemistry* (IUPAC).
An example would be `Si` for silicon.

Specifications of isotopes are denoted by a pound symbol `#` followed
by the isotopic number followed by the chemical symbol, e.g.: `#3He`
for Helium-3.

The charge state is not encoded by the `SpeciesType` attribute.
Copy link
Copy Markdown
Member

@RemiLehe RemiLehe Feb 5, 2018

Choose a reason for hiding this comment

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

By charge state, do we mean ionization state? Could charge state be considered ambiguous for some users?

Copy link
Copy Markdown
Member

@ax3l ax3l Feb 5, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

Imho, charge state is the more general concept while ionization state only applies to atoms & molecules. This section just says we do not express it in this extension.

Copy link
Copy Markdown
Member

@RemiLehe RemiLehe Feb 5, 2018

Choose a reason for hiding this comment

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

OK, sounds good.

Copy link
Copy Markdown
Collaborator Author

@DavidSagan DavidSagan Feb 6, 2018

Choose a reason for hiding this comment

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

I concur with Alex.

Copy link
Copy Markdown
Member

@ax3l ax3l Feb 6, 2018

Choose a reason for hiding this comment

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

*Axel ;-)

Any extension using this standard can define how to specify the charge state.

Copy link
Copy Markdown
Member

@ax3l ax3l Feb 1, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

Should we mention that the most abundant isotope can just be short-handed as He (for #4He)? It's somehow missing, but would allow ambiguity.

Is D ok for #2H or shall it be forced to the latter?

Copy link
Copy Markdown
Collaborator Author

@DavidSagan DavidSagan Feb 1, 2018

Choose a reason for hiding this comment

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

I would say that the standard should assume that "He" is equivalent to "#4He".

Copy link
Copy Markdown
Collaborator Author

@DavidSagan DavidSagan Feb 1, 2018

Choose a reason for hiding this comment

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

Deuterium would be "#2H"

Copy link
Copy Markdown
Member

@ax3l ax3l Feb 1, 2018

Choose a reason for hiding this comment

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

excellent, so we keep the abbreviations to a minimum: regular elements in the IUPAC periodic table

### Molecules

Use standard chemical notation, e.g.: `H20`.
Copy link
Copy Markdown
Collaborator Author

@DavidSagan DavidSagan Feb 1, 2018

Choose a reason for hiding this comment

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

The isotope prefix can be used with molecules. Example "#2H2O" for two deuterium and "#2HHO" for one deuterium.

Copy link
Copy Markdown
Member

@ax3l ax3l Feb 1, 2018

Choose a reason for hiding this comment

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

idea: we prefix the allowed values with the sections, e.g. subatomic:, atom:/isotope:, molecule:, ...


The isotope prefix can be used with molecules as well.
Examples for heavy water: `#2H2O` for two deuterium and `#2HHO` for one
deuterium.
2 changes: 2 additions & 0 deletions STANDARD.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -730,6 +730,8 @@ defined:

- **ED-PIC**: electro-dynamic/static particle-in-cell codes,
see [EXT_ED-PIC.md](EXT_ED-PIC.md).
- **SpeciesType**: naming lists for particle species,
see [EXT_SpeciesType.md](EXT_SpeciesType.md).

Extensions to similar domains such as fluid, finite-element or
molecular-dynamics simulations, CCD images or other particle and/or mesh-based
Expand Down