pimlico.cli.main module

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

Bases: pimlico.cli.subcommands.PimlicoCLISubcommand

command_name = 'variants'

command_help = 'List the available variants of a pipeline config'

add_arguments(parser)

run_command(pipeline, opts)

class LongStoreCmd

Bases: pimlico.cli.subcommands.PimlicoCLISubcommand

command_name = 'longstore'

command_help = "Move a particular module's output from the short-term store to the long-term store. It will still be found here by input readers. You might want to do this if your long-term store is bigger, to keep down the short-term store size"

add_arguments(parser)

run_command(pipeline, opts)

class UnlockCmd

Bases: pimlico.cli.subcommands.PimlicoCLISubcommand

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"

add_arguments(parser)

run_command(pipeline, opts)

class BrowseCmd

Bases: pimlico.cli.subcommands.PimlicoCLISubcommand

command_name = 'browse'

command_help = 'View the data output by a module'

add_arguments(parser)

run_command(pipeline, opts)

class VisualizeCmd

Bases: pimlico.cli.subcommands.PimlicoCLISubcommand

command_name = 'visualize'

command_help = '(Not yet fully implemented!) Visualize the pipeline, with status information for modules'

add_arguments(parser)

run_command(pipeline, opts)