diff --git a/docs/source/usage/parameters.rst b/docs/source/usage/parameters.rst index d21b1f2ab..be433b51c 100644 --- a/docs/source/usage/parameters.rst +++ b/docs/source/usage/parameters.rst @@ -449,6 +449,11 @@ Lattice Elements openPMD `iteration encoding `__: (v)ariable based, (f)ile based, (g)roup based (default) variable based is an `experimental feature with ADIOS2 `__. + * ``.cycle_intervals`` (``int``, default value: ``1``) + + For periodic lattice, only output every N cycles (turns). + By default, diagnostics is performed every cycle. + * ``.nonlinear_lens_invariants`` (``boolean``, default value: ``false``) Compute and output the invariants H and I within the nonlinear magnetic insert element (see: ``nonlinear_lens``). diff --git a/docs/source/usage/python.rst b/docs/source/usage/python.rst index 52acfe210..8f2c4f687 100644 --- a/docs/source/usage/python.rst +++ b/docs/source/usage/python.rst @@ -623,7 +623,7 @@ This module provides elements for the accelerator lattice. :param dy: vertical translation error in m :param rotation: rotation error in the transverse plane [degrees] -.. py:class:: impactx.elements.BeamMonitor(name, backend="default", encoding="g") +.. py:class:: impactx.elements.BeamMonitor(name, backend="default", encoding="g", cycle_intervals=1) A beam monitor, writing all beam particles at fixed ``s`` to openPMD files. @@ -640,6 +640,7 @@ This module provides elements for the accelerator lattice. :param name: name of the series :param backend: I/O backend, e.g., ``bp``, ``h5``, ``json`` :param encoding: openPMD iteration encoding: (v)ariable based, (f)ile based, (g)roup based (default) + :param cycle_intervals: for periodic lattice, only output every N cycles (turns) .. py:property:: name