dodal.beamlines

Modules

Functions

all_beamline_modules()	Get the names of all importable modules in beamlines
all_beamline_names()	Get the names of all beamlines as per the ${BEAMLINE} environment variable
module_name_for_beamline(beamline)	Get the module name for a particular beamline, it may differ from the beamline name e.g. i04-1 -> i04_1.

dodal.beamlines.all_beamline_modules() → Iterable[str]

Get the names of all importable modules in beamlines

Returns:

Generator of beamline module names

Return type:

Iterable[str]

dodal.beamlines.all_beamline_names() → Iterable[str]

Get the names of all beamlines as per the ${BEAMLINE} environment variable

Returns:

Generator of beamline names that dodal supports

Return type:

Iterable[str]

dodal.beamlines.module_name_for_beamline(beamline: str) → str

Get the module name for a particular beamline, it may differ from the beamline name e.g. i04-1 -> i04_1

Parameters:

beamline (str) – The beamline name as per the ${BEAMLINE} environment variable

Returns:

The importable module name

Return type:

str