parallel.apps.launcher

Module: parallel.apps.launcher

Inheritance diagram for IPython.parallel.apps.launcher:

Facilities for launching IPython processes asynchronously.

Authors:

• Brian Granger
• MinRK

Classes

BaseLauncher

class IPython.parallel.apps.launcher.BaseLauncher(work_dir=u'.', config=None, **kwargs)

Bases: IPython.config.configurable.LoggingConfigurable

An asbtraction for starting, stopping and signaling a process.

__init__(work_dir=u'.', config=None, **kwargs)

arg_str

The string form of the program arguments.

args

A list of cmd and args that will be used to start the process.

This is what is passed to spawnProcess() and the first element will be the process name.

classmethod class_config_section()

Get the config class config section

classmethod class_get_help()

Get the help string for this class in ReST format.

classmethod class_get_trait_help(trait)

Get the help string for a single trait.

classmethod class_print_help()

Get the help string for a single trait and print it.

classmethod class_trait_names(**metadata)

Get a list of all the names of this classes traits.

This method is just like the trait_names() method, but is unbound.

classmethod class_traits(**metadata)

Get a list of all the traits of this class.

This method is just like the traits() method, but is unbound.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

config

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

created = None

find_args()

The .args property calls this to find the args list.

Subcommand should implement this to construct the cmd and args.

log

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

loop

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

notify_start(data)

Call this to trigger startup actions.

This logs the process startup and sets the state to ‘running’. It is a pass-through so it can be used as a callback.

notify_stop(data)

Call this to trigger process stop actions.

This logs the process stopping and sets the state to ‘after’. Call this to trigger callbacks registered via on_stop().

on_stop(f)

Register a callback to be called with this Launcher’s stop_data when the process actually finishes.

on_trait_change(handler, name=None, remove=False)

Setup a handler to be called when a trait changes.

This is used to setup dynamic notifications of trait changes.

Static handlers can be created by creating methods on a HasTraits subclass with the naming convention ‘_[traitname]_changed’. Thus, to create static handler for the trait ‘a’, create the method _a_changed(self, name, old, new) (fewer arguments can be used, see below).

Parameters :

handler : callable

A callable that is called when a trait changes. Its signature can be handler(), handler(name), handler(name, new) or handler(name, old, new).

name : list, str, None

If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

remove : bool

If False (the default), then install the handler. If True then unintall it.

running

Am I running.

signal(sig)

Signal the process.

Parameters :

sig : str or int

‘KILL’, ‘INT’, etc., or any signal number

start()

Start the process.

start_data

stop()

Stop the process and notify observers of stopping.

This method will return None immediately. To observe the actual process stopping, see on_stop().

stop_data

trait_metadata(traitname, key)

Get metadata values for trait by key.

trait_names(**metadata)

Get a list of all the names of this classes traits.

traits(**metadata)

Get a list of all the traits of this class.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

work_dir

A trait for unicode strings.

BatchSystemLauncher

class IPython.parallel.apps.launcher.BatchSystemLauncher(work_dir=u'.', config=None, **kwargs)

Bases: IPython.parallel.apps.launcher.BaseLauncher

Launch an external process using a batch system.

This class is designed to work with UNIX batch systems like PBS, LSF, GridEngine, etc. The overall model is that there are different commands like qsub, qdel, etc. that handle the starting and stopping of the process.

This class also has the notion of a batch script. The batch_template attribute can be set to a string that is a template for the batch script. This template is instantiated using string formatting. Thus the template can use {n} fot the number of instances. Subclasses can add additional variables to the template dict.

__init__(work_dir=u'.', config=None, **kwargs)

arg_str

The string form of the program arguments.

args

A list of cmd and args that will be used to start the process.

This is what is passed to spawnProcess() and the first element will be the process name.

batch_file

A trait for unicode strings.

batch_file_name

A trait for unicode strings.

batch_template

A trait for unicode strings.

batch_template_file

A trait for unicode strings.

classmethod class_config_section()

Get the config class config section

classmethod class_get_help()

Get the help string for this class in ReST format.

classmethod class_get_trait_help(trait)

Get the help string for a single trait.

classmethod class_print_help()

Get the help string for a single trait and print it.

classmethod class_trait_names(**metadata)

Get a list of all the names of this classes traits.

This method is just like the trait_names() method, but is unbound.

classmethod class_traits(**metadata)

Get a list of all the traits of this class.

This method is just like the traits() method, but is unbound.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

config

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

context

An instance of a Python dict.

created = None

default_template

A trait for unicode strings.

delete_command

An instance of a Python list.

find_args()

formatter

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

job_array_regexp

A trait for unicode strings.

job_array_template

A trait for unicode strings.

job_id_regexp

A trait for unicode strings.

log

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

loop

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

notify_start(data)

Call this to trigger startup actions.

This logs the process startup and sets the state to ‘running’. It is a pass-through so it can be used as a callback.

notify_stop(data)

Call this to trigger process stop actions.

This logs the process stopping and sets the state to ‘after’. Call this to trigger callbacks registered via on_stop().

on_stop(f)

Register a callback to be called with this Launcher’s stop_data when the process actually finishes.

on_trait_change(handler, name=None, remove=False)

Setup a handler to be called when a trait changes.

This is used to setup dynamic notifications of trait changes.

Static handlers can be created by creating methods on a HasTraits subclass with the naming convention ‘_[traitname]_changed’. Thus, to create static handler for the trait ‘a’, create the method _a_changed(self, name, old, new) (fewer arguments can be used, see below).

Parameters :

handler : callable

A callable that is called when a trait changes. Its signature can be handler(), handler(name), handler(name, new) or handler(name, old, new).

name : list, str, None

If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

remove : bool

If False (the default), then install the handler. If True then unintall it.

parse_job_id(output)

Take the output of the submit command and return the job id.

queue

A trait for unicode strings.

queue_regexp

A trait for unicode strings.

queue_template

A trait for unicode strings.

running

Am I running.

signal(sig)

Signal the process.

Parameters :

sig : str or int

‘KILL’, ‘INT’, etc., or any signal number

start(n, profile_dir)

Start n copies of the process using a batch system.

start_data

stop()

stop_data

submit_command

An instance of a Python list.

trait_metadata(traitname, key)

Get metadata values for trait by key.

trait_names(**metadata)

Get a list of all the names of this classes traits.

traits(**metadata)

Get a list of all the traits of this class.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

work_dir

A trait for unicode strings.

write_batch_script(n)

Instantiate and write the batch script to the work_dir.

IPClusterLauncher

class IPython.parallel.apps.launcher.IPClusterLauncher(work_dir=u'.', config=None, **kwargs)

Bases: IPython.parallel.apps.launcher.LocalProcessLauncher

Launch the ipcluster program in an external process.

__init__(work_dir=u'.', config=None, **kwargs)

arg_str

The string form of the program arguments.

args

A list of cmd and args that will be used to start the process.

This is what is passed to spawnProcess() and the first element will be the process name.

classmethod class_config_section()

Get the config class config section

classmethod class_get_help()

Get the help string for this class in ReST format.

classmethod class_get_trait_help(trait)

Get the help string for a single trait.

classmethod class_print_help()

Get the help string for a single trait and print it.

classmethod class_trait_names(**metadata)

Get a list of all the names of this classes traits.

This method is just like the trait_names() method, but is unbound.

classmethod class_traits(**metadata)

Get a list of all the traits of this class.

This method is just like the traits() method, but is unbound.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

cmd_and_args

An instance of a Python list.

config

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

created = None

find_args()

handle_stderr(fd, events)

handle_stdout(fd, events)

interrupt_then_kill(delay=2.0)

Send INT, wait a delay and then send KILL.

ipcluster_args

An instance of a Python list.

ipcluster_cmd

An instance of a Python list.

ipcluster_n

A integer trait.

ipcluster_subcommand

A trait for unicode strings.

log

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

loop

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

notify_start(data)

Call this to trigger startup actions.

This logs the process startup and sets the state to ‘running’. It is a pass-through so it can be used as a callback.

notify_stop(data)

Call this to trigger process stop actions.

This logs the process stopping and sets the state to ‘after’. Call this to trigger callbacks registered via on_stop().

on_stop(f)

Register a callback to be called with this Launcher’s stop_data when the process actually finishes.

on_trait_change(handler, name=None, remove=False)

Setup a handler to be called when a trait changes.

This is used to setup dynamic notifications of trait changes.

Static handlers can be created by creating methods on a HasTraits subclass with the naming convention ‘_[traitname]_changed’. Thus, to create static handler for the trait ‘a’, create the method _a_changed(self, name, old, new) (fewer arguments can be used, see below).

Parameters :

handler : callable

A callable that is called when a trait changes. Its signature can be handler(), handler(name), handler(name, new) or handler(name, old, new).

name : list, str, None

If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

remove : bool

If False (the default), then install the handler. If True then unintall it.

poll()

poll_frequency

A integer trait.

running

Am I running.

signal(sig)

start()

start_data

stop()

stop_data

trait_metadata(traitname, key)

Get metadata values for trait by key.

trait_names(**metadata)

Get a list of all the names of this classes traits.

traits(**metadata)

Get a list of all the traits of this class.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

work_dir

A trait for unicode strings.

LSFControllerLauncher

class IPython.parallel.apps.launcher.LSFControllerLauncher(work_dir=u'.', config=None, **kwargs)

Bases: IPython.parallel.apps.launcher.LSFLauncher

Launch a controller using LSF.

__init__(work_dir=u'.', config=None, **kwargs)

arg_str

The string form of the program arguments.

args

A list of cmd and args that will be used to start the process.

This is what is passed to spawnProcess() and the first element will be the process name.

batch_file

A trait for unicode strings.

batch_file_name

