Skip to content

Commit

Permalink
Small additions to data analysis docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
cemitch99 committed Jan 29, 2025
1 parent e1e1c96 commit d867328
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/source/dataanalysis/dataanalysis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ For data analysis of openPMD data, see examples of `many supported tools, Python

See also `WarpX' documentation on openPMD <https://warpx.readthedocs.io/en/latest/dataanalysis/formats.html>`__.

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 <theory-coordinates-and-units>` for additional details.

.. _dataanalysis-monitor-refparticle:

Additional Beam Attributes
Expand Down Expand Up @@ -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 <theory-coordinates-and-units>`).

The reduced beam characteristics are stored with the output of the beam monitor element.
Expand Down

0 comments on commit d867328

Please sign in to comment.