REDAC Command Line Interface

The REDAC command line interface allows you to configure and use a REDAC from your command line without writing any custom code.

pybrid redac

Entrypoint for all REDAC commands.

Use pybrid redac --help to list all available sub-commands.

pybrid redac [OPTIONS] COMMAND [ARGS]...

Options

-h, --host <hosts>: Network name or address of the REDAC. Or address range to use for auto-detection.

-p, --port <port>: Network port of the REDAC.

--reset, --no-reset

Whether to reset the REDAC after connecting.

Default:: True

--fake

Whether to fake any communication, allowing you to run without any computer present.

Default:: False

display

Display the hardware structure of the REDAC.

pybrid redac display [OPTIONS]

get-entity-config

Get the configuration of an entity.

PATH is the unique path of the entity.

pybrid redac get-entity-config [OPTIONS] PATH

Options

-r, --recursive <recursive>: Whether to get config recursively for sub-entities.

Arguments

PATH: Required argument

get-entity-status

Get the status of an entity.

PATH is the unique path of the entity.

pybrid redac get-entity-status [OPTIONS] PATH

Options

-r, --recursive <recursive>: Whether to get status recursively for sub-entities.

Arguments

PATH: Required argument

get-system-temperatures

pybrid redac get-system-temperatures [OPTIONS]

hack

Collects ‘hack’ commands, for development purposes only.

pybrid redac hack [OPTIONS] COMMAND [ARGS]...

power-up

Automate the current hack-power-up sequence, which is believed to be necessary to get the system in a fully functional state.

pybrid redac hack power-up [OPTIONS] [PATH]

Arguments

PATH: Optional argument

monitor

pybrid redac monitor [OPTIONS]

Options

-o, --output <output>: File to write data to.

proxy

pybrid redac proxy [OPTIONS] [HOST] [PORT]

Options

-m, --map <map_>: Required JSON file containing the mapping of ‘XX-00-WW-00-00-NN’ virtual mac addresses to real ones.

-p, --partitioning <partitioning_>: Required JSON file containing the definition of the machine partitioning.

--partitioning-mode <partitioning_mode>

Arguments

HOST: Optional argument

PORT: Optional argument

reset

Reset the REDAC to initial configuration.

pybrid redac reset [OPTIONS]

Options

--keep-calibration <keep_calibration>: Whether to keep calibration.

--sync, --no-sync: Whether to immediately sync configuration to hardware.

route

Route a signal on one cluster from one output of one M-Block through the U-Block, a coefficient on the C-Block, through the I-Block and back to one input of one M-Block.

PATH is the unique path of the entity. M_OUT is the M-Block signal output index. U_OUT is the U-Block signal output index (equals coefficient index). C_FACTOR is the factor of the coefficient. M_IN is the M-Block signal input index (equals I-Block signal output index).

pybrid redac route [OPTIONS] PATH M_OUT U_OUT C_FACTOR M_IN

Options

--sync, --no-sync: Whether to immediately send configuration to hybrid controller.

Arguments

PATH: Required argument

M_OUT: Required argument

U_OUT: Required argument

C_FACTOR: Required argument

M_IN: Required argument

run

Start a run (computation) and wait until it is complete.

pybrid redac run [OPTIONS]

Options

--op-time <op_time>: OP time in nanoseconds.

--ic-time <ic_time>: IC time in nanoseconds.

-c, --config-file <config_file>: A config.json file to apply before starting the run.

-o, --output <output>: File to write data to.

-f, --output-format <output_format>

Format to write data in.

Options:: none | dat

set-alias

Define an alias for a path in an interactive session or script. You can use the alias in subsequent commands instead of a path argument.

PATH is the path the alias should resolve to. ALIAS is the name of the alias.

If ‘*’ is passed for the path as first argument, the alias is set to point to the next carrier board which does not yet have an alias set for it.

pybrid redac set-alias [OPTIONS] PATH ALIAS

Arguments

PATH: Required argument

ALIAS: Required argument

set-connection

Set one or multiple connections in a U-Block or I-Block.

PATH is the unique path to either a U-Block or I-Block. CONNECTIONS specifies which connections should be set. For a U-Block, the syntax is <input> <output> [<output> …]. For a I-Block, the syntax is <input> [<input> …] <output>.

pybrid redac set-connection [OPTIONS] PATH [CONNECTIONS]...

Options

--sync, --no-sync: Whether to immediately send configuration to hybrid controller.

--force

Force connection, possibly disconnecting existing connections.

Default:: False

Arguments

PATH: Required argument

CONNECTIONS: Optional argument(s)

set-daq

Configure data acquisition of subsequent run commands. Only useful in interactive sessions or scripts. Is lost once the session or script ends.

pybrid redac set-daq [OPTIONS] [PATHS]...

Options

-r, --sample-rate <sample_rate>

Sample rate in samples/second.

Options:: 1 | 2 | 4 | 5 | 8 | 10 | 16 | 20 | 25 | 32 | 40 | 50 | 64 | 80 | 100 | 125 | 160 | 200 | 250 | 320 | 400 | 500 | 625 | 800 | 1000 | 1250 | 1600 | 2000 | 2500 | 3125 | 4000 | 5000 | 6250 | 8000 | 10000 | 12500 | 15625 | 20000 | 25000 | 31250 | 40000 | 50000 | 62500 | 100000 | 125000 | 200000 | 250000 | 500000 | 1000000

-n, --num-channels <num_channels>

Number of channels.

Options:: 0 | 1 | 2 | 4 | 8

Arguments

PATHS: Optional argument(s)

set-element-config

Set one ATTRIBUTE to VALUE of the configuration of an entity at PATH.

PATH is the unique path of the entity. ATTRIBUTE is the name of the attribute to change, e.g. ‘factor’. VALUE is the new value of the attribute, e.g. ‘0.42’.

pybrid redac set-element-config [OPTIONS] PATH ATTRIBUTE VALUE

Options

--sync, --no-sync: Whether to immediately send configuration to hybrid controller.

Arguments

PATH: Required argument

ATTRIBUTE: Required argument

VALUE: Required argument

shell

Start an interactive shell and/or execute a REDAC shell SCRIPT.

SCRIPTS is a list of REDAC shell script files to execute before starting the interactive session.”

pybrid redac shell [OPTIONS] [SCRIPTS]...

Options

--ignore-errors

Ignore errors while executing a script.

Default:: False

-x, --exit-after-script

Exit after the scripts have been executed. Useful if output is piped into other programs.

Default:: False

Arguments

SCRIPTS: Optional argument(s)

user-program

pybrid redac user-program [OPTIONS] USER_PROGRAM_FILE

Options

-o, --output <output>

Arguments

USER_PROGRAM_FILE: Required argument