Command-line interface

Shape-Link comes with a command-line-interface (CLI) for running plugins.

shape-link

shape-link [OPTIONS] COMMAND [ARGS]...

run-plugin

Run a Shape-Link plugin file

Example usages:

# run a plugin
shape-link run-plugin plugins/slp_rolling_mean.py
# run a plugin with a simulator thread (for plugin testing)
shape-link run-plugin -w data.rtdc -f image,deform slp_rolling_mean.py

shape-link run-plugin [OPTIONS] PATH

Options

-w, --with-simulator <with_simulator>

Run the Shape-In simulator in the background using the RT-DC dataset specified (used for testing).

-f, --features <features>

Comma-separated list of features to send by the Shape-In simulator; Defaults to all innate features. A list of valid feature names can be found in the dclab docs (Advanced Usage -> Notation).

Arguments

PATH

Required argument

run-simulator

Run the Shape-In simulator using data from an RT-DC dataset file

Example usage:

shape-link run-simulator --features image,deform /path/to/data.rtdc

shape-link run-simulator [OPTIONS] PATH

Options

-f, --features <features>

Comma-separated list of features to send by the Shape-In simulator; Defaults to all innate features. A list of valid feature names can be found in the dclab docs (Advanced Usage -> Notation).

Arguments

PATH

Required argument