A trait for unicode strings.

batch_template

A trait for unicode strings.

batch_template_file

A trait for unicode strings.

classmethod class_config_section()

Get the config class config section

classmethod class_get_help()

Get the help string for this class in ReST format.

classmethod class_get_trait_help(trait)

Get the help string for a single trait.

classmethod class_print_help()

Get the help string for a single trait and print it.

classmethod class_trait_names(**metadata)

Get a list of all the names of this classes traits.

This method is just like the trait_names() method, but is unbound.

classmethod class_traits(**metadata)

Get a list of all the traits of this class.

This method is just like the traits() method, but is unbound.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

config

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

context

An instance of a Python dict.

created = None

default_template

A trait for unicode strings.

delete_command

An instance of a Python list.

find_args()

formatter

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

job_array_regexp

A trait for unicode strings.

job_array_template

A trait for unicode strings.

job_id_regexp

A trait for unicode strings.

log

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

loop

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

notify_start(data)

Call this to trigger startup actions.

This logs the process startup and sets the state to ‘running’. It is a pass-through so it can be used as a callback.

notify_stop(data)

Call this to trigger process stop actions.

This logs the process stopping and sets the state to ‘after’. Call this to trigger callbacks registered via on_stop().

on_stop(f)

Register a callback to be called with this Launcher’s stop_data when the process actually finishes.

on_trait_change(handler, name=None, remove=False)

Setup a handler to be called when a trait changes.

This is used to setup dynamic notifications of trait changes.

Static handlers can be created by creating methods on a HasTraits subclass with the naming convention ‘_[traitname]_changed’. Thus, to create static handler for the trait ‘a’, create the method _a_changed(self, name, old, new) (fewer arguments can be used, see below).

Parameters :

handler : callable

A callable that is called when a trait changes. Its signature can be handler(), handler(name), handler(name, new) or handler(name, old, new).

name : list, str, None

If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

remove : bool

If False (the default), then install the handler. If True then unintall it.

parse_job_id(output)

Take the output of the submit command and return the job id.

queue

A trait for unicode strings.

queue_regexp

A trait for unicode strings.

queue_template

A trait for unicode strings.

running

Am I running.

signal(sig)

Signal the process.

Parameters :

sig : str or int

‘KILL’, ‘INT’, etc., or any signal number

start(profile_dir)

Start the controller by profile or profile_dir.

start_data

stop()

stop_data

submit_command

An instance of a Python list.

trait_metadata(traitname, key)

Get metadata values for trait by key.

trait_names(**metadata)

Get a list of all the names of this classes traits.

traits(**metadata)

Get a list of all the traits of this class.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

work_dir

A trait for unicode strings.

write_batch_script(n)

Instantiate and write the batch script to the work_dir.

LSFEngineSetLauncher

class IPython.parallel.apps.launcher.LSFEngineSetLauncher(work_dir=u'.', config=None, **kwargs)

Bases: IPython.parallel.apps.launcher.LSFLauncher

Launch Engines using LSF

__init__(work_dir=u'.', config=None, **kwargs)

arg_str

The string form of the program arguments.

args

A list of cmd and args that will be used to start the process.

This is what is passed to spawnProcess() and the first element will be the process name.

batch_file

A trait for unicode strings.

batch_file_name

A trait for unicode strings.

batch_template

A trait for unicode strings.

batch_template_file

A trait for unicode strings.

classmethod class_config_section()

Get the config class config section

classmethod class_get_help()

Get the help string for this class in ReST format.

classmethod class_get_trait_help(trait)

Get the help string for a single trait.

classmethod class_print_help()

Get the help string for a single trait and print it.

classmethod class_trait_names(**metadata)

Get a list of all the names of this classes traits.

This method is just like the trait_names() method, but is unbound.

classmethod class_traits(**metadata)

Get a list of all the traits of this class.

This method is just like the traits() method, but is unbound.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

config

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

context

An instance of a Python dict.

created = None

default_template

A trait for unicode strings.

delete_command

An instance of a Python list.

find_args()

formatter

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

job_array_regexp

A trait for unicode strings.

job_array_template

A trait for unicode strings.

job_id_regexp

A trait for unicode strings.

log

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

loop

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

notify_start(data)

Call this to trigger startup actions.

This logs the process startup and sets the state to ‘running’. It is a pass-through so it can be used as a callback.

notify_stop(data)

Call this to trigger process stop actions.

This logs the process stopping and sets the state to ‘after’. Call this to trigger callbacks registered via on_stop().

on_stop(f)

Register a callback to be called with this Launcher’s stop_data when the process actually finishes.

on_trait_change(handler, name=None, remove=False)

Setup a handler to be called when a trait changes.

This is used to setup dynamic notifications of trait changes.

Static handlers can be created by creating methods on a HasTraits subclass with the naming convention ‘_[traitname]_changed’. Thus, to create static handler for the trait ‘a’, create the method _a_changed(self, name, old, new) (fewer arguments can be used, see below).

Parameters :

handler : callable

A callable that is called when a trait changes. Its signature can be handler(), handler(name), handler(name, new) or handler(name, old, new).

name : list, str, None

If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

remove : bool

If False (the default), then install the handler. If True then unintall it.

parse_job_id(output)

Take the output of the submit command and return the job id.

queue

A trait for unicode strings.

queue_regexp

A trait for unicode strings.

queue_template

A trait for unicode strings.

running

Am I running.

signal(sig)

Signal the process.

Parameters :

sig : str or int

‘KILL’, ‘INT’, etc., or any signal number

start(n, profile_dir)

Start n engines by profile or profile_dir.

start_data

stop()

stop_data

submit_command

An instance of a Python list.

trait_metadata(traitname, key)

Get metadata values for trait by key.

trait_names(**metadata)

Get a list of all the names of this classes traits.

traits(**metadata)

Get a list of all the traits of this class.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

work_dir

A trait for unicode strings.

write_batch_script(n)

Instantiate and write the batch script to the work_dir.

LSFLauncher

class IPython.parallel.apps.launcher.LSFLauncher(work_dir=u'.', config=None, **kwargs)

Bases: IPython.parallel.apps.launcher.BatchSystemLauncher

A BatchSystemLauncher subclass for LSF.

__init__(work_dir=u'.', config=None, **kwargs)

arg_str

The string form of the program arguments.

args

A list of cmd and args that will be used to start the process.

This is what is passed to spawnProcess() and the first element will be the process name.

batch_file

A trait for unicode strings.

batch_file_name

A trait for unicode strings.

batch_template

A trait for unicode strings.

batch_template_file

A trait for unicode strings.

classmethod class_config_section()

Get the config class config section

classmethod class_get_help()

Get the help string for this class in ReST format.

classmethod class_get_trait_help(trait)

Get the help string for a single trait.

classmethod class_print_help()

Get the help string for a single trait and print it.

classmethod class_trait_names(**metadata)

Get a list of all the names of this classes traits.

This method is just like the trait_names() method, but is unbound.

classmethod class_traits(**metadata)

Get a list of all the traits of this class.

This method is just like the traits() method, but is unbound.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

config

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

context

An instance of a Python dict.

created = None

default_template

A trait for unicode strings.

delete_command

An instance of a Python list.

find_args()

formatter

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

job_array_regexp

A trait for unicode strings.

job_array_template

A trait for unicode strings.

job_id_regexp

A trait for unicode strings.

log

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

loop

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

notify_start(data)

Call this to trigger startup actions.

This logs the process startup and sets the state to ‘running’. It is a pass-through so it can be used as a callback.

notify_stop(data)

Call this to trigger process stop actions.

This logs the process stopping and sets the state to ‘after’. Call this to trigger callbacks registered via on_stop().

on_stop(f)

Register a callback to be called with this Launcher’s stop_data when the process actually finishes.

on_trait_change(handler, name=None, remove=False)

Setup a handler to be called when a trait changes.

This is used to setup dynamic notifications of trait changes.

Static handlers can be created by creating methods on a HasTraits subclass with the naming convention ‘_[traitname]_changed’. Thus, to create static handler for the trait ‘a’, create the method _a_changed(self, name, old, new) (fewer arguments can be used, see below).

Parameters :

handler : callable

A callable that is called when a trait changes. Its signature can be handler(), handler(name), handler(name, new) or handler(name, old, new).

name : list, str, None

If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

remove : bool

If False (the default), then install the handler. If True then unintall it.

parse_job_id(output)

Take the output of the submit command and return the job id.

queue

A trait for unicode strings.

queue_regexp

A trait for unicode strings.

queue_template

A trait for unicode strings.

running

Am I running.

signal(sig)

Signal the process.

Parameters :

sig : str or int

‘KILL’, ‘INT’, etc., or any signal number

start(n, profile_dir)

Start n copies of the process using LSF batch system. This cant inherit from the base class because bsub expects to be piped a shell script in order to honor the #BSUB directives : bsub < script

start_data

stop()

stop_data

submit_command

An instance of a Python list.

trait_metadata(traitname, key)

Get metadata values for trait by key.

trait_names(**metadata)

Get a list of all the names of this classes traits.

traits(**metadata)

Get a list of all the traits of this class.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

work_dir

A trait for unicode strings.

write_batch_script(n)

Instantiate and write the batch script to the work_dir.

LauncherError

class IPython.parallel.apps.launcher.LauncherError

Bases: exceptions.Exception

__init__()

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

args

message

LocalControllerLauncher

class IPython.parallel.apps.launcher.LocalControllerLauncher(work_dir=u'.', config=None, **kwargs)

Bases: IPython.parallel.apps.launcher.LocalProcessLauncher

Launch a controller as a regular external process.

__init__(work_dir=u'.', config=None, **kwargs)

arg_str

The string form of the program arguments.

args

A list of cmd and args that will be used to start the process.

