add github annotations

ComputationalRadiationPhysics · Nov 15, 2017 · 181eaad · 181eaad
1 parent c3b354e
commit 181eaad
Show file tree

Hide file tree

Showing 8 changed files with 30 additions and 30 deletions.
diff --git a/docs/TBG_macros.cfg b/docs/TBG_macros.cfg
@@ -155,7 +155,7 @@ TBG_JField_slice="--J_slice.period 100 --J_slice.fileName sliceJ --J_slice.plane
 # Sum up total energy every .period steps for
 # - species   (--<species>_energy)
 # - fields    (--fields_energy)
-TBG_sumEnergy="--fields_energy.period 10 --<species>_energy.period 10 --<species>_energy.filter <filter name>"
+TBG_sumEnergy="--fields_energy.period 10 --<species>_energy.period 10 --<species>_energy.filter all"
 
 
 # Count the number of macro particles per species for every .period steps

diff --git a/docs/source/usage/plugins/energyFields.rst b/docs/source/usage/plugins/energyFields.rst
@@ -41,10 +41,10 @@ Python example snippet:
    simDir = "path/to/simOutput/"
 
    # Ekin in Joules (see EnergyParticles)
-   e_sum_ene = np.loadtxt(simDir + "e_energy_All.dat")[:, 0:2]
-   p_sum_ene = np.loadtxt(simDir + "p_energy_All.dat")[:, 0:2]
-   C_sum_ene = np.loadtxt(simDir + "C_energy_All.dat")[:, 0:2]
-   N_sum_ene = np.loadtxt(simDir + "N_energy_All.dat")[:, 0:2]
+   e_sum_ene = np.loadtxt(simDir + "e_energy_all.dat")[:, 0:2]
+   p_sum_ene = np.loadtxt(simDir + "p_energy_all.dat")[:, 0:2]
+   C_sum_ene = np.loadtxt(simDir + "C_energy_all.dat")[:, 0:2]
+   N_sum_ene = np.loadtxt(simDir + "N_energy_all.dat")[:, 0:2]
    # Etotal in Joules
    fields_sum_ene = np.loadtxt(simDir + "fields_energy.dat")[:, 0:2]
 

diff --git a/docs/source/usage/plugins/energyParticles.rst b/docs/source/usage/plugins/energyParticles.rst
@@ -10,20 +10,20 @@ This plugin computes the **kinetic and total energy summed over all particles**
 
 Only the time steps at which the total kinetic energy of all particles should be specified needs to be set via command line argument.
 
-================================== ========================================================================================================
-PIConGPU command line option       Description
-================================== ========================================================================================================
-``--e_energy.period 100``          Sets the time step period at which the energy of all **electrons** in the simulation should be simulated.
-                                   If set to e.g. ``100``, the energy is computed for time steps *0, 100, 200, ...*.
-                                   The default value is ``0``, meaning that the plugin does not compute the particle energy.
-``--<species>_energy.period 42``   Same as above, for any other species available.
-``--<species>_energy.filter name`` Use filtered particles. All available filters will be shown with ``picongpu --help``
-================================== ========================================================================================================
+================================ ========================================================================================================
+PIConGPU command line option     Description
+================================ ========================================================================================================
+``--e_energy.period 100``        Sets the time step period at which the energy of all **electrons** in the simulation should be simulated.
+                                 If set to e.g. ``100``, the energy is computed for time steps *0, 100, 200, ...*.
+                                 The default value is ``0``, meaning that the plugin does not compute the particle energy.
+``--<species>_energy.period 42`` Same as above, for any other species available.
+``--<species>_energy.filter``    Use filtered particles. All available filters will be shown with ``picongpu --help``
+================================ ========================================================================================================
 
 Output
 ^^^^^^
 
-The plugin creates files prefixed with the species' name and the filter name as postfix, e.g. `e_energy_<filter name>.dat` for the electron energies and `p_energy_<filter name>.dat` for proton energies.
+The plugin creates files prefixed with the species' name and the filter name as postfix, e.g. `e_energy_<filterName>.dat` for the electron energies and `p_energy_<filterName>.dat` for proton energies.
 The file contains a header describing the columns.
 
 .. code::
@@ -47,10 +47,10 @@ Python snippet:
    simDir = "path/to/simOutput/"
 
    # Ekin in Joules (see EnergyParticles)
