tof.Model

class tof.Model(source, choppers=None, detectors=None)

A class that represents a neutron instrument. It is defined by a list of choppers, a list of detectors, and a source.

Parameters:

• choppers (Union[Chopper, list[Chopper], tuple[Chopper, ...], None], default: None) – A list of choppers.

• detectors (Union[Detector, list[Detector], tuple[Detector, ...], None], default: None) – A list of detectors.

• source (Source) – A source of neutrons.

__init__(source, choppers=None, detectors=None)

Methods

__init__(source[, choppers, detectors])
add(component)	Add a component to the instrument.
remove(name)	Remove a component.
run()	Run the simulation.

add(component)

Add a component to the instrument. Component names must be unique across choppers and detectors.

Parameters:

component – A chopper or detector.

remove(name)

Remove a component.

Parameters:

name (str) – The name of the component to remove.

run()

Run the simulation.