particle_symbol¶
-
plasmapy.particles.
particle_symbol
(particle: plasmapy.particles.particle_class.Particle, mass_numb: numbers.Integral = None, Z: numbers.Integral = None) → str¶ Return the symbol of a particle.
- Parameters
- Returns
symbol – The particle symbol, containing charge and mass number information when available. The result will generally be returned as something like
'e-'
,'Fe'
,'He-4 2+'
,'D'
,'n'
,'mu-'
, or'p+'
.- Return type
- Raises
- Warns
`~plasmapy.particles.exceptions.ParticleWarning` – If redundant mass number or charge information is provided.
See also
Examples
>>> particle_symbol('electron') 'e-' >>> particle_symbol('proton') 'p+' >>> particle_symbol('alpha') 'He-4 2+' >>> particle_symbol('H-1', Z=-1) 'H-1 1-'