Atomiq component creator¶

A helper program to create components for the components db dictionary.

A helper program to create component db device chains

usage: atomiq_component_creator [-h] [-A ABBREVIATIONS] [-c CONFIG_FILE]
                                [-m COMPONENT_MODULES [COMPONENT_MODULES ...]]
                                [-d]
                                {template,class} ...

Positional Arguments¶

command: Possible choices: template, class

Named Arguments¶

-A, --abbreviations

Abbreviation dictionary. Default is {'Photodiode': 'pd', 'LightModulator': 'lm', 'LaserSource': 'laser', 'RFSource': 'rf', 'ADCChannel': 'adc'}. Overrides dict given in a config file (-c)

-c, --config-file

Specify a config file in toml format. Searches for 'atomiq_tools.toml' by default

-m, --component-modules

Specify additional modules to search for components. Default is [atomiq.components]

-d, --debug

Enable debug mode

Default: False

Sub-commands¶

template¶

create component chain from template

atomiq_component_creator template [-h] [-A ABBREVIATIONS] [-c CONFIG_FILE]
                                  [-m COMPONENT_MODULES [COMPONENT_MODULES ...]]
                                  [-d]
                                  filename

Positional Arguments¶

filename

Named Arguments¶

-A, --abbreviations

Abbreviation dictionary. Default is {'Photodiode': 'pd', 'LightModulator': 'lm', 'LaserSource': 'laser', 'RFSource': 'rf', 'ADCChannel': 'adc'}. Overrides dict given in a config file (-c)

-c, --config-file

Specify a config file in toml format. Searches for 'atomiq_tools.toml' by default

-m, --component-modules

Specify additional modules to search for components. Default is [atomiq.components]

-d, --debug

Enable debug mode

Default: False

class¶

start new component chain from a target component class

atomiq_component_creator class [-h] [-A ABBREVIATIONS] [-c CONFIG_FILE]
                               [-m COMPONENT_MODULES [COMPONENT_MODULES ...]]
                               [-d]
                               comp_class name

Positional Arguments¶

comp_class: Full path of the target component class (e.g. atomiq.components.sinara.suservo.SUServoModulatedLaser)
name: Name of the component

Named Arguments¶

-A, --abbreviations

Abbreviation dictionary. Default is {'Photodiode': 'pd', 'LightModulator': 'lm', 'LaserSource': 'laser', 'RFSource': 'rf', 'ADCChannel': 'adc'}. Overrides dict given in a config file (-c)

-c, --config-file

Specify a config file in toml format. Searches for 'atomiq_tools.toml' by default

-m, --component-modules

Specify additional modules to search for components. Default is [atomiq.components]

-d, --debug

Enable debug mode

Default: False