compare_beam_calculators module

Define an utility function to compare two BeamCalculator.

Todo

Allow for undetermined number of BeamCalculator in the config, and update here.

output_comparison(sim_1: SimulationOutput, sim_2: SimulationOutput, element: Element | str, qty: str, single_value: bool, **kwargs) → str

Compare two simulation outputs.

Parameters:

• sim1 (SimulationOutput) – Objects to compate.

• sim2 (SimulationOutput) – Objects to compate.

• element (Element | str) – Element at which look for qty.

• qty (str) – Quantity that will be compared.

• single_value (bool) – True if a single value is expected, False if it is an array.

Returns:

msg – Holds requested information.

Return type:

str

compare_beam_calculators(toml_filepath: Path, toml_keys: dict[str, str], tests: Collection[dict[str, str | bool | Element]]) → None

Compute beam with two beam calculators and compare them.

Parameters:

• toml_filepath (pathlib.Path) – Path to the configuration file.

• toml_keys (dict[str, str]) – Keys in the configuration file.

• tests (Collection[dict[str, str | bool]]) – kwargs for the output_comparison().