ess.reduce.time_of_flight.simulation.simulate_beamline#

ess.reduce.time_of_flight.simulation.simulate_beamline(*, choppers, source_position, neutrons=1000000, pulses=1, seed=None, facility='ess')[source]#

Simulate a pulse of neutrons propagating through a chopper cascade using the tof package (https://tof.readthedocs.io).

Parameters:

  • choppers (Mapping[str, DiskChopper]) – A dict of DiskChopper objects representing the choppers in the beamline. See https://scipp.github.io/scippneutron/user-guide/chopper/processing-nexus-choppers.html#Build-DiskChopper for more information.

  • source_position (Variable) – A scalar variable with dtype=vector3 that defines the source position. Must be in the same coordinate system as the choppers’ axle positions.

  • neutrons (int, default: 1000000) – Number of neutrons to simulate.

  • pulses (int, default: 1) – Number of pulses to simulate.

  • seed (Optional[int], default: None) – Seed for the random number generator used in the simulation.

  • facility (str, default: 'ess') – Facility where the experiment is performed.

Return type:

SimulationResults