Add and fix docs

ECP-WarpX · Sep 21, 2024 · 0f8c5e0 · 0f8c5e0
1 parent 236a29a
commit 0f8c5e0
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 6 deletions.
diff --git a/Docs/source/usage/parameters.rst b/Docs/source/usage/parameters.rst
@@ -2929,6 +2929,7 @@ BackTransformed Diagnostics
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 ``BackTransformed`` diag type are used when running a simulation in a boosted frame, to reconstruct output data to the lab frame. This option can be set using ``<diag_name>.diag_type = BackTransformed``. We support the following list of options from `Full Diagnostics`_
+
     ``<diag_name>.format``, ``<diag_name>.openpmd_backend``, ``<diag_name>.dump_rz_modes``, ``<diag_name>.file_prefix``, ``<diag_name>.diag_lo``, ``<diag_name>.diag_hi``, ``<diag_name>.write_species``, ``<diag_name>.species``.
 
     Additional options for this diagnostic include:
@@ -3519,7 +3520,7 @@ Reduced Diagnostics
         :math:`\int d\mathcal{E}^* \frac{d\mathcal{L}}{d\mathcal{E}^*} (\mathcal{E}^*, t)\sigma^*(\mathcal{E}^*)`
         gives the total number of collisions of that process (from the beginning of the simulation up until time :math:`t`).
 
-         The differential luminosity is given in units of :math:`\text{m}^{-2}.\text{eV}^{-1}`. For collider-relevant WarpX simulations
+        The differential luminosity is given in units of :math:`\text{m}^{-2}.\text{eV}^{-1}`. For collider-relevant WarpX simulations
         involving two crossing, high-energy beams of particles, the differential luminosity in :math:`\text{s}^{-1}.\text{m}^{-2}.\text{eV}^{-1}`
         can be obtained by multiplying the above differential luminosity by the expected repetition rate of the beams.
 

diff --git a/Docs/source/usage/python.rst b/Docs/source/usage/python.rst
@@ -114,6 +114,8 @@ Diagnostics
 
 .. autoclass:: pywarpx.picmi.FieldDiagnostic
 
+.. autoclass:: pywarpx.picmi.TimeAveragedFieldDiagnostic
+
 .. autoclass:: pywarpx.picmi.ElectrostaticFieldDiagnostic
 
 .. autoclass:: pywarpx.picmi.Checkpoint

diff --git a/Examples/Physics_applications/laser_ion/README.rst b/Examples/Physics_applications/laser_ion/README.rst
@@ -87,7 +87,7 @@ Visualize
    :alt: Particle densities for electrons (top), protons (middle), and electrons again in logarithmic scale (bottom).
    :width: 80%
 
-    Particle densities for electrons (top), protons (middle), and electrons again in logarithmic scale (bottom).
+   Particle densities for electrons (top), protons (middle), and electrons again in logarithmic scale (bottom).
 
 Particle density output illustrates the evolution of the target in time and space.
 Logarithmic scales can help to identify where the target becomes transparent for the laser pulse (bottom panel in :numref:`fig-tnsa-densities` ).

diff --git a/Examples/Physics_applications/laser_ion/inputs_test_2d_laser_ion_acc_picmi.py b/Examples/Physics_applications/laser_ion/inputs_test_2d_laser_ion_acc_picmi.py
@@ -171,7 +171,7 @@
     warpx_format="openpmd",
     warpx_openpmd_backend="h5",
     warpx_time_average_mode="dynamic_start",
-    warpx_average_period_steps=10,
+    warpx_average_period_time=2.67e-15,
 )
 
 particle_fw_diag = picmi.ParticleDiagnostic(

diff --git a/Source/Diagnostics/FullDiagnostics.cpp b/Source/Diagnostics/FullDiagnostics.cpp
@@ -157,10 +157,10 @@ FullDiagnostics::ReadParameters ()
             }
 
             if (averaging_period_time_specified || averaging_period_steps_specified) {
-                const std::string period_spec_warn_msg = "An averaging period was specified for the 'static_start' averaging mode" \
-                                                         "but will be IGNORED. Averaging will be performed between step" \
+                const std::string period_spec_warn_msg = "An averaging period was specified for the 'static_start' averaging mode " \
+                                                         "but will be IGNORED. Averaging will be performed between step " \
                                                          + std::to_string(m_average_start_step) \
-                                                         + "and the specified intervals.";
+                                                         + " and the specified intervals.";
                 ablastr::warn_manager::WMRecordWarning(
                         "Diagnostics",
                         period_spec_warn_msg,