This is what is passed to spawnProcess() and the first element will be the process name.

classmethod class_config_section()

Get the config class config section

classmethod class_get_help()

Get the help string for this class in ReST format.

classmethod class_get_trait_help(trait)

Get the help string for a single trait.

classmethod class_print_help()

Get the help string for a single trait and print it.

classmethod class_trait_names(**metadata)

Get a list of all the names of this classes traits.

This method is just like the trait_names() method, but is unbound.

classmethod class_traits(**metadata)

Get a list of all the traits of this class.

This method is just like the traits() method, but is unbound.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

cmd_and_args

An instance of a Python list.

config

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

controller_args

An instance of a Python list.

controller_cmd

An instance of a Python list.

created = None

find_args()

handle_stderr(fd, events)

handle_stdout(fd, events)

interrupt_then_kill(delay=2.0)

Send INT, wait a delay and then send KILL.

log

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

loop

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

notify_start(data)

Call this to trigger startup actions.

This logs the process startup and sets the state to ‘running’. It is a pass-through so it can be used as a callback.

notify_stop(data)

Call this to trigger process stop actions.

This logs the process stopping and sets the state to ‘after’. Call this to trigger callbacks registered via on_stop().

on_stop(f)

Register a callback to be called with this Launcher’s stop_data when the process actually finishes.

on_trait_change(handler, name=None, remove=False)

Setup a handler to be called when a trait changes.

This is used to setup dynamic notifications of trait changes.

Static handlers can be created by creating methods on a HasTraits subclass with the naming convention ‘_[traitname]_changed’. Thus, to create static handler for the trait ‘a’, create the method _a_changed(self, name, old, new) (fewer arguments can be used, see below).

Parameters :

handler : callable

A callable that is called when a trait changes. Its signature can be handler(), handler(name), handler(name, new) or handler(name, old, new).

name : list, str, None

If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

remove : bool

If False (the default), then install the handler. If True then unintall it.

poll()

poll_frequency

A integer trait.

running

Am I running.

signal(sig)

start(profile_dir)

Start the controller by profile_dir.

start_data

stop()

stop_data

trait_metadata(traitname, key)

Get metadata values for trait by key.

trait_names(**metadata)

Get a list of all the names of this classes traits.

traits(**metadata)

Get a list of all the traits of this class.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

work_dir

A trait for unicode strings.

LocalEngineLauncher

class IPython.parallel.apps.launcher.LocalEngineLauncher(work_dir=u'.', config=None, **kwargs)

Bases: IPython.parallel.apps.launcher.LocalProcessLauncher

Launch a single engine as a regular externall process.

__init__(work_dir=u'.', config=None, **kwargs)

arg_str

The string form of the program arguments.

args

A list of cmd and args that will be used to start the process.

This is what is passed to spawnProcess() and the first element will be the process name.

classmethod class_config_section()

Get the config class config section

classmethod class_get_help()

Get the help string for this class in ReST format.

classmethod class_get_trait_help(trait)

Get the help string for a single trait.

classmethod class_print_help()

Get the help string for a single trait and print it.

classmethod class_trait_names(**metadata)

Get a list of all the names of this classes traits.

This method is just like the trait_names() method, but is unbound.

classmethod class_traits(**metadata)

Get a list of all the traits of this class.

This method is just like the traits() method, but is unbound.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

cmd_and_args

An instance of a Python list.

config

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

created = None

engine_args

An instance of a Python list.

engine_cmd

An instance of a Python list.

find_args()

handle_stderr(fd, events)

handle_stdout(fd, events)

interrupt_then_kill(delay=2.0)

Send INT, wait a delay and then send KILL.

log

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

loop

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

notify_start(data)

Call this to trigger startup actions.

This logs the process startup and sets the state to ‘running’. It is a pass-through so it can be used as a callback.

notify_stop(data)

Call this to trigger process stop actions.

This logs the process stopping and sets the state to ‘after’. Call this to trigger callbacks registered via on_stop().

on_stop(f)

Register a callback to be called with this Launcher’s stop_data when the process actually finishes.

on_trait_change(handler, name=None, remove=False)

Setup a handler to be called when a trait changes.

This is used to setup dynamic notifications of trait changes.

Static handlers can be created by creating methods on a HasTraits subclass with the naming convention ‘_[traitname]_changed’. Thus, to create static handler for the trait ‘a’, create the method _a_changed(self, name, old, new) (fewer arguments can be used, see below).

Parameters :

handler : callable

A callable that is called when a trait changes. Its signature can be handler(), handler(name), handler(name, new) or handler(name, old, new).

name : list, str, None

If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

remove : bool

If False (the default), then install the handler. If True then unintall it.

poll()

poll_frequency

A integer trait.

running

Am I running.

signal(sig)

start(profile_dir)

Start the engine by profile_dir.

start_data

stop()

stop_data

trait_metadata(traitname, key)

Get metadata values for trait by key.

trait_names(**metadata)

Get a list of all the names of this classes traits.

traits(**metadata)

Get a list of all the traits of this class.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

work_dir

A trait for unicode strings.

LocalEngineSetLauncher

class IPython.parallel.apps.launcher.LocalEngineSetLauncher(work_dir=u'.', config=None, **kwargs)

Bases: IPython.parallel.apps.launcher.BaseLauncher

Launch a set of engines as regular external processes.

__init__(work_dir=u'.', config=None, **kwargs)

arg_str

The string form of the program arguments.

args

A list of cmd and args that will be used to start the process.

This is what is passed to spawnProcess() and the first element will be the process name.

classmethod class_config_section()

Get the config class config section

classmethod class_get_help()

Get the help string for this class in ReST format.

classmethod class_get_trait_help(trait)

Get the help string for a single trait.

classmethod class_print_help()

Get the help string for a single trait and print it.

classmethod class_trait_names(**metadata)

Get a list of all the names of this classes traits.

This method is just like the trait_names() method, but is unbound.

classmethod class_traits(**metadata)

Get a list of all the traits of this class.

This method is just like the traits() method, but is unbound.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

config

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

created = None

engine_args

An instance of a Python list.

find_args()

interrupt_then_kill(delay=1.0)

launcher_class

alias of LocalEngineLauncher

launchers

An instance of a Python dict.

log

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

loop

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

notify_start(data)

Call this to trigger startup actions.

This logs the process startup and sets the state to ‘running’. It is a pass-through so it can be used as a callback.

notify_stop(data)

Call this to trigger process stop actions.

This logs the process stopping and sets the state to ‘after’. Call this to trigger callbacks registered via on_stop().

on_stop(f)

Register a callback to be called with this Launcher’s stop_data when the process actually finishes.

on_trait_change(handler, name=None, remove=False)

Setup a handler to be called when a trait changes.

This is used to setup dynamic notifications of trait changes.

Static handlers can be created by creating methods on a HasTraits subclass with the naming convention ‘_[traitname]_changed’. Thus, to create static handler for the trait ‘a’, create the method _a_changed(self, name, old, new) (fewer arguments can be used, see below).

Parameters :

handler : callable

A callable that is called when a trait changes. Its signature can be handler(), handler(name), handler(name, new) or handler(name, old, new).

name : list, str, None

If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

remove : bool

If False (the default), then install the handler. If True then unintall it.

running

Am I running.

signal(sig)

start(n, profile_dir)

Start n engines by profile or profile_dir.

start_data

stop()

stop_data

An instance of a Python dict.

trait_metadata(traitname, key)

Get metadata values for trait by key.

trait_names(**metadata)

Get a list of all the names of this classes traits.

traits(**metadata)

Get a list of all the traits of this class.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

work_dir

A trait for unicode strings.

LocalProcessLauncher

class IPython.parallel.apps.launcher.LocalProcessLauncher(work_dir=u'.', config=None, **kwargs)

Bases: IPython.parallel.apps.launcher.BaseLauncher

Start and stop an external process in an asynchronous manner.

This will launch the external process with a working directory of self.work_dir.

__init__(work_dir=u'.', config=None, **kwargs)

arg_str

The string form of the program arguments.

args

A list of cmd and args that will be used to start the process.

This is what is passed to spawnProcess() and the first element will be the process name.

classmethod class_config_section()

Get the config class config section

classmethod class_get_help()

Get the help string for this class in ReST format.

classmethod class_get_trait_help(trait)

Get the help string for a single trait.

classmethod class_print_help()

Get the help string for a single trait and print it.

classmethod class_trait_names(**metadata)

Get a list of all the names of this classes traits.

This method is just like the trait_names() method, but is unbound.

classmethod class_traits(**metadata)

Get a list of all the traits of this class.

This method is just like the traits() method, but is unbound.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

cmd_and_args

An instance of a Python list.

config

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

created = None

find_args()

handle_stderr(fd, events)

handle_stdout(fd, events)

interrupt_then_kill(delay=2.0)

Send INT, wait a delay and then send KILL.

log

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

loop

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

notify_start(data)

Call this to trigger startup actions.

This logs the process startup and sets the state to ‘running’. It is a pass-through so it can be used as a callback.

notify_stop(data)

Call this to trigger process stop actions.

This logs the process stopping and sets the state to ‘after’. Call this to trigger callbacks registered via on_stop().

on_stop(f)

Register a callback to be called with this Launcher’s stop_data when the process actually finishes.

on_trait_change(handler, name=None, remove=False)

Setup a handler to be called when a trait changes.

This is used to setup dynamic notifications of trait changes.

Static handlers can be created by creating methods on a HasTraits subclass with the naming convention ‘_[traitname]_changed’. Thus, to create static handler for the trait ‘a’, create the method _a_changed(self, name, old, new) (fewer arguments can be used, see below).

Parameters :

handler : callable

