ivy package

Subpackages

• cli Package
  • cli Package
  • main Module
• config Package
  • base_config Module
• exceptions Package
  • exceptions Module
• plugin Package
  • base_plugin Module
  • parallel_plugin_collection Module
  • plugin_factory Module
• utils Package
  • stop_criteria Module
  • struct Module
  • utils Module

Submodules

ivy.backend module

Created on Mar 18, 2014

author: jakeret

class ivy.backend.IpClusterBackend(ctx)

Bases: object

Backend based on IPython cluster. Will distribute the workload among the available engines.

run(loop, mapPlugin)

class ivy.backend.JoblibBackend(ctx)

Bases: object

Backend based on the joblib package Will instantiate a multiprocessing pool with ctx.params.cpu_count processes.

run(loop, mapPlugin)

class ivy.backend.LoopWrapper(loop, parallel=False)

Bases: object

Callable wrapper for the loop execution

class ivy.backend.MultiprocessingBackend(ctx)

Bases: object

Backend based on Python’s multiprocessing. Will instantiate a multiprocessing pool with ctx.params.cpu_count processes.

run(loop, mapPlugin)

class ivy.backend.SequentialBackend(ctx)

Bases: object

Simple implementation of a backend executing the plugins in a sequential order

run(loop, mapPlugin=None)

class ivy.backend.SimpleMapPlugin(ctx)

Bases: object

getWorkload()

ivy.backend.create(ctx, force=None)

Simple factory instantiating backends for the given name in ctx.params.backend

ivy.context module

ivy.context.ctx()

Returns the current global namespace context.

Returns:reference to the context module

ivy.context.loopCtx(loop)

ivy.context_provider module

Created on Mar 6, 2014

author: jakeret

class ivy.context_provider.DefaultContextProvider

Bases: object

Default implementation of a context provider. Creates a simple mutable struct as ctx and doesn’t persist the context.

static createContext(**args)

Returns a Struct

static createImmutableContext(**args)

Returns a Struct

static storeContext()

Dummy method. Nothing is stored

class ivy.context_provider.PickleContextProvider

Bases: ivy.context_provider.DefaultContextProvider

Extends the DefaultContextProvider. Persists the context to the disk by using pickle. Requires the attribute ‘ctx_file_name’ in the ctx

static storeContext()

Writes the current ctx to the disk

ivy.loop module

Created on Mar 4, 2014

author: jakeret

class ivy.loop.Loop(pluginList, stop=None, ctx=None)

Bases: object

Implementation of a loop.

Parameters:

• pluginList – List of plugin or inner Loop
• stop – (optional) stop criteria

next()

Returns the next plugin. Allows for using a Loop as an iter

reset()

Resets the internal state of the loop

ivy.workflow_manager module

Created on Mar 4, 2014

author: jakeret

class ivy.workflow_manager.WorkflowManager(argv)

Bases: object

Manages the workflow process by loading the passed config and parsing the passed arguments and then iterating thru the plugins.

Parameters:argv – arguments to use

launch()

Launches the workflow

ivy.workflow_manager.loadConfigs(configs)

Loads key-value configurations from Python modules.

Parameters:configs – string or list of strings with absolute module declaration e.g. “ivy.config.base_config Return config:a Struct instance with the config attributes

Module contents

ivy.execute(args)

Runs a workflow for the given arguments. :param args: list of arguments which should be passed to ivy. The last argument has to be the config

Returns:the global_ctx

ivy.reduce_method(m)