atomiq.frontend.atomiq_master

Attributes

Functions

argument_factory(arg_description)

Instantiate a ScanObject or BooleanValue, StringValue etc from type and default arguments

export_deprecated_flag(value, flag, env_var)

Export the value of a deprecated command line flag as an environment variable.

export_heros_connect(connect)

Export the deprecated --heros-connect endpoint as HEROS_ZENOH_CONNECT.

export_heros_realm(realm)

Export the deprecated --heros-realm realm as HEROS_REALM.

get_argparser()

We extend the artiq master argparser

Module Contents

atomiq.frontend.atomiq_master.argument_factory(arg_description)[source]

Instantiate a ScanObject or BooleanValue, StringValue etc from type and default arguments

Parameters:

arg_description (dict)

atomiq.frontend.atomiq_master.export_deprecated_flag(value, flag, env_var)[source]

Export the value of a deprecated command line flag as an environment variable.

An environment variable that is already set takes precedence. ARTIQ workers are subprocesses of the master and inherit the variable.

Parameters:
  • value (str | None) -- value given to the flag, or None if the flag is not given

  • flag (str) -- name of the deprecated flag, used in the warnings

  • env_var (str) -- environment variable that replaces the flag

Return type:

None

atomiq.frontend.atomiq_master.export_heros_connect(connect)[source]

Export the deprecated --heros-connect endpoint as HEROS_ZENOH_CONNECT.

Parameters:

connect (str | None) -- zenoh endpoint given to --heros-connect, or None if the flag is not given

Return type:

None

atomiq.frontend.atomiq_master.export_heros_realm(realm)[source]

Export the deprecated --heros-realm realm as HEROS_REALM.

Parameters:

realm (str | None) -- realm given to --heros-realm, or None if the flag is not given

Return type:

None

atomiq.frontend.atomiq_master._instance_name = None
atomiq.frontend.atomiq_master._artiq_get_argparser
atomiq.frontend.atomiq_master.get_argparser()[source]

We extend the artiq master argparser