A callable that is called when a trait changes. Its signature can be handler(), handler(name), handler(name, new) or handler(name, old, new).

name : list, str, None

If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

remove : bool

If False (the default), then install the handler. If True then unintall it.

poll()

poll_frequency

A integer trait.

running

Am I running.

signal(sig)

start()

start_data

stop()

stop_data

trait_metadata(traitname, key)

Get metadata values for trait by key.

trait_names(**metadata)

Get a list of all the names of this classes traits.

traits(**metadata)

Get a list of all the traits of this class.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

work_dir

A trait for unicode strings.

MPIExecControllerLauncher

class IPython.parallel.apps.launcher.MPIExecControllerLauncher(work_dir=u'.', config=None, **kwargs)

Bases: IPython.parallel.apps.launcher.MPIExecLauncher

Launch a controller using mpiexec.

__init__(work_dir=u'.', config=None, **kwargs)

arg_str

The string form of the program arguments.

args

A list of cmd and args that will be used to start the process.

This is what is passed to spawnProcess() and the first element will be the process name.

classmethod class_config_section()

Get the config class config section

classmethod class_get_help()

Get the help string for this class in ReST format.

classmethod class_get_trait_help(trait)

Get the help string for a single trait.

classmethod class_print_help()

Get the help string for a single trait and print it.

classmethod class_trait_names(**metadata)

Get a list of all the names of this classes traits.

This method is just like the trait_names() method, but is unbound.

classmethod class_traits(**metadata)

Get a list of all the traits of this class.

This method is just like the traits() method, but is unbound.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

cmd_and_args

An instance of a Python list.

config

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

controller_args

An instance of a Python list.

controller_cmd

An instance of a Python list.

created = None

find_args()

handle_stderr(fd, events)

handle_stdout(fd, events)

interrupt_then_kill(delay=2.0)

Send INT, wait a delay and then send KILL.

log

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

loop

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

mpi_args

An instance of a Python list.

mpi_cmd

An instance of a Python list.

n

A integer trait.

notify_start(data)

Call this to trigger startup actions.

This logs the process startup and sets the state to ‘running’. It is a pass-through so it can be used as a callback.

notify_stop(data)

Call this to trigger process stop actions.

This logs the process stopping and sets the state to ‘after’. Call this to trigger callbacks registered via on_stop().

on_stop(f)

Register a callback to be called with this Launcher’s stop_data when the process actually finishes.

on_trait_change(handler, name=None, remove=False)

Setup a handler to be called when a trait changes.

This is used to setup dynamic notifications of trait changes.

Static handlers can be created by creating methods on a HasTraits subclass with the naming convention ‘_[traitname]_changed’. Thus, to create static handler for the trait ‘a’, create the method _a_changed(self, name, old, new) (fewer arguments can be used, see below).

Parameters :

handler : callable

A callable that is called when a trait changes. Its signature can be handler(), handler(name), handler(name, new) or handler(name, old, new).

name : list, str, None

If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

remove : bool

If False (the default), then install the handler. If True then unintall it.

poll()

poll_frequency

A integer trait.

program

An instance of a Python list.

program_args

An instance of a Python list.

running

Am I running.

signal(sig)

start(profile_dir)

Start the controller by profile_dir.

start_data

stop()

stop_data

trait_metadata(traitname, key)

Get metadata values for trait by key.

trait_names(**metadata)

Get a list of all the names of this classes traits.

traits(**metadata)

Get a list of all the traits of this class.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

work_dir

A trait for unicode strings.

MPIExecEngineSetLauncher

class IPython.parallel.apps.launcher.MPIExecEngineSetLauncher(work_dir=u'.', config=None, **kwargs)

Bases: IPython.parallel.apps.launcher.MPIExecLauncher

__init__(work_dir=u'.', config=None, **kwargs)

arg_str

The string form of the program arguments.

args

A list of cmd and args that will be used to start the process.

This is what is passed to spawnProcess() and the first element will be the process name.

classmethod class_config_section()

Get the config class config section

classmethod class_get_help()

Get the help string for this class in ReST format.

classmethod class_get_trait_help(trait)

Get the help string for a single trait.

classmethod class_print_help()

Get the help string for a single trait and print it.

classmethod class_trait_names(**metadata)

Get a list of all the names of this classes traits.

This method is just like the trait_names() method, but is unbound.

classmethod class_traits(**metadata)

Get a list of all the traits of this class.

This method is just like the traits() method, but is unbound.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

cmd_and_args

An instance of a Python list.

config

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

created = None

find_args()

Build self.args using all the fields.

handle_stderr(fd, events)

handle_stdout(fd, events)

interrupt_then_kill(delay=2.0)

Send INT, wait a delay and then send KILL.

log

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

loop

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

mpi_args

An instance of a Python list.

mpi_cmd

An instance of a Python list.

n

A integer trait.

notify_start(data)

Call this to trigger startup actions.

This logs the process startup and sets the state to ‘running’. It is a pass-through so it can be used as a callback.

notify_stop(data)

Call this to trigger process stop actions.

This logs the process stopping and sets the state to ‘after’. Call this to trigger callbacks registered via on_stop().

on_stop(f)

Register a callback to be called with this Launcher’s stop_data when the process actually finishes.

on_trait_change(handler, name=None, remove=False)

Setup a handler to be called when a trait changes.

This is used to setup dynamic notifications of trait changes.

Static handlers can be created by creating methods on a HasTraits subclass with the naming convention ‘_[traitname]_changed’. Thus, to create static handler for the trait ‘a’, create the method _a_changed(self, name, old, new) (fewer arguments can be used, see below).

Parameters :

handler : callable

A callable that is called when a trait changes. Its signature can be handler(), handler(name), handler(name, new) or handler(name, old, new).

name : list, str, None

If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

remove : bool

If False (the default), then install the handler. If True then unintall it.

poll()

poll_frequency

A integer trait.

program

An instance of a Python list.

program_args

An instance of a Python list.

running

Am I running.

signal(sig)

start(n, profile_dir)

Start n engines by profile or profile_dir.

start_data

stop()

stop_data

trait_metadata(traitname, key)

Get metadata values for trait by key.

trait_names(**metadata)

Get a list of all the names of this classes traits.

traits(**metadata)

Get a list of all the traits of this class.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

work_dir

A trait for unicode strings.

MPIExecLauncher

class IPython.parallel.apps.launcher.MPIExecLauncher(work_dir=u'.', config=None, **kwargs)

Bases: IPython.parallel.apps.launcher.LocalProcessLauncher

Launch an external process using mpiexec.

__init__(work_dir=u'.', config=None, **kwargs)

arg_str

The string form of the program arguments.

args

A list of cmd and args that will be used to start the process.

This is what is passed to spawnProcess() and the first element will be the process name.

classmethod class_config_section()

Get the config class config section

classmethod class_get_help()

Get the help string for this class in ReST format.

classmethod class_get_trait_help(trait)

Get the help string for a single trait.

classmethod class_print_help()

Get the help string for a single trait and print it.

classmethod class_trait_names(**metadata)

Get a list of all the names of this classes traits.

This method is just like the trait_names() method, but is unbound.

classmethod class_traits(**metadata)

Get a list of all the traits of this class.

This method is just like the traits() method, but is unbound.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

cmd_and_args

An instance of a Python list.

config

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

created = None

find_args()

Build self.args using all the fields.

handle_stderr(fd, events)

handle_stdout(fd, events)

interrupt_then_kill(delay=2.0)

Send INT, wait a delay and then send KILL.

log

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

loop

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

mpi_args

An instance of a Python list.

mpi_cmd

An instance of a Python list.

n

A integer trait.

notify_start(data)

Call this to trigger startup actions.

This logs the process startup and sets the state to ‘running’. It is a pass-through so it can be used as a callback.

notify_stop(data)

Call this to trigger process stop actions.

This logs the process stopping and sets the state to ‘after’. Call this to trigger callbacks registered via on_stop().

on_stop(f)

Register a callback to be called with this Launcher’s stop_data when the process actually finishes.

on_trait_change(handler, name=None, remove=False)

Setup a handler to be called when a trait changes.

This is used to setup dynamic notifications of trait changes.

Static handlers can be created by creating methods on a HasTraits subclass with the naming convention ‘_[traitname]_changed’. Thus, to create static handler for the trait ‘a’, create the method _a_changed(self, name, old, new) (fewer arguments can be used, see below).

Parameters :

handler : callable

A callable that is called when a trait changes. Its signature can be handler(), handler(name), handler(name, new) or handler(name, old, new).

name : list, str, None

If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

remove : bool

If False (the default), then install the handler. If True then unintall it.

poll()

poll_frequency

A integer trait.

program

An instance of a Python list.

program_args

An instance of a Python list.

running

Am I running.

signal(sig)

start(n)

Start n instances of the program using mpiexec.

start_data

stop()

stop_data

trait_metadata(traitname, key)

Get metadata values for trait by key.

trait_names(**metadata)

Get a list of all the names of this classes traits.

traits(**metadata)

Get a list of all the traits of this class.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

work_dir

A trait for unicode strings.

PBSControllerLauncher

class IPython.parallel.apps.launcher.PBSControllerLauncher(work_dir=u'.', config=None, **kwargs)

Bases: IPython.parallel.apps.launcher.PBSLauncher

Launch a controller using PBS.

__init__(work_dir=u'.', config=None, **kwargs)

arg_str

The string form of the program arguments.

args

A list of cmd and args that will be used to start the process.

This is what is passed to spawnProcess() and the first element will be the process name.

batch_file

A trait for unicode strings.

batch_file_name

A trait for unicode strings.

batch_template

A trait for unicode strings.

batch_template_file

A trait for unicode strings.

classmethod class_config_section()

Get the config class config section

classmethod class_get_help()

