A set of Python functions for processing and converting data in units of particle kinetic energy to units of particle rigidity (typically expressed in GV; gigavolts) and vice versa. This is frequently done in the field of solar system radiation physics.
To install from pypi, run
sudo pip3 install ParticleRigidityCalculationTools
Alternatively, you can install directly from the Github repository.
To do this you can first clone the repository, and then from the cloned respository, run
sudo python setup.py install
For all the functions contained in this module, kinetic energy is always expressed in MeV (megaelectronvolts), and rigidity is always expressed in terms of GV (gigavolts) unless otherwise stated.
To convert particle kinetic energy to rigidity, use the convertParticleEnergyToRigidity function.
Particle kinetic energies can be supplied as a float, int, list, NumPy array or Pandas Series. Particle mass in atomic units should also be supplied, as well as the particle charge in atomic units, as particle rigidity is dependent on these quantities.
For instance, to calculate particle rigidities for several kinetic energies at once you can first define a list of particle kinetic energies:
import ParticleRigidityCalculationTools as PRCT
particleKineticEnergyInMeV = [250.0, 578.5, 1056.8, 5123.9]
and then running
PRCT.convertParticleEnergyToRigidity(particleKineticEnergyInMeV, particleMassAU = 1.0, particleChargeAU = 1.0)
will give the corresponding rigidities for a proton with kinetic energies of 250.0 MeV, 578.5 MeV, 1056.8 MeV and 5123.9 MeV respectively:
0 0.729134
1 1.191740
2 1.760670
3 5.989121
note that the output to this function, as with all rigidity calculation functions in this module is a Pandas Series.
To perform the opposite calculation, calculating kinetic energies from a list of rigidities, you can use the convertParticleRigidityToEnergy function, which uses exactly the same input format but using input rigidities instead of energies. Using the output from the previous function:
outputtedRigiditiesSeries = PRCT.convertParticleEnergyToRigidity(particleKineticEnergyInMeV, particleMassAU = 1.0, particleChargeAU = 1.0)
we can get back the original set of proton kinetic energies with
PRCT.convertParticleRigidityToEnergy(outputtedRigiditiesSeries,particleMassAU=1.0,particleChargeAU=1.0)
which returns
0 250.0
1 578.5
2 1056.8
3 5123.9
as a Pandas Series.
When not using protons, you can either directly input the particle mass from tabulated values or use the getAtomicMass function to get tabulated average mass values for a particle with a particular atomic number. For instance, for an alpha particle/helium ion:
alphaParticleAtomicNumber = 2
PRCT.getAtomicMass(alphaParticleAtomicNumber)
returns
4.0
The particle charge for all functions in this module is identical to the particle atomic number.
A user might not necessarily want to just convert individual numbers between units of rigidity and energy, they might also want to convert a kinetic energy distribution or rigidity distribution. This might usually be expressed in the form of
Tools are available in this module to perform all of this process automatically. The function convertParticleEnergySpecToRigiditySpec can be used to convert kinetic energy distributions into rigidity distributions, for example:
energyValuesInMeV = [1000,2000,3000,4000,5000]
energyDistributionValues = [1,0.5,0.2,0.1,0.01]
PRCT.convertParticleEnergySpecToRigiditySpec(energyValuesInMeV,energyDistributionValues,particleMassAU = 1.0,particleChargeAU = 1.0)
returns
Rigidity Rigidity distribution values
0 1.696038 875.025647
1 2.784437 473.822152
2 3.824870 194.241037
3 4.848317 98.178407
4 5.863678 9.874384
as a Pandas DataFrame.
The function convertParticleRigiditySpecToEnergySpec can be used to perform the opposite operation, converting particle rigidity to kinetic energy. For example,
rigiditySpec = PRCT.convertParticleEnergySpecToRigiditySpec(energyValuesInMeV,energyDistributionValues,particleMassAU = 1,particleChargeAU = 1)
PRCT.convertParticleRigiditySpecToEnergySpec(rigiditySpec["Rigidity"],rigiditySpec["Rigidity distribution values"],particleMassAU = 1,particleChargeAU = 1)
returns
Energy Energy distribution values
0 1000.0 1.00
1 2000.0 0.50
2 3000.0 0.20
3 4000.0 0.10
4 5000.0 0.01
the original kinetic energies and distribution values that were used for the energy distribution.