from collections import OrderedDict
from copy import deepcopy
from datetime import datetime
-from os.path import abspath, basename, dirname, join
+from os.path import abspath, basename, dirname, join, splitext
+from typing import Generator, Tuple
import turn_by_turn as tbt
+from generic_parser import DotDict
+from generic_parser.entrypoint_parser import (EntryPoint, EntryPointParameters, add_to_arguments,
+ entrypoint, save_options_to_config)
-from generic_parser.entrypoint_parser import (EntryPoint, EntryPointParameters,
- add_to_arguments, entrypoint,
- save_options_to_config)
from omc3.definitions import formats
from omc3.harpy import handler
from omc3.model import manager
@@ -295,6 +298,9 @@ Source code for omc3.hole_in_one
Flags: **--outputdir**
Required: ``True``
+ - **suffix** *(str)*: User-defined suffix for the output filenames.
+
+ Flags: **--suffix**
- **to_write**: Choose the type of output.
Flags: **--to_write**
@@ -304,6 +310,10 @@ Source code for omc3.hole_in_one
Flags: **--turns**
Default: ``[0, 50000]``
+ - **bunch_ids** *(int)*: Bunches to process in multi-bunch file. If not specified, all bunches
+ are processed.
+
+ Flags: **--bunch_ids**
- **unit** *(str)*: A unit of TbT BPM orbit data. All cuts and output are in 'm'.
Flags: **--unit**
@@ -581,7 +591,7 @@ Source code for omc3.hole_in_one
tbt_datas = [(tbt.read_tbt(option.files, datatype=option.tbt_datatype), option) for option in all_options]
for tbt_data, option in tbt_datas:
lins.extend([handler.run_per_bunch(bunch_data, bunch_options)
- for bunch_data, bunch_options in _multibunch(tbt_data, option)])
+ for bunch_data, bunch_options in _add_suffix_and_iter_bunches(tbt_data, option)])
return lins
@@ -594,16 +604,42 @@ Source code for omc3.hole_in_one
return list_of_options
-def _multibunch(tbt_datas, options):
- if tbt_datas.nbunches == 1:
- yield tbt_datas, options
+def _add_suffix_and_iter_bunches(tbt_data: tbt.TbtData, options: DotDict
+ ) -> Generator[Tuple[tbt.TbtData, DotDict], None, None]:
+ # hint: options.files is now a single file because of _replicate_harpy_options_per_file
+ # it is also only used here to define the output name, as the tbt-data is already loaded.
+
+ dir_name = dirname(options.files)
+ file_name = basename(options.files)
+ suffix = options.suffix or ""
+
+ # Single bunch ---
+ if tbt_data.nbunches == 1:
+ if suffix:
+ options.files = join(dir_name, f"{file_name}{suffix}")
+ yield tbt_data, options
return
- for index in range(tbt_datas.nbunches):
+
+ # Multibunch ---
+ if options.bunch_ids is not None:
+ unknown_bunches = set(options.bunch_ids) - set(tbt_data.bunch_ids)
+ if unknown_bunches:
+ LOGGER.warning(
+ f"Bunch IDs {unknown_bunches} not present in multi-bunch file {options.files}."
+ )
+
+ for index in range(tbt_data.nbunches):
+ bunch_id = tbt_data.bunch_ids[index]
+ if options.bunch_ids is not None and bunch_id not in options.bunch_ids:
+ continue
+
new_options = deepcopy(options)
- new_file_name = f"bunchid{tbt_datas.bunch_ids[index]}_{basename(new_options.files)}"
- new_options.files = join(dirname(options.files), new_file_name)
- yield tbt.TbtData([tbt_datas.matrices[index]], tbt_datas.date,
- [tbt_datas.bunch_ids[index]], tbt_datas.nturns), new_options
+ bunch_id_str = f"_bunchID{bunch_id}"
+ new_options.files = join(dir_name, f"{file_name}{bunch_id_str}{suffix}")
+ yield (
+ tbt.TbtData([tbt_data.matrices[index]], tbt_data.date, [bunch_id], tbt_data.nturns),
+ new_options
+ )
def _measure_optics(lins, optics_opt):
@@ -644,12 +680,16 @@ Source code for omc3.hole_in_one
params = EntryPointParameters()
params.add_parameter(name="files", required=True, nargs='+', help="TbT files to analyse")
params.add_parameter(name="outputdir", required=True, help="Output directory.")
+ params.add_parameter(name="suffix", type=str, help="User-defined suffix for output filenames.")
params.add_parameter(name="model", help="Model for BPM locations")
params.add_parameter(name="unit", type=str, default=HARPY_DEFAULTS["unit"],
choices=("m", "cm", "mm", "um"),
help=f"A unit of TbT BPM orbit data. All cuts and output are in 'm'.")
params.add_parameter(name="turns", type=int, nargs=2, default=HARPY_DEFAULTS["turns"],
help="Turn index to start and first turn index to be ignored.")
+ params.add_parameter(name="bunch_ids", type=int, nargs="+",
+ help="Bunches to process in multi-bunch file. "
+ "If not specified, all bunches are processed.")
params.add_parameter(name="to_write", nargs='+', default=HARPY_DEFAULTS["to_write"],
choices=('lin', 'spectra', 'full_spectra', 'bpm_summary'),
help="Choose the type of output.")
diff --git a/_modules/omc3/kmod/analysis.html b/_modules/omc3/kmod/analysis.html
index 43f56205..fe39ccba 100644
--- a/_modules/omc3/kmod/analysis.html
+++ b/_modules/omc3/kmod/analysis.html
@@ -1,19 +1,21 @@
-
+
- omc3.kmod.analysis — omc3 0.11.4 documentation
-
-
-
+ omc3.kmod.analysis — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/knob_extractor.html b/_modules/omc3/knob_extractor.html
index 7e1c663b..692699b6 100644
--- a/_modules/omc3/knob_extractor.html
+++ b/_modules/omc3/knob_extractor.html
@@ -1,19 +1,21 @@
-
+
- omc3.knob_extractor — omc3 0.11.4 documentation
-
-
-
+ omc3.knob_extractor — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/madx_wrapper.html b/_modules/omc3/madx_wrapper.html
index 46e05c97..e7f7a264 100644
--- a/_modules/omc3/madx_wrapper.html
+++ b/_modules/omc3/madx_wrapper.html
@@ -1,19 +1,21 @@
-
+
- omc3.madx_wrapper — omc3 0.11.4 documentation
-
-
-
+ omc3.madx_wrapper — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/model/accelerators/accelerator.html b/_modules/omc3/model/accelerators/accelerator.html
index 6e0a9469..da7edf36 100644
--- a/_modules/omc3/model/accelerators/accelerator.html
+++ b/_modules/omc3/model/accelerators/accelerator.html
@@ -1,19 +1,21 @@
-
+
- omc3.model.accelerators.accelerator — omc3 0.11.4 documentation
-
-
-
+ omc3.model.accelerators.accelerator — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/model/accelerators/esrf.html b/_modules/omc3/model/accelerators/esrf.html
index 91b54ce0..e79d69dc 100644
--- a/_modules/omc3/model/accelerators/esrf.html
+++ b/_modules/omc3/model/accelerators/esrf.html
@@ -1,19 +1,21 @@
-
+
- omc3.model.accelerators.esrf — omc3 0.11.4 documentation
-
-
-
+ omc3.model.accelerators.esrf — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/model/accelerators/iota.html b/_modules/omc3/model/accelerators/iota.html
index 66b58e63..6c3ebce1 100644
--- a/_modules/omc3/model/accelerators/iota.html
+++ b/_modules/omc3/model/accelerators/iota.html
@@ -1,19 +1,21 @@
-
+
- omc3.model.accelerators.iota — omc3 0.11.4 documentation
-
-
-
+ omc3.model.accelerators.iota — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/model/accelerators/lhc.html b/_modules/omc3/model/accelerators/lhc.html
index b9f69959..13a62765 100644
--- a/_modules/omc3/model/accelerators/lhc.html
+++ b/_modules/omc3/model/accelerators/lhc.html
@@ -1,19 +1,21 @@
-
+
- omc3.model.accelerators.lhc — omc3 0.11.4 documentation
-
-
-
+ omc3.model.accelerators.lhc — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/model/accelerators/petra.html b/_modules/omc3/model/accelerators/petra.html
index adf44141..4a896fec 100644
--- a/_modules/omc3/model/accelerators/petra.html
+++ b/_modules/omc3/model/accelerators/petra.html
@@ -1,19 +1,21 @@
-
+
- omc3.model.accelerators.petra — omc3 0.11.4 documentation
-
-
-
+ omc3.model.accelerators.petra — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/model/accelerators/ps.html b/_modules/omc3/model/accelerators/ps.html
index 71327017..62d996ba 100644
--- a/_modules/omc3/model/accelerators/ps.html
+++ b/_modules/omc3/model/accelerators/ps.html
@@ -1,19 +1,21 @@
-
+
- omc3.model.accelerators.ps — omc3 0.11.4 documentation
-
-
-
+ omc3.model.accelerators.ps — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/model/accelerators/psbooster.html b/_modules/omc3/model/accelerators/psbooster.html
index 0523e9c8..f0454abe 100644
--- a/_modules/omc3/model/accelerators/psbooster.html
+++ b/_modules/omc3/model/accelerators/psbooster.html
@@ -1,19 +1,21 @@
-
+
- omc3.model.accelerators.psbooster — omc3 0.11.4 documentation
-
-
-
+ omc3.model.accelerators.psbooster — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/model/accelerators/skekb.html b/_modules/omc3/model/accelerators/skekb.html
index 4b7e286d..216dbe8d 100644
--- a/_modules/omc3/model/accelerators/skekb.html
+++ b/_modules/omc3/model/accelerators/skekb.html
@@ -1,19 +1,21 @@
-
+
- omc3.model.accelerators.skekb — omc3 0.11.4 documentation
-
-
-
+ omc3.model.accelerators.skekb — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/model/manager.html b/_modules/omc3/model/manager.html
index cfcd0164..f120ea32 100644
--- a/_modules/omc3/model/manager.html
+++ b/_modules/omc3/model/manager.html
@@ -1,19 +1,21 @@
-
+
- omc3.model.manager — omc3 0.11.4 documentation
-
-
-
+ omc3.model.manager — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/model/model_creators/lhc_model_creator.html b/_modules/omc3/model/model_creators/lhc_model_creator.html
index 0e880617..a9119aba 100644
--- a/_modules/omc3/model/model_creators/lhc_model_creator.html
+++ b/_modules/omc3/model/model_creators/lhc_model_creator.html
@@ -1,19 +1,21 @@
-
+
- omc3.model.model_creators.lhc_model_creator — omc3 0.11.4 documentation
-
-
-
+ omc3.model.model_creators.lhc_model_creator — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/model/model_creators/ps_model_creator.html b/_modules/omc3/model/model_creators/ps_model_creator.html
index f87e88c0..8c04f6e4 100644
--- a/_modules/omc3/model/model_creators/ps_model_creator.html
+++ b/_modules/omc3/model/model_creators/ps_model_creator.html
@@ -1,19 +1,21 @@
-
+
- omc3.model.model_creators.ps_model_creator — omc3 0.11.4 documentation
-
-
-
+ omc3.model.model_creators.ps_model_creator — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/model/model_creators/psbooster_model_creator.html b/_modules/omc3/model/model_creators/psbooster_model_creator.html
index 58e0c2df..f3e7c6b8 100644
--- a/_modules/omc3/model/model_creators/psbooster_model_creator.html
+++ b/_modules/omc3/model/model_creators/psbooster_model_creator.html
@@ -1,19 +1,21 @@
-
+
- omc3.model.model_creators.psbooster_model_creator — omc3 0.11.4 documentation
-
-
-
+ omc3.model.model_creators.psbooster_model_creator — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/model_creator.html b/_modules/omc3/model_creator.html
index 26306c01..78fb5477 100644
--- a/_modules/omc3/model_creator.html
+++ b/_modules/omc3/model_creator.html
@@ -1,19 +1,21 @@
-
+
- omc3.model_creator — omc3 0.11.4 documentation
-
-
-
+ omc3.model_creator — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/optics_measurements/beta_from_amplitude.html b/_modules/omc3/optics_measurements/beta_from_amplitude.html
index c234e863..bc47cd33 100644
--- a/_modules/omc3/optics_measurements/beta_from_amplitude.html
+++ b/_modules/omc3/optics_measurements/beta_from_amplitude.html
@@ -1,19 +1,21 @@
-
+
- omc3.optics_measurements.beta_from_amplitude — omc3 0.11.4 documentation
-
-
-
+ omc3.optics_measurements.beta_from_amplitude — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/optics_measurements/beta_from_phase.html b/_modules/omc3/optics_measurements/beta_from_phase.html
index e3b2a3f5..1eb8cce8 100644
--- a/_modules/omc3/optics_measurements/beta_from_phase.html
+++ b/_modules/omc3/optics_measurements/beta_from_phase.html
@@ -1,19 +1,21 @@
-
+
- omc3.optics_measurements.beta_from_phase — omc3 0.11.4 documentation
-
-
-
+ omc3.optics_measurements.beta_from_phase — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/optics_measurements/data_models.html b/_modules/omc3/optics_measurements/data_models.html
index 6035c510..fb2a1db5 100644
--- a/_modules/omc3/optics_measurements/data_models.html
+++ b/_modules/omc3/optics_measurements/data_models.html
@@ -1,19 +1,21 @@
-
+
- omc3.optics_measurements.data_models — omc3 0.11.4 documentation
-
-
-
+ omc3.optics_measurements.data_models — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/optics_measurements/dispersion.html b/_modules/omc3/optics_measurements/dispersion.html
index 60c5df54..d89bdbe0 100644
--- a/_modules/omc3/optics_measurements/dispersion.html
+++ b/_modules/omc3/optics_measurements/dispersion.html
@@ -1,19 +1,21 @@
-
+
- omc3.optics_measurements.dispersion — omc3 0.11.4 documentation
-
-
-
+ omc3.optics_measurements.dispersion — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/optics_measurements/dpp.html b/_modules/omc3/optics_measurements/dpp.html
index c44957a6..055a50dd 100644
--- a/_modules/omc3/optics_measurements/dpp.html
+++ b/_modules/omc3/optics_measurements/dpp.html
@@ -1,19 +1,21 @@
-
+
- omc3.optics_measurements.dpp — omc3 0.11.4 documentation
-
-
-
+ omc3.optics_measurements.dpp — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/optics_measurements/interaction_point.html b/_modules/omc3/optics_measurements/interaction_point.html
index e8edc8e7..1976910c 100644
--- a/_modules/omc3/optics_measurements/interaction_point.html
+++ b/_modules/omc3/optics_measurements/interaction_point.html
@@ -1,19 +1,21 @@
-
+
- omc3.optics_measurements.interaction_point — omc3 0.11.4 documentation
-
-
-
+ omc3.optics_measurements.interaction_point — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/optics_measurements/kick.html b/_modules/omc3/optics_measurements/kick.html
index b9e5fb16..339d2665 100644
--- a/_modules/omc3/optics_measurements/kick.html
+++ b/_modules/omc3/optics_measurements/kick.html
@@ -1,19 +1,21 @@
-
+
- omc3.optics_measurements.kick — omc3 0.11.4 documentation
-
-
-
+ omc3.optics_measurements.kick — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/optics_measurements/measure_optics.html b/_modules/omc3/optics_measurements/measure_optics.html
index 2cf18efe..99e27637 100644
--- a/_modules/omc3/optics_measurements/measure_optics.html
+++ b/_modules/omc3/optics_measurements/measure_optics.html
@@ -1,19 +1,21 @@
-
+
- omc3.optics_measurements.measure_optics — omc3 0.11.4 documentation
-
-
-
+ omc3.optics_measurements.measure_optics — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/optics_measurements/phase.html b/_modules/omc3/optics_measurements/phase.html
index 08b1244d..62fd4fd7 100644
--- a/_modules/omc3/optics_measurements/phase.html
+++ b/_modules/omc3/optics_measurements/phase.html
@@ -1,19 +1,21 @@
-
+
- omc3.optics_measurements.phase — omc3 0.11.4 documentation
-
-
-
+ omc3.optics_measurements.phase — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/optics_measurements/rdt.html b/_modules/omc3/optics_measurements/rdt.html
index 734299ed..2801fab1 100644
--- a/_modules/omc3/optics_measurements/rdt.html
+++ b/_modules/omc3/optics_measurements/rdt.html
@@ -1,19 +1,21 @@
-
+
- omc3.optics_measurements.rdt — omc3 0.11.4 documentation
-
-
-
+ omc3.optics_measurements.rdt — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/optics_measurements/toolbox.html b/_modules/omc3/optics_measurements/toolbox.html
index dcb96dc2..c72d2f88 100644
--- a/_modules/omc3/optics_measurements/toolbox.html
+++ b/_modules/omc3/optics_measurements/toolbox.html
@@ -1,19 +1,21 @@
-
+
- omc3.optics_measurements.toolbox — omc3 0.11.4 documentation
-
-
-
+ omc3.optics_measurements.toolbox — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/optics_measurements/tune.html b/_modules/omc3/optics_measurements/tune.html
index 8576e8f2..bfaccaeb 100644
--- a/_modules/omc3/optics_measurements/tune.html
+++ b/_modules/omc3/optics_measurements/tune.html
@@ -1,19 +1,21 @@
-
+
- omc3.optics_measurements.tune — omc3 0.11.4 documentation
-
-
-
+ omc3.optics_measurements.tune — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/plotting/optics_measurements/utils.html b/_modules/omc3/plotting/optics_measurements/utils.html
index 83d29d39..4c29c723 100644
--- a/_modules/omc3/plotting/optics_measurements/utils.html
+++ b/_modules/omc3/plotting/optics_measurements/utils.html
@@ -1,19 +1,21 @@
-
+
- omc3.plotting.optics_measurements.utils — omc3 0.11.4 documentation
-
-
-
+ omc3.plotting.optics_measurements.utils — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/plotting/plot_amplitude_detuning.html b/_modules/omc3/plotting/plot_amplitude_detuning.html
index 740264ae..0de5c9ea 100644
--- a/_modules/omc3/plotting/plot_amplitude_detuning.html
+++ b/_modules/omc3/plotting/plot_amplitude_detuning.html
@@ -1,19 +1,21 @@
-
+
- omc3.plotting.plot_amplitude_detuning — omc3 0.11.4 documentation
-
-
-
+ omc3.plotting.plot_amplitude_detuning — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/plotting/plot_bbq.html b/_modules/omc3/plotting/plot_bbq.html
index c6cb524c..093bc220 100644
--- a/_modules/omc3/plotting/plot_bbq.html
+++ b/_modules/omc3/plotting/plot_bbq.html
@@ -1,19 +1,21 @@
-
+
- omc3.plotting.plot_bbq — omc3 0.11.4 documentation
-
-
-
+ omc3.plotting.plot_bbq — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/plotting/plot_checked_corrections.html b/_modules/omc3/plotting/plot_checked_corrections.html
index adbdd06f..7a05645d 100644
--- a/_modules/omc3/plotting/plot_checked_corrections.html
+++ b/_modules/omc3/plotting/plot_checked_corrections.html
@@ -1,19 +1,21 @@
-
+
- omc3.plotting.plot_checked_corrections — omc3 0.11.4 documentation
-
-
-
+ omc3.plotting.plot_checked_corrections — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/plotting/plot_optics_measurements.html b/_modules/omc3/plotting/plot_optics_measurements.html
index d6c940e3..ad02ee68 100644
--- a/_modules/omc3/plotting/plot_optics_measurements.html
+++ b/_modules/omc3/plotting/plot_optics_measurements.html
@@ -1,19 +1,21 @@
-
+
- omc3.plotting.plot_optics_measurements — omc3 0.11.4 documentation
-
-
-
+ omc3.plotting.plot_optics_measurements — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/plotting/plot_spectrum.html b/_modules/omc3/plotting/plot_spectrum.html
index 0f7babb8..4b479695 100644
--- a/_modules/omc3/plotting/plot_spectrum.html
+++ b/_modules/omc3/plotting/plot_spectrum.html
@@ -1,19 +1,21 @@
-
+
- omc3.plotting.plot_spectrum — omc3 0.11.4 documentation
-
-
-
+ omc3.plotting.plot_spectrum — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/plotting/plot_tfs.html b/_modules/omc3/plotting/plot_tfs.html
index 336a5043..7a3fbe15 100644
--- a/_modules/omc3/plotting/plot_tfs.html
+++ b/_modules/omc3/plotting/plot_tfs.html
@@ -1,19 +1,21 @@
-
+
- omc3.plotting.plot_tfs — omc3 0.11.4 documentation
-
-
-
+ omc3.plotting.plot_tfs — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/plotting/spectrum/stem.html b/_modules/omc3/plotting/spectrum/stem.html
index c1b85988..4955a0e3 100644
--- a/_modules/omc3/plotting/spectrum/stem.html
+++ b/_modules/omc3/plotting/spectrum/stem.html
@@ -1,19 +1,21 @@
-
+
- omc3.plotting.spectrum.stem — omc3 0.11.4 documentation
-
-
-
+ omc3.plotting.spectrum.stem — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/plotting/spectrum/utils.html b/_modules/omc3/plotting/spectrum/utils.html
index 3d4cb906..233d007c 100644
--- a/_modules/omc3/plotting/spectrum/utils.html
+++ b/_modules/omc3/plotting/spectrum/utils.html
@@ -1,19 +1,21 @@
-
+
- omc3.plotting.spectrum.utils — omc3 0.11.4 documentation
-
-
-
+ omc3.plotting.spectrum.utils — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/plotting/spectrum/waterfall.html b/_modules/omc3/plotting/spectrum/waterfall.html
index fbfac258..4650dfc2 100644
--- a/_modules/omc3/plotting/spectrum/waterfall.html
+++ b/_modules/omc3/plotting/spectrum/waterfall.html
@@ -1,19 +1,21 @@
-
+
- omc3.plotting.spectrum.waterfall — omc3 0.11.4 documentation
-
-
-
+ omc3.plotting.spectrum.waterfall — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/plotting/utils/annotations.html b/_modules/omc3/plotting/utils/annotations.html
index 12ab5341..c471d83e 100644
--- a/_modules/omc3/plotting/utils/annotations.html
+++ b/_modules/omc3/plotting/utils/annotations.html
@@ -1,19 +1,21 @@
-
+
- omc3.plotting.utils.annotations — omc3 0.11.4 documentation
-
-
-
+ omc3.plotting.utils.annotations — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/plotting/utils/colors.html b/_modules/omc3/plotting/utils/colors.html
index d42efaa3..1b53bbd9 100644
--- a/_modules/omc3/plotting/utils/colors.html
+++ b/_modules/omc3/plotting/utils/colors.html
@@ -1,19 +1,21 @@
-
+
- omc3.plotting.utils.colors — omc3 0.11.4 documentation
-
-
-
+ omc3.plotting.utils.colors — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/plotting/utils/lines.html b/_modules/omc3/plotting/utils/lines.html
index 2e4d6b64..bc130e13 100644
--- a/_modules/omc3/plotting/utils/lines.html
+++ b/_modules/omc3/plotting/utils/lines.html
@@ -1,19 +1,21 @@
-
+
- omc3.plotting.utils.lines — omc3 0.11.4 documentation
-
-
-
+ omc3.plotting.utils.lines — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/plotting/utils/style.html b/_modules/omc3/plotting/utils/style.html
index 3f2814f0..dad3da63 100644
--- a/_modules/omc3/plotting/utils/style.html
+++ b/_modules/omc3/plotting/utils/style.html
@@ -1,19 +1,21 @@
-
+
- omc3.plotting.utils.style — omc3 0.11.4 documentation
-
-
-
+ omc3.plotting.utils.style — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/plotting/utils/windows.html b/_modules/omc3/plotting/utils/windows.html
index 4458f71e..9023cd1b 100644
--- a/_modules/omc3/plotting/utils/windows.html
+++ b/_modules/omc3/plotting/utils/windows.html
@@ -1,19 +1,21 @@
-
+
- omc3.plotting.utils.windows — omc3 0.11.4 documentation
-
-
-
+ omc3.plotting.utils.windows — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/response_creator.html b/_modules/omc3/response_creator.html
index a61cd601..2bd630bc 100644
--- a/_modules/omc3/response_creator.html
+++ b/_modules/omc3/response_creator.html
@@ -1,19 +1,21 @@
-
+
- omc3.response_creator — omc3 0.11.4 documentation
-
-
-
+ omc3.response_creator — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/run_kmod.html b/_modules/omc3/run_kmod.html
index e5e2c4d6..b3f4b984 100644
--- a/_modules/omc3/run_kmod.html
+++ b/_modules/omc3/run_kmod.html
@@ -1,19 +1,21 @@
-
+
- omc3.run_kmod — omc3 0.11.4 documentation
-
-
-
+ omc3.run_kmod — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/scripts/betabeatsrc_output_converter.html b/_modules/omc3/scripts/betabeatsrc_output_converter.html
index 6e280a5e..fc817c20 100644
--- a/_modules/omc3/scripts/betabeatsrc_output_converter.html
+++ b/_modules/omc3/scripts/betabeatsrc_output_converter.html
@@ -1,19 +1,21 @@
-
+
- omc3.scripts.betabeatsrc_output_converter — omc3 0.11.4 documentation
-
-
-
+ omc3.scripts.betabeatsrc_output_converter — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/scripts/fake_measurement_from_model.html b/_modules/omc3/scripts/fake_measurement_from_model.html
index 8b1d86a0..48e18612 100644
--- a/_modules/omc3/scripts/fake_measurement_from_model.html
+++ b/_modules/omc3/scripts/fake_measurement_from_model.html
@@ -1,19 +1,21 @@
-
+
- omc3.scripts.fake_measurement_from_model — omc3 0.11.4 documentation
-
-
-
+ omc3.scripts.fake_measurement_from_model — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/scripts/linfile_clean.html b/_modules/omc3/scripts/linfile_clean.html
index 6fc706ae..5dacfb58 100644
--- a/_modules/omc3/scripts/linfile_clean.html
+++ b/_modules/omc3/scripts/linfile_clean.html
@@ -1,19 +1,21 @@
-
+
- omc3.scripts.linfile_clean — omc3 0.11.4 documentation
-
-
-
+ omc3.scripts.linfile_clean — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/scripts/merge_kmod_results.html b/_modules/omc3/scripts/merge_kmod_results.html
index 74ceaa41..fe6938fb 100644
--- a/_modules/omc3/scripts/merge_kmod_results.html
+++ b/_modules/omc3/scripts/merge_kmod_results.html
@@ -1,19 +1,21 @@
-
+
- omc3.scripts.merge_kmod_results — omc3 0.11.4 documentation
-
-
-
+ omc3.scripts.merge_kmod_results — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/tbt_converter.html b/_modules/omc3/tbt_converter.html
index f4b09f0c..b894814a 100644
--- a/_modules/omc3/tbt_converter.html
+++ b/_modules/omc3/tbt_converter.html
@@ -1,19 +1,21 @@
-
+
- omc3.tbt_converter — omc3 0.11.4 documentation
-
-
-
+ omc3.tbt_converter — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/tune_analysis/bbq_tools.html b/_modules/omc3/tune_analysis/bbq_tools.html
index cc8162b9..6978278b 100644
--- a/_modules/omc3/tune_analysis/bbq_tools.html
+++ b/_modules/omc3/tune_analysis/bbq_tools.html
@@ -1,19 +1,21 @@
-
+
- omc3.tune_analysis.bbq_tools — omc3 0.11.4 documentation
-
-
-
+ omc3.tune_analysis.bbq_tools — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/tune_analysis/constants.html b/_modules/omc3/tune_analysis/constants.html
index 18534e65..37d21ee5 100644
--- a/_modules/omc3/tune_analysis/constants.html
+++ b/_modules/omc3/tune_analysis/constants.html
@@ -1,19 +1,21 @@
-
+
- omc3.tune_analysis.constants — omc3 0.11.4 documentation
-
-
-
+ omc3.tune_analysis.constants — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/tune_analysis/fitting_tools.html b/_modules/omc3/tune_analysis/fitting_tools.html
index 58ef632e..4124e3ae 100644
--- a/_modules/omc3/tune_analysis/fitting_tools.html
+++ b/_modules/omc3/tune_analysis/fitting_tools.html
@@ -1,19 +1,21 @@
-
+
- omc3.tune_analysis.fitting_tools — omc3 0.11.4 documentation
-
-
-
+ omc3.tune_analysis.fitting_tools — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/tune_analysis/kick_file_modifiers.html b/_modules/omc3/tune_analysis/kick_file_modifiers.html
index da8c4b7d..5c700266 100644
--- a/_modules/omc3/tune_analysis/kick_file_modifiers.html
+++ b/_modules/omc3/tune_analysis/kick_file_modifiers.html
@@ -1,19 +1,21 @@
-
+
- omc3.tune_analysis.kick_file_modifiers — omc3 0.11.4 documentation
-
-
-
+ omc3.tune_analysis.kick_file_modifiers — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/tune_analysis/timber_extract.html b/_modules/omc3/tune_analysis/timber_extract.html
index 2cea6d3c..f9de316c 100644
--- a/_modules/omc3/tune_analysis/timber_extract.html
+++ b/_modules/omc3/tune_analysis/timber_extract.html
@@ -1,19 +1,21 @@
-
+
- omc3.tune_analysis.timber_extract — omc3 0.11.4 documentation
-
-
-
+ omc3.tune_analysis.timber_extract — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/utils/contexts.html b/_modules/omc3/utils/contexts.html
index 3865859b..d392d2cc 100644
--- a/_modules/omc3/utils/contexts.html
+++ b/_modules/omc3/utils/contexts.html
@@ -1,19 +1,21 @@
-
+
- omc3.utils.contexts — omc3 0.11.4 documentation
-
-
-
+ omc3.utils.contexts — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/utils/iotools.html b/_modules/omc3/utils/iotools.html
index 4d1aff28..a427f742 100644
--- a/_modules/omc3/utils/iotools.html
+++ b/_modules/omc3/utils/iotools.html
@@ -1,19 +1,21 @@
-
+
- omc3.utils.iotools — omc3 0.11.4 documentation
-
-
-
+ omc3.utils.iotools — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/utils/logging_tools.html b/_modules/omc3/utils/logging_tools.html
index 10b69c24..208cd5fa 100644
--- a/_modules/omc3/utils/logging_tools.html
+++ b/_modules/omc3/utils/logging_tools.html
@@ -1,19 +1,21 @@
-
+
- omc3.utils.logging_tools — omc3 0.11.4 documentation
-
-
-
+ omc3.utils.logging_tools — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/utils/mock.html b/_modules/omc3/utils/mock.html
index a549116f..9e84de8b 100644
--- a/_modules/omc3/utils/mock.html
+++ b/_modules/omc3/utils/mock.html
@@ -1,19 +1,21 @@
-
+
- omc3.utils.mock — omc3 0.11.4 documentation
-
-
-
+ omc3.utils.mock — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/utils/outliers.html b/_modules/omc3/utils/outliers.html
index 4c9cf063..91eddac8 100644
--- a/_modules/omc3/utils/outliers.html
+++ b/_modules/omc3/utils/outliers.html
@@ -1,19 +1,21 @@
-
+
- omc3.utils.outliers — omc3 0.11.4 documentation
-
-
-
+ omc3.utils.outliers — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/utils/stats.html b/_modules/omc3/utils/stats.html
index 5ee608f3..0a275f43 100644
--- a/_modules/omc3/utils/stats.html
+++ b/_modules/omc3/utils/stats.html
@@ -1,19 +1,21 @@
-
+
- omc3.utils.stats — omc3 0.11.4 documentation
-
-
-
+ omc3.utils.stats — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_modules/omc3/utils/time_tools.html b/_modules/omc3/utils/time_tools.html
index efc4d806..2bd0f344 100644
--- a/_modules/omc3/utils/time_tools.html
+++ b/_modules/omc3/utils/time_tools.html
@@ -1,19 +1,21 @@
-
+
- omc3.utils.time_tools — omc3 0.11.4 documentation
-
-
-
+ omc3.utils.time_tools — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/_static/documentation_options.js b/_static/documentation_options.js
index c8cd94d3..c23d6404 100644
--- a/_static/documentation_options.js
+++ b/_static/documentation_options.js
@@ -1,5 +1,5 @@
const DOCUMENTATION_OPTIONS = {
- VERSION: '0.11.4',
+ VERSION: '0.12.0',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
diff --git a/entrypoints/analysis.doctree b/entrypoints/analysis.doctree
index 809c1169..6f5ce287 100644
Binary files a/entrypoints/analysis.doctree and b/entrypoints/analysis.doctree differ
diff --git a/entrypoints/analysis.html b/entrypoints/analysis.html
index b314877c..dae578fb 100644
--- a/entrypoints/analysis.html
+++ b/entrypoints/analysis.html
@@ -1,20 +1,22 @@
-
+
-
+
- Analysis — omc3 0.11.4 documentation
-
-
-
+ Analysis — omc3 0.12.0 documentation
+
+
+
+
+
-
+
@@ -289,6 +291,9 @@ Hole in OneTrue
+suffix (str): User-defined suffix for the output filenames.
+Flags: --suffix
+to_write: Choose the type of output.
Flags: --to_write
Choices: ('lin', 'spectra', 'full_spectra', 'bpm_summary')
@@ -298,6 +303,10 @@
Hole in One[0, 50000]
bunch_ids (int): Bunches to process in multi-bunch file. If not specified, all bunches
+are processed.
+Flags: --bunch_ids
+unit (str): A unit of TbT BPM orbit data. All cuts and output are in ‘m’.
Flags: --unit
Choices: ('m', 'cm', 'mm', 'um')
diff --git a/entrypoints/correction.doctree b/entrypoints/correction.doctree
index 107db295..ad453b9c 100644
Binary files a/entrypoints/correction.doctree and b/entrypoints/correction.doctree differ
diff --git a/entrypoints/correction.html b/entrypoints/correction.html
index 43f2c6f0..661c1452 100644
--- a/entrypoints/correction.html
+++ b/entrypoints/correction.html
@@ -1,20 +1,22 @@
-
+
-
+
- Correction — omc3 0.11.4 documentation
-
-
-
+ Correction — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/entrypoints/other.doctree b/entrypoints/other.doctree
index 4ae85507..1a6a3517 100644
Binary files a/entrypoints/other.doctree and b/entrypoints/other.doctree differ
diff --git a/entrypoints/other.html b/entrypoints/other.html
index d9b00f3f..2e0eed81 100644
--- a/entrypoints/other.html
+++ b/entrypoints/other.html
@@ -1,20 +1,22 @@
-
+
-
+
- Other — omc3 0.11.4 documentation
-
-
-
+ Other — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/entrypoints/plotting.doctree b/entrypoints/plotting.doctree
index faa6f0ce..c48d4cbe 100644
Binary files a/entrypoints/plotting.doctree and b/entrypoints/plotting.doctree differ
diff --git a/entrypoints/plotting.html b/entrypoints/plotting.html
index f8113869..ab2d279d 100644
--- a/entrypoints/plotting.html
+++ b/entrypoints/plotting.html
@@ -1,20 +1,22 @@
-
+
-
+
- Plotting — omc3 0.11.4 documentation
-
-
-
+ Plotting — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/entrypoints/scripts.doctree b/entrypoints/scripts.doctree
index 48841684..aea71c9e 100644
Binary files a/entrypoints/scripts.doctree and b/entrypoints/scripts.doctree differ
diff --git a/entrypoints/scripts.html b/entrypoints/scripts.html
index 5c3c4c81..2814d940 100644
--- a/entrypoints/scripts.html
+++ b/entrypoints/scripts.html
@@ -1,20 +1,22 @@
-
+
-
+
- Scripts — omc3 0.11.4 documentation
-
-
-
+ Scripts — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/environment.pickle b/environment.pickle
index 6d7971ff..27d96314 100644
Binary files a/environment.pickle and b/environment.pickle differ
diff --git a/genindex.html b/genindex.html
index 390ea5c3..98131bd8 100644
--- a/genindex.html
+++ b/genindex.html
@@ -1,19 +1,21 @@
-
+
- Index — omc3 0.11.4 documentation
-
-
-
+ Index — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/index.doctree b/index.doctree
index fe3c5e9c..c6e5e9c5 100644
Binary files a/index.doctree and b/index.doctree differ
diff --git a/index.html b/index.html
index a155a8bd..b601eb0e 100644
--- a/index.html
+++ b/index.html
@@ -1,20 +1,22 @@
-
+
-
+
- Welcome to omc3’s documentation! — omc3 0.11.4 documentation
-
-
-
+ Welcome to omc3’s documentation! — omc3 0.12.0 documentation
+
+
+
+
+
-
+
diff --git a/modules/correction.doctree b/modules/correction.doctree
index 6245b5dc..46cdd8d0 100644
Binary files a/modules/correction.doctree and b/modules/correction.doctree differ
diff --git a/modules/correction.html b/modules/correction.html
index 664b41bd..2089bcec 100644
--- a/modules/correction.html
+++ b/modules/correction.html
@@ -1,20 +1,22 @@
-
+
-
+
- Correction — omc3 0.11.4 documentation
-
-
-
+ Correction — omc3 0.12.0 documentation
+
+
+
+
+
-
+
@@ -355,7 +357,7 @@ Response MAD-X
-omc3.correction.response_madx.create_fullresponse(accel_inst: Accelerator, variable_categories: Sequence[str], delta_k: float = 2e-05, num_proc: int = 2, temp_dir: Path | None = None) Dict[str, DataFrame][source]
+omc3.correction.response_madx.create_fullresponse(accel_inst: Accelerator, variable_categories: Sequence[str], delta_k: float = 2e-05, num_proc: int = 4, temp_dir: Path | None = None) Dict[str, DataFrame][source]
Generate a dictionary containing response matrices for
beta, phase, dispersion, tune and coupling and saves it to a file.
@@ -450,14 +452,14 @@ Response TWISS\(\Delta \Phi_{z,wj}\) needs to be multiplied by \(2\pi\) to be consistent.
References