spython.instance.cmd package

Submodules

spython.instance.cmd.iutils module

spython.instance.cmd.start module

spython.instance.cmd.start.start(self, image=None, name=None, args=None, sudo=False, sudo_options=None, options=None, capture=False, singularity_options=None, environ=None, quiet=True)[source]

start an instance. This is done by default when an instance is created.

Parameters:

image (optionally, an image uri (if called as a command from Client)) name (a name for the instance) sudo (if the user wants to run the command with sudo) capture (capture output, default is False. With True likely to hang.) args (arguments to provide to the instance (supported Singularity 3.1+)) singularity_options (a list of options to provide to the singularity client) quiet (Do not print verbose output.) options (a list of tuples, each an option to give to the start command) – [(“–bind”, “/tmp”),…] USAGE singularity […] instance.start […] <container path> <instance name>

spython.instance.cmd.stop module

spython.instance.cmd.stop.stop(self, name=None, sudo=False, sudo_options=None, timeout=None, singularity_options=None, quiet=True)[source]

stop an instance. This is done by default when an instance is created.

Parameters:	name (a name for the instance) sudo (if the user wants to run the command with sudo) singularity_options (a list of options to provide to the singularity client) quiet (Do not print verbose output.) timeout (forcebly kill non-stopped instance after the) – timeout specified in seconds USAGE singularity […] instance.stop […] <instance name>

Module contents

spython.instance.cmd.generate_instance_commands()[source]

The Instance client holds the Singularity Instance command group The levels of verbosity (debug and quiet) are passed from the main client via the environment variable MESSAGELEVEL.