-   e_sum_ene = np.loadtxt(simDir + "e_energy_All.dat")[:, 0:2]
-   p_sum_ene = np.loadtxt(simDir + "p_energy_All.dat")[:, 0:2]
-   C_sum_ene = np.loadtxt(simDir + "C_energy_All.dat")[:, 0:2]
-   N_sum_ene = np.loadtxt(simDir + "N_energy_All.dat")[:, 0:2]
+   e_sum_ene = np.loadtxt(simDir + "e_energy_all.dat")[:, 0:2]
+   p_sum_ene = np.loadtxt(simDir + "p_energy_all.dat")[:, 0:2]
+   C_sum_ene = np.loadtxt(simDir + "C_energy_all.dat")[:, 0:2]
+   N_sum_ene = np.loadtxt(simDir + "N_energy_all.dat")[:, 0:2]
    # Etotal in Joules
    fields_sum_ene = np.loadtxt(simDir + "fields_energy.dat")[:, 0:2]
 

diff --git a/share/picongpu/examples/FoilLCT/etc/picongpu/0004gpus.cfg b/share/picongpu/examples/FoilLCT/etc/picongpu/0004gpus.cfg
@@ -63,10 +63,10 @@ TBG_N_PSypy="--N_phaseSpace.period 250 --N_phaseSpace.space y --N_phaseSpace.mom
 
 # useful for heating tests
 TBG_sumEnergy="--fields_energy.period 100 \
-               --e_energy.period 100 --e_energy.filter All \
-               --H_energy.period 100 --H_energy.filter All \
-               --C_energy.period 100 --C_energy.filter All \
-               --N_energy.period 100 --N_energy.filter All"
+               --e_energy.period 100 --e_energy.filter all \
+               --H_energy.period 100 --H_energy.filter all \
+               --C_energy.period 100 --C_energy.filter all \
+               --N_energy.period 100 --N_energy.filter all"
 TBG_chargeConservation="--chargeConservation.period 100"
 
 # regular output

diff --git a/share/picongpu/examples/KelvinHelmholtz/etc/picongpu/0004gpus.cfg b/share/picongpu/examples/KelvinHelmholtz/etc/picongpu/0004gpus.cfg
@@ -61,8 +61,8 @@ TBG_plugins="!TBG_ipngYX                   \
               --i_macroParticlesCount.period 100         \
               --e_macroParticlesCount.period 100         \
               --fields_energy.period 10     \
-              --e_energy.period 10 --e_energy.filter All \
-              --i_energy.period 10 --i_energy.filter All"
+              --e_energy.period 10 --e_energy.filter all \
+              --i_energy.period 10 --i_energy.filter all"
 
 
 #################################

diff --git a/share/picongpu/examples/KelvinHelmholtz/etc/picongpu/0016gpus.cfg b/share/picongpu/examples/KelvinHelmholtz/etc/picongpu/0016gpus.cfg
@@ -67,8 +67,8 @@ TBG_plugins="!TBG_ipngYZ                   \
               --i_macroParticlesCount.period 100         \
               --e_macroParticlesCount.period 100         \
               --fields_energy.period 10     \
-              --e_energy.period 10 --e_energy.filter All \
-              --i_energy.period 10 --i_energy.filter All"
+              --e_energy.period 10 --e_energy.filter all \
+              --i_energy.period 10 --i_energy.filter all"
 
 
 #################################

diff --git a/share/picongpu/examples/WeibelTransverse/etc/picongpu/0004gpus.cfg b/share/picongpu/examples/WeibelTransverse/etc/picongpu/0004gpus.cfg
@@ -64,8 +64,8 @@ TBG_plugins="!TBG_ipngYX                   \
               --i_macroParticlesCount.period 100         \
               --e_macroParticlesCount.period 100         \
               --fields_energy.period 10     \
-              --e_energy.period 10 --e_energy.filter All \
-              --i_energy.period 10 --i_energy.filter All"
+              --e_energy.period 10 --e_energy.filter all \
+              --i_energy.period 10 --i_energy.filter all"
 
 
 #################################

diff --git a/src/tools/bin/plotNumericalHeating b/src/tools/bin/plotNumericalHeating
@@ -119,7 +119,7 @@ for sim in directories:
     mydir = sim+simDir
     # get relevant files with energy
     files = [f for f in os.listdir(mydir)
-             if os.path.isfile(os.path.join(mydir, f)) and re.search('^.*_energy_All.dat', f)]
+             if os.path.isfile(os.path.join(mydir, f)) and re.search('^.*_energy_all.dat', f)]
     # check if file list is empty
     if len(files) == 0:
         sys.exit("There were no energy files in \"{}\".".format(mydir))