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.

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.

Model(source[, choppers, detectors])

A class that represents a neutron instrument.

ReadingField(data, dim)

Result(source, choppers, detectors)

Result of a simulation.

Source(facility[, neutrons, pulses, ...])

A class that represents a source of neutrons.

SourceParameters(data, facility, neutrons, ...)

Read-only container for the parameters of a source.

Top-level functions#

Submodules#