From d12e44c46662ba40822a167b9024f80786811435 Mon Sep 17 00:00:00 2001 From: Chad Mitchell Date: Fri, 13 Sep 2024 18:36:47 -0700 Subject: [PATCH] Add documentation. --- docs/source/dataanalysis/dataanalysis.rst | 2 ++ docs/source/usage/examples.rst | 2 ++ examples/CMakeLists.txt | 17 +++++++++++++++++ 3 files changed, 21 insertions(+) diff --git a/docs/source/dataanalysis/dataanalysis.rst b/docs/source/dataanalysis/dataanalysis.rst index 4371f317c..6bc551c10 100644 --- a/docs/source/dataanalysis/dataanalysis.rst +++ b/docs/source/dataanalysis/dataanalysis.rst @@ -93,6 +93,8 @@ The code writes out the values in an ASCII file prefixed ``reduced_beam_characte Horizontal and vertical dispersion (unit: meter) * ``dispersion_px``, ``dispersion_py`` Derivative of horizontal and vertical dispersion (unit: dimensionless) +* ``emittance_1``, ``emittance_2``, ``emittance_3`` + Normalized rms beam eigenemittances (aka mode emittances) (unit: meter) * ``charge`` Total beam charge (unit: Coulomb) diff --git a/docs/source/usage/examples.rst b/docs/source/usage/examples.rst index 426881b7f..3eed51f4d 100644 --- a/docs/source/usage/examples.rst +++ b/docs/source/usage/examples.rst @@ -33,6 +33,8 @@ Single Particle Dynamics examples/achromatic_spectrometer/README.rst examples/fodo_programmable/README.rst examples/dogleg/README.rst + examples/coupled_optics/README.rst + Collective Effects ------------------ diff --git a/examples/CMakeLists.txt b/examples/CMakeLists.txt index d33221240..5953402bd 100644 --- a/examples/CMakeLists.txt +++ b/examples/CMakeLists.txt @@ -959,3 +959,20 @@ add_impactx_test(dogleg.py examples/dogleg/analysis_dogleg.py OFF # no plot script yet ) + +# Coupled Optics ############################################################# +# +# w/o space charge +add_impactx_test(coupled-optics + examples/dogleg/input_coupled_optics.in + ON # ImpactX MPI-parallel + examples/dogleg/analysis_coupled_optics.py + OFF # no plot script yet +) +add_impactx_test(coupled-optics.py + examples/dogleg/run_coupled_optics.py + OFF # ImpactX MPI-parallel + examples/dogleg/analysis_coupled_optics.py + OFF # no plot script yet +) +