chess_scanparsers

Submodules

Package Contents

Functions

choose_scanparser

Return the best subclass of ScanParser to use for a scan taken at the specified station and belonging to the specified experiment type.

Data

version

API

chess_scanparsers.version

‘PACKAGE_VERSION’

chess_scanparsers.choose_scanparser(station, experiment)

Return the best subclass of ScanParser to use for a scan taken at the specified station and belonging to the specified experiment type.

Parameters:
  • station (Literal['id1a3', 'id3a', 'id3b', 'id4b']) – The name of the station at which the scan was collected.

  • experiment (Literal[‘edd’, ‘giwaxs’, ‘saxswaxs’, ‘powder’, ‘tomo’, ‘xrf’, ‘n/a’]) – Type of X-ray measurement to which this scan belongs.

Returns:

The most appropriate type of ScanParser to use.

Return type:

type