Get the help string for this class in ReST format.

classmethod class_get_trait_help(trait)

Get the help string for a single trait.

classmethod class_print_help()

Get the help string for a single trait and print it.

classmethod class_trait_names(**metadata)

Get a list of all the names of this classes traits.

This method is just like the trait_names() method, but is unbound.

classmethod class_traits(**metadata)

Get a list of all the traits of this class.

This method is just like the traits() method, but is unbound.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

config

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

context

An instance of a Python dict.

created = None

default_template

A trait for unicode strings.

delete_command

An instance of a Python list.

find_args()

formatter

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

job_array_regexp

A trait for unicode strings.

job_array_template

A trait for unicode strings.

job_id_regexp

A trait for unicode strings.

log

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

loop

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

notify_start(data)

Call this to trigger startup actions.

This logs the process startup and sets the state to ‘running’. It is a pass-through so it can be used as a callback.

notify_stop(data)

Call this to trigger process stop actions.

This logs the process stopping and sets the state to ‘after’. Call this to trigger callbacks registered via on_stop().

on_stop(f)

Register a callback to be called with this Launcher’s stop_data when the process actually finishes.

on_trait_change(handler, name=None, remove=False)

Setup a handler to be called when a trait changes.

This is used to setup dynamic notifications of trait changes.

Static handlers can be created by creating methods on a HasTraits subclass with the naming convention ‘_[traitname]_changed’. Thus, to create static handler for the trait ‘a’, create the method _a_changed(self, name, old, new) (fewer arguments can be used, see below).

Parameters :

handler : callable

A callable that is called when a trait changes. Its signature can be handler(), handler(name), handler(name, new) or handler(name, old, new).

name : list, str, None

If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

remove : bool

If False (the default), then install the handler. If True then unintall it.

parse_job_id(output)

Take the output of the submit command and return the job id.

queue

A trait for unicode strings.

queue_regexp

A trait for unicode strings.

queue_template

A trait for unicode strings.

running

Am I running.

signal(sig)

Signal the process.

Parameters :

sig : str or int

‘KILL’, ‘INT’, etc., or any signal number

start(profile_dir)

Start the controller by profile or profile_dir.

start_data

stop()

stop_data

submit_command

An instance of a Python list.

trait_metadata(traitname, key)

Get metadata values for trait by key.

trait_names(**metadata)

Get a list of all the names of this classes traits.

traits(**metadata)

Get a list of all the traits of this class.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

work_dir

A trait for unicode strings.

write_batch_script(n)

Instantiate and write the batch script to the work_dir.

PBSEngineSetLauncher

class IPython.parallel.apps.launcher.PBSEngineSetLauncher(work_dir=u'.', config=None, **kwargs)

Bases: IPython.parallel.apps.launcher.PBSLauncher

Launch Engines using PBS

__init__(work_dir=u'.', config=None, **kwargs)

arg_str

The string form of the program arguments.

args

A list of cmd and args that will be used to start the process.

This is what is passed to spawnProcess() and the first element will be the process name.

batch_file

A trait for unicode strings.

batch_file_name

A trait for unicode strings.

batch_template

A trait for unicode strings.

batch_template_file

A trait for unicode strings.

classmethod class_config_section()

Get the config class config section

classmethod class_get_help()

Get the help string for this class in ReST format.

classmethod class_get_trait_help(trait)

Get the help string for a single trait.

classmethod class_print_help()

Get the help string for a single trait and print it.

classmethod class_trait_names(**metadata)

Get a list of all the names of this classes traits.

This method is just like the trait_names() method, but is unbound.

classmethod class_traits(**metadata)

Get a list of all the traits of this class.

This method is just like the traits() method, but is unbound.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

config

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

context

An instance of a Python dict.

created = None

default_template

A trait for unicode strings.

delete_command

An instance of a Python list.

find_args()

formatter

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

job_array_regexp

A trait for unicode strings.

job_array_template

A trait for unicode strings.

job_id_regexp

A trait for unicode strings.

log

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

loop

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

notify_start(data)

Call this to trigger startup actions.

This logs the process startup and sets the state to ‘running’. It is a pass-through so it can be used as a callback.

notify_stop(data)

Call this to trigger process stop actions.

This logs the process stopping and sets the state to ‘after’. Call this to trigger callbacks registered via on_stop().

on_stop(f)

Register a callback to be called with this Launcher’s stop_data when the process actually finishes.

on_trait_change(handler, name=None, remove=False)

Setup a handler to be called when a trait changes.

This is used to setup dynamic notifications of trait changes.

Static handlers can be created by creating methods on a HasTraits subclass with the naming convention ‘_[traitname]_changed’. Thus, to create static handler for the trait ‘a’, create the method _a_changed(self, name, old, new) (fewer arguments can be used, see below).

Parameters :

handler : callable

A callable that is called when a trait changes. Its signature can be handler(), handler(name), handler(name, new) or handler(name, old, new).

name : list, str, None

If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

remove : bool

If False (the default), then install the handler. If True then unintall it.

parse_job_id(output)

Take the output of the submit command and return the job id.

queue

A trait for unicode strings.

queue_regexp

A trait for unicode strings.

queue_template

A trait for unicode strings.

running

Am I running.

signal(sig)

Signal the process.

Parameters :

sig : str or int

‘KILL’, ‘INT’, etc., or any signal number

start(n, profile_dir)

Start n engines by profile or profile_dir.

start_data

stop()

stop_data

submit_command

An instance of a Python list.

trait_metadata(traitname, key)

Get metadata values for trait by key.

trait_names(**metadata)

Get a list of all the names of this classes traits.

traits(**metadata)

Get a list of all the traits of this class.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

work_dir

A trait for unicode strings.

write_batch_script(n)

Instantiate and write the batch script to the work_dir.

PBSLauncher

class IPython.parallel.apps.launcher.PBSLauncher(work_dir=u'.', config=None, **kwargs)

Bases: IPython.parallel.apps.launcher.BatchSystemLauncher

A BatchSystemLauncher subclass for PBS.

__init__(work_dir=u'.', config=None, **kwargs)

arg_str

The string form of the program arguments.

args

A list of cmd and args that will be used to start the process.

This is what is passed to spawnProcess() and the first element will be the process name.

batch_file

A trait for unicode strings.

batch_file_name

A trait for unicode strings.

batch_template

A trait for unicode strings.

batch_template_file

A trait for unicode strings.

classmethod class_config_section()

Get the config class config section

classmethod class_get_help()

Get the help string for this class in ReST format.

classmethod class_get_trait_help(trait)

Get the help string for a single trait.

classmethod class_print_help()

Get the help string for a single trait and print it.

classmethod class_trait_names(**metadata)

Get a list of all the names of this classes traits.

This method is just like the trait_names() method, but is unbound.

classmethod class_traits(**metadata)

Get a list of all the traits of this class.

This method is just like the traits() method, but is unbound.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

config

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

context

An instance of a Python dict.

created = None

default_template

A trait for unicode strings.

delete_command

An instance of a Python list.

find_args()

formatter

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

job_array_regexp

A trait for unicode strings.

job_array_template

A trait for unicode strings.

job_id_regexp

A trait for unicode strings.

log

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

loop

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

notify_start(data)

Call this to trigger startup actions.

This logs the process startup and sets the state to ‘running’. It is a pass-through so it can be used as a callback.

notify_stop(data)

Call this to trigger process stop actions.

This logs the process stopping and sets the state to ‘after’. Call this to trigger callbacks registered via on_stop().

on_stop(f)

Register a callback to be called with this Launcher’s stop_data when the process actually finishes.

on_trait_change(handler, name=None, remove=False)

Setup a handler to be called when a trait changes.

This is used to setup dynamic notifications of trait changes.

Static handlers can be created by creating methods on a HasTraits subclass with the naming convention ‘_[traitname]_changed’. Thus, to create static handler for the trait ‘a’, create the method _a_changed(self, name, old, new) (fewer arguments can be used, see below).

Parameters :

handler : callable

A callable that is called when a trait changes. Its signature can be handler(), handler(name), handler(name, new) or handler(name, old, new).

name : list, str, None

If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

remove : bool

If False (the default), then install the handler. If True then unintall it.

parse_job_id(output)

Take the output of the submit command and return the job id.

queue

A trait for unicode strings.

queue_regexp

A trait for unicode strings.

queue_template

A trait for unicode strings.

running

Am I running.

signal(sig)

Signal the process.

Parameters :

sig : str or int

‘KILL’, ‘INT’, etc., or any signal number

start(n, profile_dir)

Start n copies of the process using a batch system.

start_data

stop()

stop_data

submit_command

An instance of a Python list.

trait_metadata(traitname, key)

Get metadata values for trait by key.

trait_names(**metadata)

Get a list of all the names of this classes traits.

traits(**metadata)

Get a list of all the traits of this class.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

work_dir

A trait for unicode strings.

write_batch_script(n)

Instantiate and write the batch script to the work_dir.

ProcessStateError

class IPython.parallel.apps.launcher.ProcessStateError

Bases: IPython.parallel.apps.launcher.LauncherError

__init__()

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

args

message

SGEControllerLauncher

class IPython.parallel.apps.launcher.SGEControllerLauncher(work_dir=u'.', config=None, **kwargs)

Bases: IPython.parallel.apps.launcher.SGELauncher

Launch a controller using SGE.

__init__(work_dir=u'.', config=None, **kwargs)

arg_str

The string form of the program arguments.

args

A list of cmd and args that will be used to start the process.

This is what is passed to spawnProcess() and the first element will be the process name.

batch_file

A trait for unicode strings.

batch_file_name

A trait for unicode strings.

batch_template

A trait for unicode strings.

batch_template_file

A trait for unicode strings.

classmethod class_config_section()

