Skip to content
Snippets Groups Projects
Commit 3bc94345 authored by GUBAIDULIN's avatar GUBAIDULIN
Browse files

docstring fix

parent 13f4fff2
No related branches found
No related tags found
2 merge requests!280.8.0,!18Ions
...@@ -353,6 +353,9 @@ class BeamIonElement(Element): ...@@ -353,6 +353,9 @@ class BeamIonElement(Element):
The number of records in the built-in ion beam monitor. Should be number of turns times number of bunches because the monitor records every turn after each bunch passage. The number of records in the built-in ion beam monitor. Should be number of turns times number of bunches because the monitor records every turn after each bunch passage.
n_ion_macroparticles_per_bunch : int, optional n_ion_macroparticles_per_bunch : int, optional
The number of ion macroparticles generated per electron bunch passed. Defaults to 30. The number of ion macroparticles generated per electron bunch passed. Defaults to 30.
ion_beam_monitor_name : str, optional
If provided, the name of the ion monitor output file. It must end with an extension '.hdf5'.
If None, no ion monitor file is generated.
use_ion_phase_space_monitor : bool, optional use_ion_phase_space_monitor : bool, optional
Whether to use the ion phase space monitor. Whether to use the ion phase space monitor.
generate_method : str, optional generate_method : str, optional
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment