np2mcpl is a low-key tool to help write mcpl-files directly from numpy-arrays.
- Make sure you have installed the MCPL-library (and NumPy)
- Build the python/c module:
python setup.py build - Add the build directory to PYTHONPATH or run:
python setup.py install - In your python script:
import np2mcpl - Create a numpy array and save it. E.g. :
np2mcpl.save("output",M)
- np2mcpl takes as input a 2D NumPy array with 10, 11, 13, or 14 columns, where the columns are assumed to be:
PDG-code x y z ux uy uz t e_kin weight [ px py pz ] [userflag]
where the PDG-code denotes which kind of particle it is, e.g. 2112 for neutrons, 22 for photon, ... as documented here: Particle Numbering Scheme. The contents of the mcpl-file is deduced from the number of columns as:
| ncols | output |
|---|---|
| 10 | no polarization, no userflag |
| 11 | no polarization, with userflag |
| 13 | with polarization, no userflag |
| 14 | with polarization, with userflag |
- The vector ux,uy,uz must have unit length.
- The optional vector px,py,pz is the polarisation vector associated with the Monte Carlo-particle.
- The optional userflag parameter is rounded to a 32-bit integer and stored for each particle. It has no predefined meaning and may be used for whatever.
- Units follow the MCPL-standard. I.e. x,y,z in cm, e_kin in MeV, t in ms. ux,uy,uz and px,py,pz are of course unitless.
- The input array is expected to be made of floating point numbers (including the PDG-code) in either double or single precision. If the numpy array is in single precision, this will be reflected in the mcpl-file.