Command-line Interface

qslib

qslib [OPTIONS] COMMAND [ARGS]...

Options

-V, --version

Show the version and exit.

copy

Copy experiment from machine storage.

qslib copy [OPTIONS] MACHINE EXPERIMENT

Options

-o, --output <output>

Arguments

MACHINE

Required argument

EXPERIMENT

Required argument

export-data

Export fluorescence reading data from an experiment, as a CSV file.

qslib export-data [OPTIONS] EXPERIMENT

Arguments

EXPERIMENT

Required argument

export-temperatures

Export temperature readings from an experiment, as a CSV file.

qslib export-temperatures [OPTIONS] EXPERIMENT

Arguments

EXPERIMENT

Required argument

get-eds

Get all experiments matching a name from the machine.

Each argument should be of the form machine:name, where machine is the machine address and name is the glob pattern to match experiment names against.

qslib get-eds [OPTIONS] [PATH]...

Options

-f, --force, --no-force

Overwrite existing files

-q, --quiet, --no-quiet

Suppress output messages

-o, --output-dir <output_dir>

Output directory for saved files

Arguments

PATH

Optional argument(s)

info

Output information on the experiment.

qslib info [OPTIONS] EXPERIMENT

Arguments

EXPERIMENT

Required argument

info-html

Create an HTML summary of the experiment, and potentially open it.

qslib info-html [OPTIONS] EXPERIMENT

Options

-o, --output <output>

output file name (defaults to experiment base filename + extension)

-n, --open, --no-open

Open the file after creating it.

Arguments

EXPERIMENT

Required argument

list-stored

List experiments stored on a machine.

MACHINE_PATH can be either just a machine name/address, or machine:pattern where pattern is used to filter results using shell-style wildcards (*, ?, etc).

qslib list-stored [OPTIONS] [MACHINE_PATH]...

Options

-v, --verbose

Show detailed file information

-s, --sort <sort>

Sort by name, modification time, creation time, or file size

Options:

name | time | size | created

-r, --reverse

Reverse the sort order

-U, --created

Use creation time instead of modification time

Arguments

MACHINE_PATH

Optional argument(s)

machine-power

Turn the lamp/heat-block on or off (if idle).

qslib machine-power [OPTIONS] MACHINE {on|off}

Arguments

MACHINE

Required argument

STATE

Required argument

machine-status

Print the current status of a machine.

qslib machine-status [OPTIONS] MACHINE

Arguments

MACHINE

Required argument

protocol-desc

Print a description of the protocol in an experiment.

qslib protocol-desc [OPTIONS] EXPERIMENT

Arguments

EXPERIMENT

Required argument

protocol-plot

Plot the temperature protocol in an experiment.

qslib protocol-plot [OPTIONS] EXPERIMENT

Options

-o, --output <output>

output file name (defaults to experiment base filename + extension)

-f, --format <format>

Specify the output format (matplotlib formats are supported, eg, pdf, svg, png); defaults to pdf.

-a, --actual, --no-actual

NOT FINISHED Include actual temperature readings for finished experiments (not included by default).

-n, --open, --no-open

Open the file after creating it.

Arguments

EXPERIMENT

Required argument

run

Run an experiment.

qslib run [OPTIONS] EXPERIMENT MACHINE

Arguments

EXPERIMENT

Required argument

MACHINE

Required argument

setup-machine

qslib setup-machine [OPTIONS] HOST CURRENT_PASSWORD

Options

-c, --controller-password <controller_password>
-a, --admin-password <admin_password>
-d, --default-controller, --no-default-controller
-v, --verbose, --no-verbose

Arguments

HOST

Required argument

CURRENT_PASSWORD

Required argument