atip.load_sim#

Module responsible for handling the loading of simulator data sources.

Members

load

Load simulator data sources onto the lattice and its elements.

load_from_filepath

Load simulator data sources onto the lattice and its elements.

atip.load_sim.load_from_filepath(pytac_lattice, at_lattice_filepath, sim_params=None, callback=None)[source]#

Load simulator data sources onto the lattice and its elements.

Parameters:
  • pytac_lattice (pytac.lattice.Lattice) – An instance of a Pytac lattice.

  • at_lattice_filepath (str) – The path to a .mat file from which the Accelerator Toolbox lattice can be loaded.

  • sim_params (SimParams | None) – An optional dataclass containing the pyAT simulation parameters to use.

  • callback (Callable) – To be called after completion of each round of physics calculations.

Returns:

The same Pytac lattice object, but now with a simulator data source fully loaded onto it.

Return type:

pytac.lattice.Lattice

atip.load_sim.load(pytac_lattice, at_lattice, sim_params=None, callback=None)[source]#

Load simulator data sources onto the lattice and its elements.

Parameters:
  • pytac_lattice (pytac.lattice.Lattice) – An instance of a Pytac lattice.

  • at_lattice (at.lattice_object.Lattice) – An instance of an AT lattice object.

  • sim_params (SimParams | None) – An optional dataclass containing the pyAT simulation parameters to use.

  • callback (Callable) – To be called after completion of each round of physics calculations.

Returns:

The same Pytac lattice object, but now with a simulator data source fully loaded onto it.

Return type:

pytac.lattice.Lattice