From d867328c616ac331f64329a9dafa878b46fbf8e6 Mon Sep 17 00:00:00 2001 From: Chad Mitchell Date: Wed, 29 Jan 2025 12:43:17 -0800 Subject: [PATCH 1/5] Small additions to data analysis docs. --- docs/source/dataanalysis/dataanalysis.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/source/dataanalysis/dataanalysis.rst b/docs/source/dataanalysis/dataanalysis.rst index cc170b57a..96e1f5c6f 100644 --- a/docs/source/dataanalysis/dataanalysis.rst +++ b/docs/source/dataanalysis/dataanalysis.rst @@ -16,6 +16,9 @@ For data analysis of openPMD data, see examples of `many supported tools, Python See also `WarpX' documentation on openPMD `__. +At each monitor, the output for every particle in the beam is provided. This includes the 6 canonical phase space variables (x [m], px, y[m], py, t[m], pt), where each coordinate is measured +relative to the reference particle, in the local moving frame. See the section :ref:`Coordinates and Units ` for additional details. + .. _dataanalysis-monitor-refparticle: Additional Beam Attributes @@ -62,7 +65,7 @@ Reduced Beam Characteristics ---------------------------- ImpactX calculates reduced beam characteristics based on the beam moments during runtime. -These include averaged positions, momenta, beam emittances and Courant-Snyder (Twiss) parameters. +These include averaged positions and momenta, as well as beam emittances and Courant-Snyder (Twiss) parameters. For computing beam moments (as elsewhere), positions and momenta are given as deviations with respect to the reference particle (see :ref:`Coordinates and Units `). The reduced beam characteristics are stored with the output of the beam monitor element. From 0e8aab41a1fb1bfb428166383c8aca0c9bcb44d1 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 29 Jan 2025 20:44:39 +0000 Subject: [PATCH 2/5] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/source/dataanalysis/dataanalysis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/dataanalysis/dataanalysis.rst b/docs/source/dataanalysis/dataanalysis.rst index 96e1f5c6f..69d4d376f 100644 --- a/docs/source/dataanalysis/dataanalysis.rst +++ b/docs/source/dataanalysis/dataanalysis.rst @@ -16,7 +16,7 @@ For data analysis of openPMD data, see examples of `many supported tools, Python See also `WarpX' documentation on openPMD `__. -At each monitor, the output for every particle in the beam is provided. This includes the 6 canonical phase space variables (x [m], px, y[m], py, t[m], pt), where each coordinate is measured +At each monitor, the output for every particle in the beam is provided. This includes the 6 canonical phase space variables (x [m], px, y[m], py, t[m], pt), where each coordinate is measured relative to the reference particle, in the local moving frame. See the section :ref:`Coordinates and Units ` for additional details. .. _dataanalysis-monitor-refparticle: From ae7fb50094575faaa1c6111815e9133d294a6493 Mon Sep 17 00:00:00 2001 From: Chad Mitchell <46825199+cemitch99@users.noreply.github.com> Date: Wed, 29 Jan 2025 14:06:11 -0800 Subject: [PATCH 3/5] Apply n01r's suggestions. Co-authored-by: Marco Garten --- docs/source/dataanalysis/dataanalysis.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/source/dataanalysis/dataanalysis.rst b/docs/source/dataanalysis/dataanalysis.rst index 69d4d376f..182a5c5a6 100644 --- a/docs/source/dataanalysis/dataanalysis.rst +++ b/docs/source/dataanalysis/dataanalysis.rst @@ -16,8 +16,9 @@ For data analysis of openPMD data, see examples of `many supported tools, Python See also `WarpX' documentation on openPMD `__. -At each monitor, the output for every particle in the beam is provided. This includes the 6 canonical phase space variables (x [m], px, y[m], py, t[m], pt), where each coordinate is measured -relative to the reference particle, in the local moving frame. See the section :ref:`Coordinates and Units ` for additional details. +At each monitor, the output for every particle in the beam is provided. +This includes the 6 canonical phase space variables (x [m], px, y[m], py, t[m], pt), where each coordinate is measured relative to the reference particle, in the local moving frame. +See the section :ref:`Coordinates and Units ` for additional details. .. _dataanalysis-monitor-refparticle: From 7d905df4174deb2684e44bb122c5841050fe3cc3 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 29 Jan 2025 22:06:18 +0000 Subject: [PATCH 4/5] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/source/dataanalysis/dataanalysis.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/dataanalysis/dataanalysis.rst b/docs/source/dataanalysis/dataanalysis.rst index 182a5c5a6..b44e43c2e 100644 --- a/docs/source/dataanalysis/dataanalysis.rst +++ b/docs/source/dataanalysis/dataanalysis.rst @@ -16,8 +16,8 @@ For data analysis of openPMD data, see examples of `many supported tools, Python See also `WarpX' documentation on openPMD `__. -At each monitor, the output for every particle in the beam is provided. -This includes the 6 canonical phase space variables (x [m], px, y[m], py, t[m], pt), where each coordinate is measured relative to the reference particle, in the local moving frame. +At each monitor, the output for every particle in the beam is provided. +This includes the 6 canonical phase space variables (x [m], px, y[m], py, t[m], pt), where each coordinate is measured relative to the reference particle, in the local moving frame. See the section :ref:`Coordinates and Units ` for additional details. .. _dataanalysis-monitor-refparticle: From 4d58e071af8aa650f902aa1e71080018e3c37553 Mon Sep 17 00:00:00 2001 From: Axel Huebl Date: Wed, 29 Jan 2025 16:21:48 -0800 Subject: [PATCH 5/5] Update dataanalysis.rst --- docs/source/dataanalysis/dataanalysis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/dataanalysis/dataanalysis.rst b/docs/source/dataanalysis/dataanalysis.rst index b44e43c2e..ff356ce85 100644 --- a/docs/source/dataanalysis/dataanalysis.rst +++ b/docs/source/dataanalysis/dataanalysis.rst @@ -102,7 +102,7 @@ The code writes out the values in an ASCII file prefixed ``reduced_beam_characte * ``emittance_1``, ``emittance_2``, ``emittance_3`` Normalized rms beam eigenemittances (aka mode emittances) (unit: meter) These three diagnostics are written optionally if the flag eigenemittances = True. -* ``charge`` +* ``charge_C`` Total beam charge (unit: Coulomb)