wirecell.command.WireCell Class Reference

Public Member Functions
def	__init__ (self, executable='wire-cell', kwds)
def	cmdline (self, app=None)
def	__call__ (self, app=None, config=None)
def	component_configlist (self, components)

Public Attributes
	prog
	plugins
	config
	app

Static Public Attributes
list	default_plugins = ['WireCellAlg', 'WireCellGen', 'WireCellApps', 'WireCellTbb']

Detailed Description

Python interface to wire-cell executable.

Beware, this trusts its input!  In particular do not let
<executable> be set by untrusted sources.

Definition at line 88 of file command.py.

Constructor & Destructor Documentation

def wirecell.command.WireCell.__init__	(		self,
			executable = 'wire-cell',
			kwds
	)

Definition at line 97 of file command.py.

    def __init__(self, executable='wire-cell', **kwds):
        self.prog = executable
        self.plugins = kwds.pop('plugins', self.default_plugins)
        self.config = Config(**kwds)
        self.app = kwds.get('app',None)

Member Function Documentation

def wirecell.command.WireCell.__call__	(		self,
			app = None,
			config = None
	)

Run wire-cell.

If app is not given then fall back to one given to constructor.

If any config is given it is merged with any given to constructor.

Definition at line 114 of file command.py.

    def __call__(self, app=None, config=None):
        '''Run wire-cell.

        If app is not given then fall back to one given to constructor.

        If any config is given it is merged with any given to constructor.

        '''
        cmd = self.cmdline(app)
        #print 'CMD:\n%s'%cmd
        cfg = self.config.merge(config).wcjson()
        #print 'CFG:\n%s'%cfg        
        proc = subprocess.Popen(cmd, shell=True, 
                                stdin = subprocess.PIPE,
                                stdout = subprocess.PIPE,
                                stderr = subprocess.PIPE)
        out,err= proc.communicate(cfg)
        #print 'OUT:\n%s'%out
        #print 'ERR:\n%s'%err
        return out,err
        

def wirecell.command.WireCell.cmdline	(		self,
			app = None
	)

Return command line string

Definition at line 103 of file command.py.

    def cmdline(self, app=None):
        '''
        Return command line string
        '''
        parts = ['%s -c /dev/stdin' % self.prog]
        parts += ['-p %s'%p for p in self.plugins]
        app = app or self.app
        if app:
            parts.append('-a %s' % app)
        return ' '.join(parts)

def wirecell.command.WireCell.component_configlist	(		self,
			components
	)

Return a config list giving configuration for components

Definition at line 135 of file command.py.

    def component_configlist(self, *components):
        '''
        Return a config list giving configuration for components
        '''
        config = Config()
        config.load_one("ConfigDumper","", data=dict(components = components))
        o,e = self("ConfigDumper", config=config)
        return json.loads(o)
        

Member Data Documentation

wirecell.command.WireCell.app

Definition at line 101 of file command.py.

wirecell.command.WireCell.config

Definition at line 100 of file command.py.

list wirecell.command.WireCell.default_plugins = ['WireCellAlg', 'WireCellGen', 'WireCellApps', 'WireCellTbb']

static

Definition at line 95 of file command.py.

wirecell.command.WireCell.plugins

Definition at line 99 of file command.py.

wirecell.command.WireCell.prog

Definition at line 98 of file command.py.

---

The documentation for this class was generated from the following file:

• wire-cell-build/python/wirecell/command.py

---

Generated by   1.8.11