Get the config class config section

classmethod class_get_help()

Get the help string for this class in ReST format.

classmethod class_get_trait_help(trait)

Get the help string for a single trait.

classmethod class_print_help()

Get the help string for a single trait and print it.

classmethod class_trait_names(**metadata)

Get a list of all the names of this classes traits.

This method is just like the trait_names() method, but is unbound.

classmethod class_traits(**metadata)

Get a list of all the traits of this class.

This method is just like the traits() method, but is unbound.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

config

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

context

An instance of a Python dict.

created = None

default_template

A trait for unicode strings.

delete_command

An instance of a Python list.

find_args()

formatter

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

job_array_regexp

A trait for unicode strings.

job_array_template

A trait for unicode strings.

job_id_regexp

A trait for unicode strings.

log

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

loop

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

notify_start(data)

Call this to trigger startup actions.

This logs the process startup and sets the state to ‘running’. It is a pass-through so it can be used as a callback.

notify_stop(data)

Call this to trigger process stop actions.

This logs the process stopping and sets the state to ‘after’. Call this to trigger callbacks registered via on_stop().

on_stop(f)

Register a callback to be called with this Launcher’s stop_data when the process actually finishes.

on_trait_change(handler, name=None, remove=False)

Setup a handler to be called when a trait changes.

This is used to setup dynamic notifications of trait changes.

Static handlers can be created by creating methods on a HasTraits subclass with the naming convention ‘_[traitname]_changed’. Thus, to create static handler for the trait ‘a’, create the method _a_changed(self, name, old, new) (fewer arguments can be used, see below).

Parameters :

handler : callable

A callable that is called when a trait changes. Its signature can be handler(), handler(name), handler(name, new) or handler(name, old, new).

name : list, str, None

If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

remove : bool

If False (the default), then install the handler. If True then unintall it.

parse_job_id(output)

Take the output of the submit command and return the job id.

queue

A trait for unicode strings.

queue_regexp

A trait for unicode strings.

queue_template

A trait for unicode strings.

running

Am I running.

signal(sig)

Signal the process.

Parameters :

sig : str or int

‘KILL’, ‘INT’, etc., or any signal number

start(profile_dir)

Start the controller by profile or profile_dir.

start_data

stop()

stop_data

submit_command

An instance of a Python list.

trait_metadata(traitname, key)

Get metadata values for trait by key.

trait_names(**metadata)

Get a list of all the names of this classes traits.

traits(**metadata)

Get a list of all the traits of this class.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

work_dir

A trait for unicode strings.

write_batch_script(n)

Instantiate and write the batch script to the work_dir.

SGEEngineSetLauncher

class IPython.parallel.apps.launcher.SGEEngineSetLauncher(work_dir=u'.', config=None, **kwargs)

Bases: IPython.parallel.apps.launcher.SGELauncher

Launch Engines with SGE

__init__(work_dir=u'.', config=None, **kwargs)

arg_str

The string form of the program arguments.

args

A list of cmd and args that will be used to start the process.

This is what is passed to spawnProcess() and the first element will be the process name.

batch_file

A trait for unicode strings.

batch_file_name

A trait for unicode strings.

batch_template

A trait for unicode strings.

batch_template_file

A trait for unicode strings.

classmethod class_config_section()

Get the config class config section

classmethod class_get_help()

Get the help string for this class in ReST format.

classmethod class_get_trait_help(trait)

Get the help string for a single trait.

classmethod class_print_help()

Get the help string for a single trait and print it.

classmethod class_trait_names(**metadata)

Get a list of all the names of this classes traits.

This method is just like the trait_names() method, but is unbound.

classmethod class_traits(**metadata)

Get a list of all the traits of this class.

This method is just like the traits() method, but is unbound.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

config

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

context

An instance of a Python dict.

created = None

default_template

A trait for unicode strings.

delete_command

An instance of a Python list.

find_args()

formatter

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

job_array_regexp

A trait for unicode strings.

job_array_template

A trait for unicode strings.

job_id_regexp

A trait for unicode strings.

log

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

loop

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

notify_start(data)

Call this to trigger startup actions.

This logs the process startup and sets the state to ‘running’. It is a pass-through so it can be used as a callback.

notify_stop(data)

Call this to trigger process stop actions.

This logs the process stopping and sets the state to ‘after’. Call this to trigger callbacks registered via on_stop().

on_stop(f)

Register a callback to be called with this Launcher’s stop_data when the process actually finishes.

on_trait_change(handler, name=None, remove=False)

Setup a handler to be called when a trait changes.

This is used to setup dynamic notifications of trait changes.

Static handlers can be created by creating methods on a HasTraits subclass with the naming convention ‘_[traitname]_changed’. Thus, to create static handler for the trait ‘a’, create the method _a_changed(self, name, old, new) (fewer arguments can be used, see below).

Parameters :

handler : callable

A callable that is called when a trait changes. Its signature can be handler(), handler(name), handler(name, new) or handler(name, old, new).

name : list, str, None

If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

remove : bool

If False (the default), then install the handler. If True then unintall it.

parse_job_id(output)

Take the output of the submit command and return the job id.

queue

A trait for unicode strings.

queue_regexp

A trait for unicode strings.

queue_template

A trait for unicode strings.

running

Am I running.

signal(sig)

Signal the process.

Parameters :

sig : str or int

‘KILL’, ‘INT’, etc., or any signal number

start(n, profile_dir)

Start n engines by profile or profile_dir.

start_data

stop()

stop_data

submit_command

An instance of a Python list.

trait_metadata(traitname, key)

Get metadata values for trait by key.

trait_names(**metadata)

Get a list of all the names of this classes traits.

traits(**metadata)

Get a list of all the traits of this class.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

work_dir

A trait for unicode strings.

write_batch_script(n)

Instantiate and write the batch script to the work_dir.

SGELauncher

class IPython.parallel.apps.launcher.SGELauncher(work_dir=u'.', config=None, **kwargs)

Bases: IPython.parallel.apps.launcher.PBSLauncher

Sun GridEngine is a PBS clone with slightly different syntax

__init__(work_dir=u'.', config=None, **kwargs)

arg_str

The string form of the program arguments.

args

A list of cmd and args that will be used to start the process.

This is what is passed to spawnProcess() and the first element will be the process name.

batch_file

A trait for unicode strings.

batch_file_name

A trait for unicode strings.

batch_template

A trait for unicode strings.

batch_template_file

A trait for unicode strings.

classmethod class_config_section()

Get the config class config section

classmethod class_get_help()

Get the help string for this class in ReST format.

classmethod class_get_trait_help(trait)

Get the help string for a single trait.

classmethod class_print_help()

Get the help string for a single trait and print it.

classmethod class_trait_names(**metadata)

Get a list of all the names of this classes traits.

This method is just like the trait_names() method, but is unbound.

classmethod class_traits(**metadata)

Get a list of all the traits of this class.

This method is just like the traits() method, but is unbound.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

config

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

context

An instance of a Python dict.

created = None

default_template

A trait for unicode strings.

delete_command

An instance of a Python list.

find_args()

formatter

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

job_array_regexp

A trait for unicode strings.

job_array_template

A trait for unicode strings.

job_id_regexp

A trait for unicode strings.

log

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

loop

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

notify_start(data)

Call this to trigger startup actions.

This logs the process startup and sets the state to ‘running’. It is a pass-through so it can be used as a callback.

notify_stop(data)

Call this to trigger process stop actions.

This logs the process stopping and sets the state to ‘after’. Call this to trigger callbacks registered via on_stop().

on_stop(f)

Register a callback to be called with this Launcher’s stop_data when the process actually finishes.

on_trait_change(handler, name=None, remove=False)

Setup a handler to be called when a trait changes.

This is used to setup dynamic notifications of trait changes.

Static handlers can be created by creating methods on a HasTraits subclass with the naming convention ‘_[traitname]_changed’. Thus, to create static handler for the trait ‘a’, create the method _a_changed(self, name, old, new) (fewer arguments can be used, see below).

Parameters :

handler : callable

A callable that is called when a trait changes. Its signature can be handler(), handler(name), handler(name, new) or handler(name, old, new).

name : list, str, None

If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

remove : bool

If False (the default), then install the handler. If True then unintall it.

parse_job_id(output)

Take the output of the submit command and return the job id.

queue

A trait for unicode strings.

queue_regexp

A trait for unicode strings.

queue_template

A trait for unicode strings.

running

Am I running.

signal(sig)

Signal the process.

Parameters :

sig : str or int

‘KILL’, ‘INT’, etc., or any signal number

start(n, profile_dir)

Start n copies of the process using a batch system.

start_data

stop()

stop_data

submit_command

An instance of a Python list.

trait_metadata(traitname, key)

Get metadata values for trait by key.

trait_names(**metadata)

Get a list of all the names of this classes traits.

traits(**metadata)

Get a list of all the traits of this class.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

work_dir

A trait for unicode strings.

write_batch_script(n)

Instantiate and write the batch script to the work_dir.

SSHControllerLauncher

class IPython.parallel.apps.launcher.SSHControllerLauncher(work_dir=u'.', config=None, **kwargs)

Bases: IPython.parallel.apps.launcher.SSHLauncher

__init__(work_dir=u'.', config=None, **kwargs)

arg_str

The string form of the program arguments.

args

A list of cmd and args that will be used to start the process.

This is what is passed to spawnProcess() and the first element will be the process name.

classmethod class_config_section()

Get the config class config section

classmethod class_get_help()

Get the help string for this class in ReST format.

classmethod class_get_trait_help(trait)

Get the help string for a single trait.

classmethod class_print_help()

Get the help string for a single trait and print it.

classmethod class_trait_names(**metadata)

Get a list of all the names of this classes traits.

