main

Main command-line script for running Pimlico, typically called from pimlico.sh.

Provides access to many subcommands, acting as the primary interface to Pimlico’s functionality.

class VariantsCmd[source]

Bases: pimlico.cli.subcommands.PimlicoCLISubcommand

List the available variants of a pipeline config

See Pipeline variants for more details.

command_name = 'variants'
command_help = 'List the available variants of a pipeline config'
add_arguments(parser)[source]
run_command(pipeline, opts)[source]
class UnlockCmd[source]

Bases: pimlico.cli.subcommands.PimlicoCLISubcommand

Forcibly remove an execution lock from a module. If a lock has ended up getting left on when execution exited prematurely, use this to remove it.

When a module starts running, it is locked to avoid making a mess of your output data by running the same module from another terminal, or some other silly mistake (I know, for some of us this sort of behaviour is frustratingly common).

Usually shouldn’t be necessary, even if there’s an error during execution, since the module should be unlocked when Pimlico exits, but occasionally (e.g. if you have to forcibly kill Pimlico during execution) the lock gets left on.

command_name = 'unlock'
command_help = "Forcibly remove an execution lock from a module. If a lock has ended up getting left on when execution exited prematurely, use this to remove it. Usually shouldn't be necessary, even if there's an error during execution"
command_desc = 'Forcibly remove an execution lock from a module'
add_arguments(parser)[source]
run_command(pipeline, opts)[source]
class BrowseCmd[source]

Bases: pimlico.cli.subcommands.PimlicoCLISubcommand

command_name = 'browse'
command_help = 'View the data output by a module'
add_arguments(parser)[source]
run_command(pipeline, opts)[source]
class VisualizeCmd[source]

Bases: pimlico.cli.subcommands.PimlicoCLISubcommand

command_name = 'visualize'
command_help = '(Not yet fully implemented!) Visualize the pipeline, with status information for modules'
command_desc = 'Comming soon...visualize the pipeline in a pretty way'
add_arguments(parser)[source]
run_command(pipeline, opts)[source]