Particles (plasmapy.particles)

Introduction

The particles subpackage provides access to information about atoms, ions, isotopes, and other particles. ⚛️

Submodules

• Particle objects
  • Particles
  • Custom particles
  • Particle lists
  • Dimensionless particles
• Functions
  • Symbols and names
  • Particle properties
  • Isotopes
  • Stability
  • Reduced mass
• Nuclear Reactions
  • Binding energy
  • Nuclear reaction energy
• Ionization state data structures
  • The ionization state of a single element
  • Ionization states for multiple elements
• Decorators
  • Passing Particle objects to functions and methods

Example notebooks

Using PlasmaPy Particles

Ionization states in an interplanetary coronal mass ejection

See Also

• The mendeleev Python package provides access to properties of elements, isotopes, and ions in the periodic table of elements.

API

Sub-Packages & Modules

atomic	Functions that retrieve or are related to elemental or isotopic data.
data	Data used in constructing plasmapy.particles.
decorators	Decorators for plasmapy.particles.
exceptions	Collection of exceptions and warnings for plasmapy.particles.
ionization_state	Objects for storing ionization state data for a single element or for a single ionization level.
ionization_state_collection	A class for storing ionization state data for multiple elements or isotopes.
nuclear	Functions that are related to nuclear reactions.
particle_class	Classes to represent particles.
particle_collections	Collections of particle objects.
serialization	Functionality for JSON deserialization of particle objects.
symbols	Functions that deal with string representations of atomic symbols and numbers.

Classes

AbstractParticle()	An abstract base class that defines the interface for particles.
AbstractPhysicalParticle()	Base class for particles that are defined with physical units.
CustomParticle([mass, charge, symbol, Z])	A class to represent custom particles.
DimensionlessParticle(*[, mass, charge, symbol])	A class to represent dimensionless custom particles.
IonicLevel(ion[, ionic_fraction, ...])	Representation of the ionic fraction for a single ion.
IonizationState(particle[, ionic_fractions])	Representation of the ionization state distribution of a single element or isotope.
IonizationStateCollection(inputs, ...)	Describe the ionization state distributions of multiple elements or isotopes.
Particle(argument, *_[, mass_numb, Z])	A class for an individual particle or antiparticle.
ParticleJSONDecoder(*[, object_hook])	A custom JSONDecoder class to deserialize JSON objects into the appropriate particle objects.
ParticleList([particles])	A list like collection of Particle and CustomParticle objects.

Functions

atomic_number(element)	Return the number of protons in an atom, isotope, or ion.
atomic_symbol(element)	Return the atomic symbol.
charge_number(particle)	Return the charge number of a particle.
common_isotopes([argument, most_common_only])	Return a list of isotopes of an element with an isotopic abundances greater than zero, or if no input is provided, a list of all such isotopes for every element.
electric_charge(particle)	Return the electric charge (in coulombs) of a particle.
element_name(element)	Return the name of an element.
half_life(particle[, mass_numb])	Return the half-life in seconds for unstable isotopes and particles, and inf seconds for stable isotopes and particles.
ionic_levels(particle[, min_charge, max_charge])	Return a ParticleList that includes different ionic levels of a base atom.
ionic_symbol(particle, *[, mass_numb, Z])	Return the ionic symbol of an ion or neutral atom.
is_stable(particle[, mass_numb])	Return True for stable isotopes and particles and False for unstable isotopes.
isotope_symbol(isotope[, mass_numb])	Return the symbol representing an isotope.
isotopic_abundance(isotope[, mass_numb])	Return the isotopic abundances if known, and otherwise zero.
json_load_particle(fp, *[, cls])	Deserialize a JSON document into the appropriate particle object.
json_loads_particle(s, *[, cls])	Deserialize a JSON string into the appropriate particle object.
known_isotopes([argument])	Return a list of all known isotopes of an element, or a list of all known isotopes of every element if no input is provided.
mass_number(isotope)	Get the mass number (the number of protons and neutrons) of an isotope.
molecule(symbol[, Z])	Parse a molecule symbol into a CustomParticle or Particle.
nuclear_binding_energy(particle[, mass_numb])	Return the nuclear binding energy associated with an isotope.
nuclear_reaction_energy(*args, **kwargs)	Return the released energy from a nuclear reaction.
particle_input([callable_, require, any_of, ...])	Convert particle-like arguments into particle objects.
particle_mass(particle, *[, mass_numb, Z])	Return the mass of a particle.
particle_symbol(particle, *[, mass_numb, Z])	Return the symbol of a particle.
reduced_mass(test_particle, target_particle)	Find the reduced mass between two particles.
stable_isotopes([argument, unstable])	Return a list of all stable isotopes of an element, or if no input is provided, a list of all such isotopes for every element.
standard_atomic_weight(element)	Return the standard (conventional) atomic weight of an element based on the relative abundances of isotopes in terrestrial environments.

Variables & Attributes

alpha	A Particle instance representing an alpha particle (doubly charged helium-4).
deuteron	A Particle instance representing a positively charged deuterium ion.
electron	A Particle instance representing an electron.
neutron	A Particle instance representing a neutron.
ParticleLike	Represent a union type
ParticleListLike	Represent a union type
positron	A Particle instance representing a positron.
proton	A Particle instance representing a proton.
triton	A Particle instance representing a positively charged tritium ion.