This method is just like the trait_names() method, but is unbound.

classmethod class_traits(**metadata)

Get a list of all the traits of this class.

This method is just like the traits() method, but is unbound.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

cmd_and_args

An instance of a Python list.

config

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

created = None

find_args()

handle_stderr(fd, events)

handle_stdout(fd, events)

hostname

A trait for unicode strings.

interrupt_then_kill(delay=2.0)

Send INT, wait a delay and then send KILL.

location

A trait for unicode strings.

log

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

loop

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

notify_start(data)

Call this to trigger startup actions.

This logs the process startup and sets the state to ‘running’. It is a pass-through so it can be used as a callback.

notify_stop(data)

Call this to trigger process stop actions.

This logs the process stopping and sets the state to ‘after’. Call this to trigger callbacks registered via on_stop().

on_stop(f)

Register a callback to be called with this Launcher’s stop_data when the process actually finishes.

on_trait_change(handler, name=None, remove=False)

Setup a handler to be called when a trait changes.

This is used to setup dynamic notifications of trait changes.

Static handlers can be created by creating methods on a HasTraits subclass with the naming convention ‘_[traitname]_changed’. Thus, to create static handler for the trait ‘a’, create the method _a_changed(self, name, old, new) (fewer arguments can be used, see below).

Parameters :

handler : callable

A callable that is called when a trait changes. Its signature can be handler(), handler(name), handler(name, new) or handler(name, old, new).

name : list, str, None

If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

remove : bool

If False (the default), then install the handler. If True then unintall it.

poll()

poll_frequency

A integer trait.

program

An instance of a Python list.

program_args

An instance of a Python list.

running

Am I running.

signal(sig)

ssh_args

An instance of a Python list.

ssh_cmd

An instance of a Python list.

start(profile_dir, hostname=None, user=None)

start_data

stop()

stop_data

trait_metadata(traitname, key)

Get metadata values for trait by key.

trait_names(**metadata)

Get a list of all the names of this classes traits.

traits(**metadata)

Get a list of all the traits of this class.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

user

A trait for unicode strings.

work_dir

A trait for unicode strings.

SSHEngineLauncher

class IPython.parallel.apps.launcher.SSHEngineLauncher(work_dir=u'.', config=None, **kwargs)

Bases: IPython.parallel.apps.launcher.SSHLauncher

__init__(work_dir=u'.', config=None, **kwargs)

arg_str

The string form of the program arguments.

args

A list of cmd and args that will be used to start the process.

This is what is passed to spawnProcess() and the first element will be the process name.

classmethod class_config_section()

Get the config class config section

classmethod class_get_help()

Get the help string for this class in ReST format.

classmethod class_get_trait_help(trait)

Get the help string for a single trait.

classmethod class_print_help()

Get the help string for a single trait and print it.

classmethod class_trait_names(**metadata)

Get a list of all the names of this classes traits.

This method is just like the trait_names() method, but is unbound.

classmethod class_traits(**metadata)

Get a list of all the traits of this class.

This method is just like the traits() method, but is unbound.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

cmd_and_args

An instance of a Python list.

config

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

created = None

find_args()

handle_stderr(fd, events)

handle_stdout(fd, events)

hostname

A trait for unicode strings.

interrupt_then_kill(delay=2.0)

Send INT, wait a delay and then send KILL.

location

A trait for unicode strings.

log

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

loop

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

notify_start(data)

Call this to trigger startup actions.

This logs the process startup and sets the state to ‘running’. It is a pass-through so it can be used as a callback.

notify_stop(data)

Call this to trigger process stop actions.

This logs the process stopping and sets the state to ‘after’. Call this to trigger callbacks registered via on_stop().

on_stop(f)

Register a callback to be called with this Launcher’s stop_data when the process actually finishes.

on_trait_change(handler, name=None, remove=False)

Setup a handler to be called when a trait changes.

This is used to setup dynamic notifications of trait changes.

Static handlers can be created by creating methods on a HasTraits subclass with the naming convention ‘_[traitname]_changed’. Thus, to create static handler for the trait ‘a’, create the method _a_changed(self, name, old, new) (fewer arguments can be used, see below).

Parameters :

handler : callable

A callable that is called when a trait changes. Its signature can be handler(), handler(name), handler(name, new) or handler(name, old, new).

name : list, str, None

If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

remove : bool

If False (the default), then install the handler. If True then unintall it.

poll()

poll_frequency

A integer trait.

program

An instance of a Python list.

program_args

An instance of a Python list.

running

Am I running.

signal(sig)

ssh_args

An instance of a Python list.

ssh_cmd

An instance of a Python list.

start(profile_dir, hostname=None, user=None)

start_data

stop()

stop_data

trait_metadata(traitname, key)

Get metadata values for trait by key.

trait_names(**metadata)

Get a list of all the names of this classes traits.

traits(**metadata)

Get a list of all the traits of this class.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

user

A trait for unicode strings.

work_dir

A trait for unicode strings.

SSHEngineSetLauncher

class IPython.parallel.apps.launcher.SSHEngineSetLauncher(work_dir=u'.', config=None, **kwargs)

Bases: IPython.parallel.apps.launcher.LocalEngineSetLauncher

__init__(work_dir=u'.', config=None, **kwargs)

arg_str

The string form of the program arguments.

args

A list of cmd and args that will be used to start the process.

This is what is passed to spawnProcess() and the first element will be the process name.

classmethod class_config_section()

Get the config class config section

classmethod class_get_help()

Get the help string for this class in ReST format.

classmethod class_get_trait_help(trait)

Get the help string for a single trait.

classmethod class_print_help()

Get the help string for a single trait and print it.

classmethod class_trait_names(**metadata)

Get a list of all the names of this classes traits.

This method is just like the trait_names() method, but is unbound.

classmethod class_traits(**metadata)

Get a list of all the traits of this class.

This method is just like the traits() method, but is unbound.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

config

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

created = None

engine_args

An instance of a Python list.

engines

An instance of a Python dict.

find_args()

interrupt_then_kill(delay=1.0)

launcher_class

alias of SSHEngineLauncher

launchers

An instance of a Python dict.

log

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

loop

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

notify_start(data)

Call this to trigger startup actions.

This logs the process startup and sets the state to ‘running’. It is a pass-through so it can be used as a callback.

notify_stop(data)

Call this to trigger process stop actions.

This logs the process stopping and sets the state to ‘after’. Call this to trigger callbacks registered via on_stop().

on_stop(f)

Register a callback to be called with this Launcher’s stop_data when the process actually finishes.

on_trait_change(handler, name=None, remove=False)

Setup a handler to be called when a trait changes.

This is used to setup dynamic notifications of trait changes.

Static handlers can be created by creating methods on a HasTraits subclass with the naming convention ‘_[traitname]_changed’. Thus, to create static handler for the trait ‘a’, create the method _a_changed(self, name, old, new) (fewer arguments can be used, see below).

Parameters :

handler : callable

A callable that is called when a trait changes. Its signature can be handler(), handler(name), handler(name, new) or handler(name, old, new).

name : list, str, None

If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

remove : bool

If False (the default), then install the handler. If True then unintall it.

running

Am I running.

signal(sig)

start(n, profile_dir)

Start engines by profile or profile_dir. n is ignored, and the engines config property is used instead.

start_data

stop()

stop_data

An instance of a Python dict.

trait_metadata(traitname, key)

Get metadata values for trait by key.

trait_names(**metadata)

Get a list of all the names of this classes traits.

traits(**metadata)

Get a list of all the traits of this class.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

work_dir

A trait for unicode strings.

SSHLauncher

class IPython.parallel.apps.launcher.SSHLauncher(work_dir=u'.', config=None, **kwargs)

Bases: IPython.parallel.apps.launcher.LocalProcessLauncher

A minimal launcher for ssh.

To be useful this will probably have to be extended to use the sshx idea for environment variables. There could be other things this needs as well.

__init__(work_dir=u'.', config=None, **kwargs)

arg_str

The string form of the program arguments.

args

A list of cmd and args that will be used to start the process.

This is what is passed to spawnProcess() and the first element will be the process name.

classmethod class_config_section()

Get the config class config section

classmethod class_get_help()

Get the help string for this class in ReST format.

classmethod class_get_trait_help(trait)

Get the help string for a single trait.

classmethod class_print_help()

Get the help string for a single trait and print it.

classmethod class_trait_names(**metadata)

Get a list of all the names of this classes traits.

This method is just like the trait_names() method, but is unbound.

classmethod class_traits(**metadata)

Get a list of all the traits of this class.

This method is just like the traits() method, but is unbound.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

cmd_and_args

An instance of a Python list.

config

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

created = None

find_args()

handle_stderr(fd, events)

handle_stdout(fd, events)

hostname

A trait for unicode strings.

interrupt_then_kill(delay=2.0)

Send INT, wait a delay and then send KILL.

location

A trait for unicode strings.

log

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

loop

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

notify_start(data)

Call this to trigger startup actions.

This logs the process startup and sets the state to ‘running’. It is a pass-through so it can be used as a callback.

notify_stop(data)

Call this to trigger process stop actions.

This logs the process stopping and sets the state to ‘after’. Call this to trigger callbacks registered via on_stop().

on_stop(f)

Register a callback to be called with this Launcher’s stop_data when the process actually finishes.

on_trait_change(handler, name=None, remove=False)

Setup a handler to be called when a trait changes.

This is used to setup dynamic notifications of trait changes.

Static handlers can be created by creating methods on a HasTraits subclass with the naming convention ‘_[traitname]_changed’. Thus, to create static handler for the trait ‘a’, create the method _a_changed(self, name, old, new) (fewer arguments can be used, see below).

Parameters :

handler : callable

