+[docs]
+@entrypoint(
get_params(), strict=True,
argument_parser_args=dict(
epilog=USAGE_EXAMPLES,
@@ -468,9 +476,12 @@
+
# State Extraction -------------------------------------------------------------
-
Source code for omc3.knob_extractor
return knobs_extract[docs]def get_state(ldb, time: datetime) -> Dict[str, str]:
+
+[docs]
+def get_state(ldb, time: datetime) -> Dict[str, str]:
"""
Standalone function to gather and log state data from the StateTracker.
@@ -491,6 +502,7 @@
+
def _get_state_as_df(state_dict: Dict[str, str], time: datetime) -> tfs.TfsDataFrame:
"""
Convert extracted StateTracker state-data into a TfsDataFrame
@@ -514,7 +526,9 @@
Source code for omc3.knob_extractor
return state_dictSource code for omc3.knob_extractor
# Knobs Extraction -------------------------------------------------------------
-[docs]def extract(ldb, knobs: Sequence[str], time: datetime) -> Dict[str, float]:
+
+[docs]
+def extract(ldb, knobs: Sequence[str], time: datetime) -> Dict[str, float]:
"""
Standalone function to gather data from the StateTracker.
Extracts data via pytimber's LoggingDB for the knobs given
@@ -559,7 +573,10 @@ Source code for omc3.knob_extractor
return knobs_extracted
-[docs]def check_for_undefined_knobs(knobs_definitions: pd.DataFrame, knob_categories: Sequence[str]):
+
+
+[docs]
+def check_for_undefined_knobs(knobs_definitions: pd.DataFrame, knob_categories: Sequence[str]):
""" Check that all knobs are actually defined in the knobs-definitions.
@@ -580,6 +597,7 @@ Source code for omc3.knob_extractor
)
+
def _extract_and_gather(ldb, knobs_definitions: pd.DataFrame,
knob_categories: Sequence[str],
time: datetime) -> tfs.TfsDataFrame:
@@ -663,7 +681,9 @@ Source code for omc3.knob_extractor
raise FileNotFoundError("None of the knobs-definition files are available.")
-[docs]def load_knobs_definitions(file_path: Union[Path, str]) -> pd.DataFrame:
+
+[docs]
+def load_knobs_definitions(file_path: Union[Path, str]) -> pd.DataFrame:
""" Load the knobs-definition file and convert into a DataFrame.
Each line in this file should consist of at least three comma separated
entries in the following order: madx-name, lsa-name, scaling factor.
@@ -694,6 +714,7 @@ Source code for omc3.knob_extractor
return _to_knobs_dataframe(df)
+
def _to_knobs_dataframe(df: pd.DataFrame) -> pd.DataFrame:
""" Adapts a DataFrame to the conventions used here:
StateTracker variable name as index, all columns lower-case.
@@ -786,16 +807,22 @@ Source code for omc3.knob_extractor
# Other tools ------------------------------------------------------------------
-[docs]def lsa2name(lsa_name: str) -> str:
+
+[docs]
+def lsa2name(lsa_name: str) -> str:
"""LSA name -> Variable in Timber/StateTracker conversion."""
return lsa_name.replace("/", ":")
-[docs]def name2lsa(name: str) -> str:
+
+
+[docs]
+def name2lsa(name: str) -> str:
"""Variable in Timber/StateTracker -> LSA name conversion."""
return name.replace(":", "/")
+
if __name__ == "__main__":
main()
diff --git a/_modules/omc3/madx_wrapper.html b/_modules/omc3/madx_wrapper.html
index 72e7eff3..c3d5abf0 100644
--- a/_modules/omc3/madx_wrapper.html
+++ b/_modules/omc3/madx_wrapper.html
@@ -11,11 +11,11 @@
-
-
-
-
-
+
+
+
+
+
@@ -241,10 +241,13 @@ Source code for omc3.madx_wrapper
warnings.simplefilter('always', DeprecationWarning)
-[docs]class MadxError(Exception):
+
+
def madx_wrapper_params():
params = EntryPointParameters()
params.add_parameter(
@@ -283,7 +286,9 @@ Source code for omc3.madx_wrapper
)
-[docs]def run_file(input_file: Path, output_file: Path = None, log_file: Path = None,
+
+[docs]
+def run_file(input_file: Path, output_file: Path = None, log_file: Path = None,
madx_path: Path = MADX_PATH, cwd: Path = None):
"""
Runs ``MAD-X`` on a given script in a subprocess.
@@ -299,7 +304,10 @@ Source code for omc3.madx_wrapper
madx_path=madx_path, cwd=cwd)
-[docs]def run_string(input_string: str,
+
+
+[docs]
+def run_string(input_string: str,
output_file: Path = None, log_file: Path = None,
madx_path: Path = MADX_PATH, cwd: Path = None):
"""
@@ -315,6 +323,7 @@ Source code for omc3.madx_wrapper
_run(input_string, log_file, output_file, madx_path, cwd)
+
def _run(full_madx_script, log_file=None, output_file=None, madx_path=MADX_PATH, cwd=None):
"""Starts the ``MAD-X`` process."""
with _madx_input_wrapper(full_madx_script, output_file) as madx_jobfile:
diff --git a/_modules/omc3/model/accelerators/accelerator.html b/_modules/omc3/model/accelerators/accelerator.html
index 0dd0ea27..9ce5bc9b 100644
--- a/_modules/omc3/model/accelerators/accelerator.html
+++ b/_modules/omc3/model/accelerators/accelerator.html
@@ -11,11 +11,11 @@
-
-
-
-
-
+
+
+
+
+
@@ -248,7 +248,9 @@ Source code for omc3.model.accelerators.accelerator
DRIVEN_EXCITATIONS = dict(acd=AccExcitationMode.ACD, adt=AccExcitationMode.ADT)
-[docs]class AccElementTypes:
+
+[docs]
+class AccElementTypes:
"""Defines the strings for the element types ``BPMS``, ``MAGNETS`` and ``ARC_BPMS``."""
BPMS = "bpm"
@@ -256,7 +258,10 @@ Source code for omc3.model.accelerators.accelerator
ARC_BPMS = "arc_bpm"
-[docs]class Accelerator:
+
+
+[docs]
+class Accelerator:
"""
Abstract class to serve as an interface to implement the rest of the accelerators.
"""
@@ -411,7 +416,9 @@ Source code for omc3.model.accelerators.accelerator
# Class methods ###########################################
-[docs] @classmethod
+
+[docs]
+ @classmethod
def get_element_types_mask(cls, list_of_elements: List[str], types) -> numpy.ndarray:
"""
Returns a boolean mask for elements in ``list_of_elements`` that belong to any of the
@@ -434,7 +441,10 @@ Source code for omc3.model.accelerators.accelerator
mask = mask | series.str.match(cls.RE_DICT[ty], case=False)
return mask.to_numpy()
-[docs] @classmethod
+
+
+[docs]
+ @classmethod
def get_variables(cls, frm=None, to=None, classes=None):
"""
Gets the variables with elements in the given range and the given classes. ``None`` means
@@ -442,7 +452,10 @@ Source code for omc3.model.accelerators.accelerator
"""
raise NotImplementedError("A function should have been overwritten, check stack trace.")
-[docs] @classmethod
+
+
+[docs]
+ @classmethod
def get_correctors_variables(cls, frm=None, to=None, classes=None):
"""
Returns the set of corrector variables between ``frm`` and ``to``, with classes in
@@ -450,6 +463,7 @@ Source code for omc3.model.accelerators.accelerator
"""
raise NotImplementedError("A function should have been overwritten, check stack trace.")
+
@property
def beam_direction(self) -> int:
return self._beam_direction
@@ -460,13 +474,18 @@ Source code for omc3.model.accelerators.accelerator
raise AcceleratorDefinitionError("Beam direction has to be either 1 or -1")
self._beam_direction = value
-[docs] def verify_object(self):
+
+[docs]
+ def verify_object(self):
"""
Verifies that this instance of an `Accelerator` is properly instantiated.
"""
raise NotImplementedError("A function should have been overwritten, check stack trace.")
-[docs] def get_exciter_bpm(self, plane: str, commonbpms: List[str]):
+
+
+[docs]
+ def get_exciter_bpm(self, plane: str, commonbpms: List[str]):
"""
Returns the BPM next to the exciter.
The `Accelerator` instance knows already which excitation method is used.
@@ -480,6 +499,7 @@ Source code for omc3.model.accelerators.accelerator
"""
raise NotImplementedError("A function should have been overwritten, check stack trace.")
+
def important_phase_advances(self):
return []
@@ -489,7 +509,9 @@ Source code for omc3.model.accelerators.accelerator
raise AttributeError("No driven model given in this accelerator instance.")
return self._model_driven
-[docs] @classmethod
+
+[docs]
+ @classmethod
def get_dir(cls) -> Path:
"""Default directory for accelerator. Should be overwritten if more specific."""
dir_path = CURRENT_DIR / cls.NAME
@@ -497,7 +519,10 @@ Source code for omc3.model.accelerators.accelerator
return dir_path
raise NotImplementedError(f"No directory for accelerator {cls.NAME} available.")
-[docs] @classmethod
+
+
+[docs]
+ @classmethod
def get_file(cls, filename: str) -> Path:
"""Default location for accelerator files. Should be overwritten if more specific."""
file_path = CURRENT_DIR / cls.NAME / filename
@@ -507,25 +532,35 @@ Source code for omc3.model.accelerators.accelerator
f"File {file_path.name} not available for accelerator {cls.NAME}."
)
+
# Jobs ###################################################################
-[docs] def get_update_correction_script(self, outpath: Union[Path, str], corr_files: Sequence[Union[Path, str]]) -> str:
+
+[docs]
+ def get_update_correction_script(self, outpath: Union[Path, str], corr_files: Sequence[Union[Path, str]]) -> str:
"""
Returns job (string) to create an updated model from changeparameters input (used in
iterative correction).
"""
raise NotImplementedError("A function should have been overwritten, check stack trace.")
-[docs] def get_base_madx_script(self, best_knowledge=False):
+
+
+[docs]
+ def get_base_madx_script(self, best_knowledge=False):
"""
Returns job (string) to create the basic accelerator sequence.
"""
- raise NotImplementedError("A function should have been overwritten, check stack trace.")
+ raise NotImplementedError("A function should have been overwritten, check stack trace.")
+
+
##########################################################################
-[docs]class Variable:
+
+[docs]
+class Variable:
"""
Generic corrector variable class that holds `name`, `position (s)` and physical elements it
affects. These variables should be logical variables that have and effect in the model if
@@ -538,7 +573,10 @@ Source code for omc3.model.accelerators.accelerator
self.classes = classes
-[docs]class Element:
+
+
+[docs]
+class Element:
"""
Generic corrector element class that holds `name` and `position (s)` of the corrector. This
element should represent a physical element of the accelerator.
@@ -549,7 +587,10 @@ Source code for omc3.model.accelerators.accelerator
self.s = s
-[docs]class AcceleratorDefinitionError(Exception):
+
+
+[docs]
+class AcceleratorDefinitionError(Exception):
"""
Raised when an `Accelerator` instance is wrongly used, for example by calling a method that
should have been overwritten.
@@ -558,6 +599,7 @@ Source code for omc3.model.accelerators.accelerator
pass
+
# Helper ----
diff --git a/_modules/omc3/model/accelerators/esrf.html b/_modules/omc3/model/accelerators/esrf.html
index d6a01e99..b4e600e6 100644
--- a/_modules/omc3/model/accelerators/esrf.html
+++ b/_modules/omc3/model/accelerators/esrf.html
@@ -11,11 +11,11 @@
-
-
-
-
-
+
+
+
+
+
@@ -265,7 +265,9 @@ Source code for omc3.model.accelerators.esrf
from omc3.model.accelerators.accelerator import AccElementTypes, Accelerator
-[docs]class Esrf(Accelerator):
+
+[docs]
+class Esrf(Accelerator):
NAME = "esrf"
RE_DICT = {AccElementTypes.BPMS: r"BPM",
AccElementTypes.MAGNETS: r".*",
@@ -276,6 +278,7 @@ Source code for omc3.model.accelerators.esrf
parser = EntryPoint(self.get_parameters(), strict=True)
opt = parser.parse(*args, **kwargs)
super().__init__(opt)
+
diff --git a/_modules/omc3/model/accelerators/iota.html b/_modules/omc3/model/accelerators/iota.html
index c2f8c0ef..4fd5f4e8 100644
--- a/_modules/omc3/model/accelerators/iota.html
+++ b/_modules/omc3/model/accelerators/iota.html
@@ -11,11 +11,11 @@
-
-
-
-
-
+
+
+
+
+
@@ -278,7 +278,9 @@ Source code for omc3.model.accelerators.iota
CURRENT_DIR = os.path.dirname(__file__)
-
diff --git a/_modules/omc3/model/accelerators/lhc.html b/_modules/omc3/model/accelerators/lhc.html
index db68b6fa..2e5aa754 100644
--- a/_modules/omc3/model/accelerators/lhc.html
+++ b/_modules/omc3/model/accelerators/lhc.html
@@ -11,11 +11,11 @@
-
-
-
-
-
+
+
+
+
+
@@ -315,7 +315,9 @@ Source code for omc3.model.accelerators.lhc
LHC_DIR = CURRENT_DIR / "lhc"
-[docs]class Lhc(Accelerator):
+
+[docs]
+class Lhc(Accelerator):
"""
Parent Class for LHC-types.
"""
@@ -365,7 +367,9 @@ Source code for omc3.model.accelerators.lhc
self.beam_direction = beam_to_beam_direction[self.beam]
self.verify_object()
-[docs] def verify_object(self) -> None: # TODO: Maybe more checks?
+
+[docs]
+ def verify_object(self) -> None: # TODO: Maybe more checks?
"""
Verifies if everything is defined which should be defined.
Will Raise an ``AcceleratorDefinitionError`` if one of the checks is invalid.
@@ -389,6 +393,7 @@ Source code for omc3.model.accelerators.lhc
if self.modifiers:
LOGGER.debug(f"Modifiers {', '.join([str(m) for m in self.modifiers])}")
+
@property
def beam(self) -> int:
if self._beam is None:
@@ -408,7 +413,9 @@ Source code for omc3.model.accelerators.lhc
def get_lhc_error_dir() -> Path:
return LHC_DIR / "systematic_errors"
-[docs] def get_variables(self, frm: float = None, to: float = None, classes: Iterable[str] = None):
+
+[docs]
+ def get_variables(self, frm: float = None, to: float = None, classes: Iterable[str] = None):
correctors_dir = LHC_DIR / "2012" / "correctors"
all_vars_by_class = _merge_jsons(
correctors_dir / f"correctors_b{self.beam}" / "beta_correctors.json",
@@ -430,7 +437,10 @@ Source code for omc3.model.accelerators.lhc
# Sort variables by S (nice for comparing different files)
return self.sort_variables_by_location(vars, frm, to)
-[docs] def sort_variables_by_location(self, variables: Iterable[str], frm: float = None, to: str = None) -> List[str]:
+
+
+[docs]
+ def sort_variables_by_location(self, variables: Iterable[str], frm: float = None, to: str = None) -> List[str]:
""" Sorts the variables by location and filters them between `frm` and `to`.
If `frm` is larger than `to` it loops back around to the start the accelerator.
This is a useful function for the LHC that's why it is "public"
@@ -465,7 +475,10 @@ Source code for omc3.model.accelerators.lhc
sorted_vars = sorted_vars + unknown_vars
return sorted_vars
-[docs] def get_ips(self) -> Iterator[Tuple[str]]:
+
+
+[docs]
+ def get_ips(self) -> Iterator[Tuple[str]]:
"""
Returns an iterable with this accelerator's IPs.
@@ -485,6 +498,7 @@ Source code for omc3.model.accelerators.lhc
Lhc.DOROS_IP_BPMS.format(side="R", ip=ip, beam=self.beam),
)
+
def log_status(self) -> None:
LOGGER.info(f" model dir = {self.model_dir}")
LOGGER.info(f"Natural Tune X [{self.nat_tunes[0]:10.3f}]")
@@ -523,7 +537,9 @@ Source code for omc3.model.accelerators.lhc
correctors_dir = LHC_DIR / self.correctors_dir / "correctors"
return correctors_dir / f"corrector_elems_b{self.beam}.tfs"
-[docs] def get_exciter_bpm(self, plane: str, commonbpms: List[str]):
+
+[docs]
+ def get_exciter_bpm(self, plane: str, commonbpms: List[str]):
beam = self.beam
adt = "H.C" if plane == "X" else "V.B"
l_r = "L" if ((beam == 1) != (plane == "Y")) else "R"
@@ -546,6 +562,7 @@ Source code for omc3.model.accelerators.lhc
raise KeyError("ADT BPM not found in the common BPMs. Maybe cleaned?") from e
return None
+
def important_phase_advances(self) -> List[List[str]]:
if self.beam == 2:
return [["MKD.O5R6.B2", "TCTPH.4R1.B2"], ["MKD.O5R6.B2", "TCTPH.4R5.B2"]]
@@ -578,7 +595,9 @@ Source code for omc3.model.accelerators.lhc
)
return info_comments
-[docs] def get_base_madx_script(self, best_knowledge: bool = False) -> str:
+
+[docs]
+ def get_base_madx_script(self, best_knowledge: bool = False) -> str:
ats_md = False
high_beta = False
madx_script = (
@@ -639,13 +658,17 @@ Source code for omc3.model.accelerators.lhc
return madx_script
-[docs] def get_update_correction_script(self, outpath: Union[Path, str], corr_files: Sequence[Union[Path, str]]) -> str:
+
+
+[docs]
+ def get_update_correction_script(self, outpath: Union[Path, str], corr_files: Sequence[Union[Path, str]]) -> str:
madx_script = self.get_base_madx_script()
for corr_file in corr_files:
madx_script += f"call, file = '{str(corr_file)}';\n"
madx_script += f"exec, do_twiss_elements(LHCB{self.beam}, '{str(outpath)}', {self.dpp});\n"
return madx_script
+
def _uses_ats_knobs(self) -> bool:
"""
Returns wether the ATS knobs and macros should be used, based on the instance's year.
@@ -665,6 +688,7 @@ Source code for omc3.model.accelerators.lhc
except ValueError: # if a "hllhc1.x" year is given
return False
+
# General functions ##########################################################
diff --git a/_modules/omc3/model/accelerators/petra.html b/_modules/omc3/model/accelerators/petra.html
index 7268401d..81f00bb8 100644
--- a/_modules/omc3/model/accelerators/petra.html
+++ b/_modules/omc3/model/accelerators/petra.html
@@ -11,11 +11,11 @@
-
-
-
-
-
+
+
+
+
+
@@ -219,18 +219,27 @@ Source code for omc3.model.accelerators.petra
EXCITER_BPM = "BPM_SOR_13"
-[docs]class Petra(Accelerator):
+
+[docs]
+class Petra(Accelerator):
NAME = "petra"
# Public Methods ##########################################################
-[docs] def verify_object(self): # TODO: Maybe more checks?
+
+[docs]
+ def verify_object(self): # TODO: Maybe more checks?
if self.model_dir is None: # is the class is used to create full response?
raise AcceleratorDefinitionError("PETRA doesn't have a model creation yet, calling it this "
"way is most probably wrong.")
-[docs] def get_exciter_bpm(self, plane, commonbpms):
- return [list(commonbpms).index(EXCITER_BPM), EXCITER_BPM], f"KIFB{PLANE_TO_HV[plane]}N"
+
+
+[docs]
+ def get_exciter_bpm(self, plane, commonbpms):
+ return [list(commonbpms).index(EXCITER_BPM), EXCITER_BPM], f"KIFB{PLANE_TO_HV[plane]}N"
+
+
diff --git a/_modules/omc3/model/accelerators/ps.html b/_modules/omc3/model/accelerators/ps.html
index bb19439a..a635cc69 100644
--- a/_modules/omc3/model/accelerators/ps.html
+++ b/_modules/omc3/model/accelerators/ps.html
@@ -11,11 +11,11 @@
-
-
-
-
-
+
+
+
+
+
@@ -272,7 +272,9 @@ Source code for omc3.model.accelerators.ps
CURRENT_DIR = Path(__file__).parent
-[docs]class Ps(Accelerator):
+
+[docs]
+class Ps(Accelerator):
"""Parent Class for PS-types."""
NAME = "ps"
RE_DICT = {AccElementTypes.BPMS: r"PR\.BPM",
@@ -299,13 +301,21 @@ Source code for omc3.model.accelerators.ps
super().__init__(opt)
self.year = opt.year
-[docs] def verify_object(self):
+
-[docs] def get_dir(self):
+
+
-[docs] def get_file(self, filename: str) -> Path:
+
+
+[docs]
+ def get_file(self, filename: str) -> Path:
"""Get filepaths for PS files."""
ps_dir = CURRENT_DIR / self.NAME
ps_year_dir = self.get_dir()
@@ -319,7 +329,10 @@ Source code for omc3.model.accelerators.ps
f"File {file_path.name} not available for accelerator {self.NAME}."
)
-[docs] def get_exciter_bpm(self, plane, bpms):
+
+
+[docs]
+ def get_exciter_bpm(self, plane, bpms):
if not self.excitation:
return None
bpms_to_find = ["PR.BPM00", "PR.BPM03"]
@@ -328,7 +341,10 @@ Source code for omc3.model.accelerators.ps
raise KeyError
return (list(bpms).index(found_bpms[0]), found_bpms[0]), f"{PLANE_TO_HV[plane]}ACMAP"
-[docs] def get_base_madx_script(self, best_knowledge=False):
+
+
+[docs]
+ def get_base_madx_script(self, best_knowledge=False):
if best_knowledge:
raise NotImplementedError(f"Best knowledge model not implemented for accelerator {self.NAME}")
@@ -351,7 +367,9 @@ Source code for omc3.model.accelerators.ps
replace_dict["DRV_TUNE_X"] = self.drv_tunes[0]
replace_dict["DRV_TUNE_Y"] = self.drv_tunes[1]
mask = self.get_file('base.mask').read_text()
- return mask % replace_dict
+ return mask % replace_dict
+
+
class _PsSegmentMixin(object):
diff --git a/_modules/omc3/model/accelerators/psbooster.html b/_modules/omc3/model/accelerators/psbooster.html
index b624c255..98dc57ea 100644
--- a/_modules/omc3/model/accelerators/psbooster.html
+++ b/_modules/omc3/model/accelerators/psbooster.html
@@ -11,11 +11,11 @@
-
-
-
-
-
+
+
+
+
+
@@ -281,7 +281,9 @@ Source code for omc3.model.accelerators.psbooster
CURRENT_DIR = Path(__file__).parent
-[docs]class Psbooster(Accelerator):
+
+[docs]
+class Psbooster(Accelerator):
"""Parent Class for Psbooster-types."""
NAME = "psbooster"
RE_DICT = {AccElementTypes.BPMS: r"BR\d\.BPM[^T]",
@@ -314,13 +316,18 @@ Source code for omc3.model.accelerators.psbooster
raise AcceleratorDefinitionError("Ring parameter has to be one of (1, 2, 3, 4)")
self._ring = value
-[docs] def verify_object(self):
+
+[docs]
+ def verify_object(self):
_ = self.ring
if self.modifiers:
raise AcceleratorDefinitionError(f"Accelerator {self.NAME} cannot handle modifiers,"
f" yet modifiers were given.")
-[docs] def get_exciter_bpm(self, plane, bpms):
+
+
+[docs]
+ def get_exciter_bpm(self, plane, bpms):
if not self.excitation:
return None
bpms_to_find = [f"BR{self.ring}.BPM3L3", f"BR{self.ring}.BPM4L3"]
@@ -329,7 +336,10 @@ Source code for omc3.model.accelerators.psbooster
raise KeyError
return (list(bpms).index(found_bpms[0]), found_bpms[0]), f"{PLANE_TO_HV[plane]}ACMAP"
-[docs] def get_base_madx_script(self, best_knowledge=False):
+
+
+[docs]
+ def get_base_madx_script(self, best_knowledge=False):
if best_knowledge:
raise NotImplementedError(f"Best knowledge model not implemented for accelerator {self.NAME}")
@@ -348,7 +358,9 @@ Source code for omc3.model.accelerators.psbooster
replace_dict["DRV_TUNE_X"] = self.drv_tunes[0]
replace_dict["DRV_TUNE_Y"] = self.drv_tunes[1]
mask = self.get_file('base.mask').read_text()
- return mask % replace_dict
+ return mask % replace_dict
+
+
class _PsboosterSegmentMixin(object):
diff --git a/_modules/omc3/model/accelerators/skekb.html b/_modules/omc3/model/accelerators/skekb.html
index f934c93d..14b67197 100644
--- a/_modules/omc3/model/accelerators/skekb.html
+++ b/_modules/omc3/model/accelerators/skekb.html
@@ -11,11 +11,11 @@
-
-
-
-
-
+
+
+
+
+
@@ -279,7 +279,9 @@ Source code for omc3.model.accelerators.skekb
LOGGER = logging_tools.get_logger(__name__)
-[docs]class SKekB(Accelerator):
+
+[docs]
+class SKekB(Accelerator):
"""KEK's SuperKEKB accelerator."""
NAME = "skekb"
RINGS = ("ler", "her")
@@ -312,10 +314,14 @@ Source code for omc3.model.accelerators.skekb
raise AcceleratorDefinitionError("Ring parameter has to be one of ('ler', 'her')")
self._ring = value
-[docs] def verify_object(self):
+
+[docs]
+ def verify_object(self):
if self.model_dir is None: # is the class is used to create full response?
raise AcceleratorDefinitionError("SuperKEKB doesn't have a model creation, "
- "calling it this way is most probably wrong.")
+ "calling it this way is most probably wrong.")
+
+
diff --git a/_modules/omc3/model/manager.html b/_modules/omc3/model/manager.html
index de9f9612..5ba9fb4d 100644
--- a/_modules/omc3/model/manager.html
+++ b/_modules/omc3/model/manager.html
@@ -11,11 +11,11 @@
-
-
-
-
-
+
+
+
+
+
@@ -235,7 +235,9 @@ Source code for omc3.model.manager
return params
-[docs]@entrypoint(_get_params())
+
+[docs]
+@entrypoint(_get_params())
def get_accelerator(opt, other_opt):
"""
Returns the `Accelerator` instance of the desired accelerator, as given at the commandline.
@@ -246,13 +248,17 @@ Source code for omc3.model.manager
return ACCELS[opt.accel](other_opt)
-[docs]@entrypoint(_get_params())
+
+
+[docs]
+@entrypoint(_get_params())
def get_parsed_opt(opt, other_opt):
"""Get all accelerator related options as a `dict`."""
accel = ACCELS[opt.accel]
parser = EntryPoint(accel.get_parameters(), strict=True)
accel_opt = parser.parse(other_opt)
return {**opt, **accel_opt}
+
diff --git a/_modules/omc3/model/model_creators/lhc_model_creator.html b/_modules/omc3/model/model_creators/lhc_model_creator.html
index 96bae665..ae490f06 100644
--- a/_modules/omc3/model/model_creators/lhc_model_creator.html
+++ b/_modules/omc3/model/model_creators/lhc_model_creator.html
@@ -11,11 +11,11 @@
-
-
-
-
-
+
+
+
+
+
@@ -253,8 +253,12 @@ Source code for omc3.model.model_creators.lhc_model_creator
return cols_outer[:42] + cols_middle + cols_outer[42:]
-[docs]class LhcModelCreator(ModelCreator):
-[docs] @classmethod
+
+[docs]
+class LhcModelCreator(ModelCreator):
+
+[docs]
+ @classmethod
def get_madx_script(cls, accel: Lhc) -> str: # nominal
use_acd = "1" if (accel.excitation == AccExcitationMode.ACD) else "0"
use_adt = "1" if (accel.excitation == AccExcitationMode.ADT) else "0"
@@ -275,7 +279,10 @@ Source code for omc3.model.model_creators.lhc_model_creator
)
return madx_script
-