Merge pull request #127 from RemiLehe/from_file_distribution

Add new class to load particles from an openPMD file

Author: ax3l

Docs/source/standard/distribution.rst

@@ -16,3 +16,5 @@ Particle distributions
 .. autoclass:: picmistandard.PICMI_AnalyticFluxDistribution
 
 .. autoclass:: picmistandard.PICMI_ParticleListDistribution
+
+.. autoclass:: picmistandard.PICMI_FromFileDistribution

PICMI_Python/particles.py

@@ -601,6 +601,16 @@ def __init__(self, x=0., y=0., z=0., ux=0., uy=0., uz=0., weight=0.,
         self.handle_init(kw)
 
 
+class PICMI_FromFileDistribution(_ClassWithInit):
+    """
+    Load particles from an openPMD file.
+
+    The openPMD file must contain the attributes `position`, `momentum`, `weighting`.
+    """
+    def __init__(self, file_path, **kw):
+        self.file_path = file_path
+        self.handle_init(kw)
+
 # ------------------
 # Numeric Objects
 # ------------------