A callable that is called when a trait changes. Its signature can be handler(), handler(name), handler(name, new) or handler(name, old, new).

name : list, str, None

If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

remove : bool

If False (the default), then install the handler. If True then unintall it.

poll()

poll_frequency

A integer trait.

program

An instance of a Python list.

program_args

An instance of a Python list.

running

Am I running.

signal(sig)

ssh_args

An instance of a Python list.

ssh_cmd

An instance of a Python list.

start(profile_dir, hostname=None, user=None)

start_data

stop()

stop_data

trait_metadata(traitname, key)

Get metadata values for trait by key.

trait_names(**metadata)

Get a list of all the names of this classes traits.

traits(**metadata)

Get a list of all the traits of this class.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

user

A trait for unicode strings.

work_dir

A trait for unicode strings.

UnknownStatus

class IPython.parallel.apps.launcher.UnknownStatus

Bases: IPython.parallel.apps.launcher.LauncherError

__init__()

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

args

message

WindowsHPCControllerLauncher

class IPython.parallel.apps.launcher.WindowsHPCControllerLauncher(work_dir=u'.', config=None, **kwargs)

Bases: IPython.parallel.apps.launcher.WindowsHPCLauncher

__init__(work_dir=u'.', config=None, **kwargs)

arg_str

The string form of the program arguments.

args

A list of cmd and args that will be used to start the process.

This is what is passed to spawnProcess() and the first element will be the process name.

classmethod class_config_section()

Get the config class config section

classmethod class_get_help()

Get the help string for this class in ReST format.

classmethod class_get_trait_help(trait)

Get the help string for a single trait.

classmethod class_print_help()

Get the help string for a single trait and print it.

classmethod class_trait_names(**metadata)

Get a list of all the names of this classes traits.

This method is just like the trait_names() method, but is unbound.

classmethod class_traits(**metadata)

Get a list of all the traits of this class.

This method is just like the traits() method, but is unbound.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

config

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

created = None

extra_args

An instance of a Python list.

find_args()

job_cmd

A trait for unicode strings.

job_file

job_file_name

A trait for unicode strings.

job_id_regexp

A trait for unicode strings.

log

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

loop

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

notify_start(data)

Call this to trigger startup actions.

This logs the process startup and sets the state to ‘running’. It is a pass-through so it can be used as a callback.

notify_stop(data)

Call this to trigger process stop actions.

This logs the process stopping and sets the state to ‘after’. Call this to trigger callbacks registered via on_stop().

on_stop(f)

Register a callback to be called with this Launcher’s stop_data when the process actually finishes.

on_trait_change(handler, name=None, remove=False)

Setup a handler to be called when a trait changes.

This is used to setup dynamic notifications of trait changes.

Static handlers can be created by creating methods on a HasTraits subclass with the naming convention ‘_[traitname]_changed’. Thus, to create static handler for the trait ‘a’, create the method _a_changed(self, name, old, new) (fewer arguments can be used, see below).

Parameters :

handler : callable

A callable that is called when a trait changes. Its signature can be handler(), handler(name), handler(name, new) or handler(name, old, new).

name : list, str, None

If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

remove : bool

If False (the default), then install the handler. If True then unintall it.

parse_job_id(output)

Take the output of the submit command and return the job id.

running

Am I running.

scheduler

A trait for unicode strings.

signal(sig)

Signal the process.

Parameters :

sig : str or int

‘KILL’, ‘INT’, etc., or any signal number

start(profile_dir)

Start the controller by profile_dir.

start_data

stop()

stop_data

trait_metadata(traitname, key)

Get metadata values for trait by key.

trait_names(**metadata)

Get a list of all the names of this classes traits.

traits(**metadata)

Get a list of all the traits of this class.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

work_dir

A trait for unicode strings.

write_job_file(n)

WindowsHPCEngineSetLauncher

class IPython.parallel.apps.launcher.WindowsHPCEngineSetLauncher(work_dir=u'.', config=None, **kwargs)

Bases: IPython.parallel.apps.launcher.WindowsHPCLauncher

__init__(work_dir=u'.', config=None, **kwargs)

arg_str

The string form of the program arguments.

args

A list of cmd and args that will be used to start the process.

This is what is passed to spawnProcess() and the first element will be the process name.

classmethod class_config_section()

Get the config class config section

classmethod class_get_help()

Get the help string for this class in ReST format.

classmethod class_get_trait_help(trait)

Get the help string for a single trait.

classmethod class_print_help()

Get the help string for a single trait and print it.

classmethod class_trait_names(**metadata)

Get a list of all the names of this classes traits.

This method is just like the trait_names() method, but is unbound.

classmethod class_traits(**metadata)

Get a list of all the traits of this class.

This method is just like the traits() method, but is unbound.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

config

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

created = None

extra_args

An instance of a Python list.

find_args()

job_cmd

A trait for unicode strings.

job_file

job_file_name

A trait for unicode strings.

job_id_regexp

A trait for unicode strings.

log

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

loop

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

notify_start(data)

Call this to trigger startup actions.

This logs the process startup and sets the state to ‘running’. It is a pass-through so it can be used as a callback.

notify_stop(data)

Call this to trigger process stop actions.

This logs the process stopping and sets the state to ‘after’. Call this to trigger callbacks registered via on_stop().

on_stop(f)

Register a callback to be called with this Launcher’s stop_data when the process actually finishes.

on_trait_change(handler, name=None, remove=False)

Setup a handler to be called when a trait changes.

This is used to setup dynamic notifications of trait changes.

Static handlers can be created by creating methods on a HasTraits subclass with the naming convention ‘_[traitname]_changed’. Thus, to create static handler for the trait ‘a’, create the method _a_changed(self, name, old, new) (fewer arguments can be used, see below).

Parameters :

handler : callable

A callable that is called when a trait changes. Its signature can be handler(), handler(name), handler(name, new) or handler(name, old, new).

name : list, str, None

If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

remove : bool

If False (the default), then install the handler. If True then unintall it.

parse_job_id(output)

Take the output of the submit command and return the job id.

running

Am I running.

scheduler

A trait for unicode strings.

signal(sig)

Signal the process.

Parameters :

sig : str or int

‘KILL’, ‘INT’, etc., or any signal number

start(n, profile_dir)

Start the controller by profile_dir.

start_data

stop()

stop_data

trait_metadata(traitname, key)

Get metadata values for trait by key.

trait_names(**metadata)

Get a list of all the names of this classes traits.

traits(**metadata)

Get a list of all the traits of this class.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

work_dir

A trait for unicode strings.

write_job_file(n)

WindowsHPCLauncher

class IPython.parallel.apps.launcher.WindowsHPCLauncher(work_dir=u'.', config=None, **kwargs)

Bases: IPython.parallel.apps.launcher.BaseLauncher

__init__(work_dir=u'.', config=None, **kwargs)

arg_str

The string form of the program arguments.

args

A list of cmd and args that will be used to start the process.

This is what is passed to spawnProcess() and the first element will be the process name.

classmethod class_config_section()

Get the config class config section

classmethod class_get_help()

Get the help string for this class in ReST format.

classmethod class_get_trait_help(trait)

Get the help string for a single trait.

classmethod class_print_help()

Get the help string for a single trait and print it.

classmethod class_trait_names(**metadata)

Get a list of all the names of this classes traits.

This method is just like the trait_names() method, but is unbound.

classmethod class_traits(**metadata)

Get a list of all the traits of this class.

This method is just like the traits() method, but is unbound.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

config

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

created = None

find_args()

job_cmd

A trait for unicode strings.

job_file

job_file_name

A trait for unicode strings.

job_id_regexp

A trait for unicode strings.

log

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

loop

A trait whose value must be an instance of a specified class.

The value can also be an instance of a subclass of the specified class.

notify_start(data)

Call this to trigger startup actions.

This logs the process startup and sets the state to ‘running’. It is a pass-through so it can be used as a callback.

notify_stop(data)

Call this to trigger process stop actions.

This logs the process stopping and sets the state to ‘after’. Call this to trigger callbacks registered via on_stop().

on_stop(f)

Register a callback to be called with this Launcher’s stop_data when the process actually finishes.

on_trait_change(handler, name=None, remove=False)

Setup a handler to be called when a trait changes.

This is used to setup dynamic notifications of trait changes.

Static handlers can be created by creating methods on a HasTraits subclass with the naming convention ‘_[traitname]_changed’. Thus, to create static handler for the trait ‘a’, create the method _a_changed(self, name, old, new) (fewer arguments can be used, see below).

Parameters :

handler : callable

A callable that is called when a trait changes. Its signature can be handler(), handler(name), handler(name, new) or handler(name, old, new).

name : list, str, None

If None, the handler will apply to all traits. If a list of str, handler will apply to all names in the list. If a str, the handler will apply just to that name.

remove : bool

If False (the default), then install the handler. If True then unintall it.

parse_job_id(output)

Take the output of the submit command and return the job id.

running

Am I running.

scheduler

A trait for unicode strings.

signal(sig)

Signal the process.

Parameters :

sig : str or int

‘KILL’, ‘INT’, etc., or any signal number

start(n)

Start n copies of the process using the Win HPC job scheduler.

start_data

stop()

stop_data

trait_metadata(traitname, key)

Get metadata values for trait by key.

trait_names(**metadata)

Get a list of all the names of this classes traits.

traits(**metadata)

Get a list of all the traits of this class.

The TraitTypes returned don’t know anything about the values that the various HasTrait’s instances are holding.

This follows the same algorithm as traits does and does not allow for any simple way of specifying merely that a metadata name exists, but has any value. This is because get_metadata returns None if a metadata key doesn’t exist.

work_dir

A trait for unicode strings.

write_job_file(n)

Function

IPython.parallel.apps.launcher.find_job_cmd()