CLI documentation

qosst-bob-gui

qosst-bob-gui - CLI interface

qosst-bob-gui [-h] [--version] [-v]

qosst-bob-gui options

-h, --help - show this help message and exit
--version - show program’s version number and exit
-v, --verbose - Level of verbosity. If none, nothing is printed to the console. -v will print warnings and errors, -vv will add info and -vvv will print all debug logs. (default: 0)

qosst-bob-excess-noise

qosst-bob-excess-noise - CLI interface

qosst-bob-excess-noise [-h] [--version] [-v] [-f FILE] [--no-save] [--plot] num_rep

qosst-bob-excess-noise positional arguments

num_rep - Number of repetitions of the experiment. (default: None)

qosst-bob-excess-noise options

-h, --help - show this help message and exit
--version - show program’s version number and exit
-v, --verbose - Level of verbosity. If none, nothing is printed to the console. -v will print warnings and errors, -vv will add info and -vvv will print all debug logs. (default: 0)
-f FILE, --file FILE - Path of the configuration file. Default : /home/docs/checkouts/readthedocs.org/user_builds/qosst-bob/checkouts/stable/docs/source/config.toml. (default: {cwd}/config.toml)
--no-save - Don’t save the data.
--plot - Plot the data.

qosst-bob-optimize

qosst-bob-optimize - CLI interface

qosst-bob-optimize [-h] [--version] [-f FILE] [--no-save] [--plot] [-n NUM_REP]
                   [--voa-channel VOA_CHANNEL] [-v]
                   {xi-vs-va,roll-off,pilots-amplitude,conversion-factor,baud-rate,subframe-size,frequency-cutoff-tone,frequency-shift,average-tone-size,pilot-difference-tone}
                   ...

qosst-bob-optimize options

-h, --help - show this help message and exit
--version - show program’s version number and exit
-f FILE, --file FILE - Path of the configuration file. Default : /home/docs/checkouts/readthedocs.org/user_builds/qosst-bob/checkouts/stable/docs/source/config.toml. (default: {cwd}/config.toml)
--no-save - Don’t save the data.
--plot - Plot the data.
-n NUM_REP, --num-rep NUM_REP - Number of repetitions of the experiment. (default: 10)
--voa-channel VOA_CHANNEL - Attenuation in V to apply to the channel VOA (default: 0)
-v, --verbose - Level of verbosity. If none, nothing is printed to the console. -v will print warnings and errors, -vv will add info and -vvv will print all debug logs. (default: 0)

qosst-bob-optimize xi-vs-va

Compute the excess noise while varying the variance.

qosst-bob-optimize xi-vs-va [-h] begin_variance end_variance step_variance

qosst-bob-optimize xi-vs-va positional arguments

begin_variance - Value for the first variance (default: None)
end_variance - Value for the last variance (excluded) (default: None)
step_variance - Value for the step of the variance (default: None)

qosst-bob-optimize xi-vs-va options

-h, --help - show this help message and exit

qosst-bob-optimize roll-off

Compute the excess noise while varying the roll-off.

qosst-bob-optimize roll-off [-h] begin_roll_off end_roll_off step_roll_off

qosst-bob-optimize roll-off positional arguments

begin_roll_off - Value for the first roll-off (default: None)
end_roll_off - Value for the last roll-off (excluded) (default: None)
step_roll_off - Value for the step of the roll-off (default: None)

qosst-bob-optimize roll-off options

-h, --help - show this help message and exit

qosst-bob-optimize pilots-amplitude

Compute the excess noise while varying the amplitude of the pilots.

qosst-bob-optimize pilots-amplitude [-h] begin_amplitude end_amplitude step_amplitude

qosst-bob-optimize pilots-amplitude positional arguments

begin_amplitude - Value for the first amplitude (default: None)
end_amplitude - Value for the last amplitude (excluded) (default: None)
step_amplitude - Value for the step of the amplitude (default: None)

qosst-bob-optimize pilots-amplitude options

-h, --help - show this help message and exit

qosst-bob-optimize conversion-factor

Compute the excess noise while varying the conversion factor of Alice.

qosst-bob-optimize conversion-factor [-h] initial_value begin_error end_error step_error

qosst-bob-optimize conversion-factor positional arguments

initial_value - Initial value of the conversion factor. (default: None)
begin_error - Value for the first error (in %) (default: None)
end_error - Value for the last error (in %, excluded) (default: None)
step_error - Value for the step of the error (in %) (default: None)

qosst-bob-optimize conversion-factor options

-h, --help - show this help message and exit

qosst-bob-optimize baud-rate

Compute the excess noise while varying the baud rate of Alice. WARNING: Make sure to have enough frequency space before doing so.

