-
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 4 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,90 @@ | ||
| 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`). | ||
|
|
||
| ### SubAtomic Particles | ||
|
|
||
| - `subatomic:antimuon` | ||
|
||
| - `subatomic:antiproton` | ||
| - `subatomic:bottom` | ||
| - `subatomic:charm-antiquark` | ||
| - `subatomic:charm-quark` | ||
| - `subatomic:deuteron` | ||
| - `subatomic:down-antiquark` | ||
| - `subatomic:down-quark` | ||
| - `subatomic:electron` | ||
| - `subatomic:electron-neutrino` | ||
| - `subatomic:gluon` | ||
| - `subatomic:graviton` | ||
| - `subatomic:higgs-boson` | ||
| - `subatomic:muon` | ||
| - `subatomic:muon-neutrino` | ||
| - `subatomic:neutron` | ||
| - `subatomic:photon` | ||
| - `subatomic:pion` | ||
| - `subatomic:positron` | ||
| - `subatomic:proton` | ||
| - `subatomic:strange-antiquark` | ||
| - `subatomic:strange-quark` | ||
| - `subatomic:tao-antiquark` | ||
| - `subatomic:tao-quark` | ||
| - `subatomic:tao-neutrino` | ||
| - `subatomic:top-antiquark` | ||
| - `subatomic:top-quark` | ||
| - `subatomic:up-antiquark` | ||
| - `subatomic:up-quark` | ||
| - `subatomic:w-boson` | ||
| - `subatomic: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). | ||
| They are prefixed with `element:`, e.g. `element:Si`. | ||
|
|
||
| Closer specifications of isotopes are denoted by a `isotope:` prefix followed | ||
| by the isotopic number followed by the chemical symbol, e.g.: `isotope:3He` | ||
| for Helium-3. | ||
|
|
||
| Charge states shall not be specified here but rather in `attributes` | ||
| (`mesh record`) or `records` or a `particle species`. | ||
|
|
||
|
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. Should we mention that the most abundant isotope can just be short-handed as Is
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 would say that the standard should assume that "He" is equivalent to "#4He".
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. Deuterium would be "#2H"
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. excellent, so we keep the abbreviations to a minimum: regular elements in the IUPAC periodic table |
||
| ### Molecules | ||
|
|
||
| Use standard chemical notation with a `molecule:` prefix, e.g.: `molecule:H20`. | ||
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