API Reference#

Classes#

`Chopper`(*, frequency, distance, name[, ...])	A chopper is a rotating device with cutouts that blocks the beam at certain times.
`ChopperReading`(distance, name, frequency, ...)	Read-only container for the neutrons that reach the chopper.
`Component`()
`ComponentReading`()	Data reading for a component placed in the beam path.
`Dashboard`()	An interactive app that allows to add choppers and detectors in a widget-powered dashboard.
`Detector`(distance, name)	A detector component does not block any neutrons, it sees all neutrons passing through it.
`DetectorReading`(distance, name, data)	Read-only container for the neutrons that reach the detector.
`InelasticSample`(distance, name, delta_e)	An inelastic sample component changes the energy of the neutrons that pass through it, but does not block any.
`Model`([source, components, choppers, detectors])	A class that represents a neutron instrument.
`ReadingField`(data, dim)
`Result`(source, readings)	Result of a simulation.
`Source`(facility[, neutrons, pulses, wmin, ...])	A class that represents a source of neutrons.
`SourceReading`(data, facility, neutrons, ...)	Read-only container for the parameters of a source.

`facilities`
`utils`