qosst-bob-optimize baud-rate [-h] baud_rates [baud_rates ...]

qosst-bob-optimize baud-rate positional arguments

baud_rates - The list of baud rates to try. (default: None)

qosst-bob-optimize baud-rate options

-h, --help - show this help message and exit

qosst-bob-optimize subframe-size

Compute the excess noise while varing the size of the subframe of the DSP at Bob side.

qosst-bob-optimize subframe-size [-h] sizes [sizes ...]

qosst-bob-optimize subframe-size positional arguments

sizes - The list of subframe sizes to try. (default: None)

qosst-bob-optimize subframe-size options

-h, --help - show this help message and exit

qosst-bob-optimize frequency-cutoff-tone

Compute the excess noise while varying the cutoff for the filtering of the tone on Bob side.

qosst-bob-optimize frequency-cutoff-tone [-h] begin_cutoff end_cutoff step_cutoff

qosst-bob-optimize frequency-cutoff-tone positional arguments

begin_cutoff - Value for the first cutoff (default: None)
end_cutoff - Value for the last cutoff (excluded) (default: None)
step_cutoff - Value for the step of the cutoff (default: None)

qosst-bob-optimize frequency-cutoff-tone options

-h, --help - show this help message and exit

qosst-bob-optimize frequency-shift

Compute the excess noise while varying the frequency shift of Alice. WARNING: Make sure to have enough frequency space before doing so.

qosst-bob-optimize frequency-shift [-h] frequency_shifts [frequency_shifts ...]

qosst-bob-optimize frequency-shift positional arguments

frequency_shifts - The list of frequency shifts to try. (default: None)

qosst-bob-optimize frequency-shift options

-h, --help - show this help message and exit

qosst-bob-optimize average-tone-size

Compute the excess noise while varying the size for the averaging of the pilot at phase correction.

qosst-bob-optimize average-tone-size [-h] sizes [sizes ...]

qosst-bob-optimize average-tone-size positional arguments

sizes - The list of sizes to try. (default: None)

qosst-bob-optimize average-tone-size options

-h, --help - show this help message and exit

qosst-bob-optimize pilot-difference-tone

Compute the excess noise while varying the difference between the two pilots. The first pilot will be left unchanged.

qosst-bob-optimize pilot-difference-tone [-h] begin_difference end_difference step_difference

qosst-bob-optimize pilot-difference-tone positional arguments

begin_difference - Value for the first difference (default: None)
end_difference - Value for the last difference (excluded) (default: None)
step_difference - Value for the step of the difference (default: None)

qosst-bob-optimize pilot-difference-tone options

-h, --help - show this help message and exit

qosst-bob-transmittance

qosst-bob-transmittance - CLI interface

qosst-bob-transmittance [-h] [--version] [-v] [-f FILE] [--no-save] [--plot] [-n NUM_REP]
                        start_voa end_voa step_voa

qosst-bob-transmittance positional arguments

start_voa - Start value of the VOA in V. (default: None)
end_voa - End value of the VOA in V (not included). (default: None)
step_voa - Step value of the VOA in V. (default: None)

qosst-bob-transmittance options

-h, --help - show this help message and exit
--version - show program’s version number and exit
-v, --verbose - Level of verbosity. If none, nothing is printed to the console. -v will print warnings and errors, -vv will add info and -vvv will print all debug logs. (default: 0)
-f FILE, --file FILE - Path of the configuration file. Default : /home/docs/checkouts/readthedocs.org/user_builds/qosst-bob/checkouts/stable/docs/source/config.toml. (default: {cwd}/config.toml)
--no-save - Don’t save the data.
--plot - Plot the data.
-n NUM_REP, --num_rep NUM_REP - Number of repetitions of the experiment. Default : 1 (default: 1)

qosst-bob-tools

qosst-bob-tools - CLI interface

qosst-bob-tools [-h] [--version] [-v] {eta-voltage,eta-current} ...

qosst-bob-tools options

-h, --help - show this help message and exit
--version - show program’s version number and exit
-v, --verbose - Level of verbosity. If none, nothing is printed to the console. -v will print warnings and errors, -vv will add info and -vvv will print all debug logs. (default: 0)

qosst-bob-tools eta-voltage

Compute eta using voltage

qosst-bob-tools eta-voltage [-h] [--no-save] gain

qosst-bob-tools eta-voltage positional arguments

gain - Gain of the TIA of the monitoring outputs. (default: None)

qosst-bob-tools eta-voltage options

-h, --help - show this help message and exit
--no-save - Don’t save the results.

qosst-bob-tools eta-current

Compute eta using current.

qosst-bob-tools eta-current [-h] [--no-save]

qosst-bob-tools eta-current options

-h, --help - show this help message and exit
--no-save - Don’t save the results.