-
Notifications
You must be signed in to change notification settings - Fork 29
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.
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
Changes from all commits
b3090a7
c4635da
e0c830d
d2fe642
9cb0d47
57fece3
0bb1615
6563438
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| Convention for Specifying Particle Species | ||
| ========================================== | ||
|
|
||
| openPMD extension name: `SpeciesType` | ||
|
|
||
| openPMD extension ID: `4` | ||
|
|
||
|
|
||
| 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`). | ||
|
|
||
| ### Elementary Particles | ||
|
|
||
| Namings for fundamental fermions and their anti-matter particles. | ||
|
|
||
| Quarks: | ||
| - `up` (`anti-up`) | ||
| - `down` (`anti-down`) | ||
| - `charm` (`anti-charm`) | ||
| - `strange` (`anti-strange`) | ||
| - `top` (`anti-top`) | ||
| - `bottom` (`anti-bottom`) | ||
|
|
||
| Leptons: | ||
| - `electron` (`positron`) | ||
| - `electron-neutrino` (`anti-electron-neutrino`) | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. anti-neutrinos: who knows, maybe they turn out to be the same particles. but until now it seems that calling them anti-neutrinos is common |
||
| - `muon` (`anti-muon`) | ||
| - `muon-neutrino` (`anti-muon-neutrino`) | ||
| - `tau` (`anti-tau`) | ||
| - `tau-neutrino` (`anti-tau-neutrino`) | ||
|
|
||
| Gauge & Higgs Bosons: | ||
| - `photon` | ||
| - `gluon` | ||
| - `w-boson` | ||
| - `z-boson` | ||
| - `higgs` | ||
|
|
||
| ### Hadrons and Jets | ||
|
|
||
| We currently do not define spellings of hadrons besides the commonly used ones | ||
| below and suggest for this version to use `other:` with namings from the | ||
| [particle data group (PDG)](http://pdg.lbl.gov/). Other means of grouping e.g. | ||
| jets can be used, e.g. additional attributes outside of the definition of this | ||
| extension. | ||
|
|
||
| ### 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. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. By
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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.
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. OK, sounds good.
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I concur with Alex.
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. | ||
|
|
||
| ### Molecules | ||
|
|
||
| Use standard chemical notation, e.g.: `H20`. | ||
|
|
||
| The isotope prefix can be used with molecules as well. | ||
| Examples for heavy water: `#2H2O` for two deuterium and `#2HHO` for one | ||
| deuterium. | ||
There was a problem hiding this comment.
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.0but we have to assign it since we are still in1.X