Basf2IPythonHandler Class Reference

Inheritance diagram for Basf2IPythonHandler:

Public Member Functions
def	__init__ (self)
def	process (self, path, result_queue=None, max_event=0)

Static Public Member Functions
def	style ()

Public Attributes
	information
	A shortcut for returning information on the ipython_handler_basf2 environment.
	modules
	A shortcut for returning module information.

Protected Attributes
	_calculation_type
	Use our own calculation type.

Detailed Description

Handler class to start processes in an IPython notebook in a convenient way.
From this whole framework you should not need to create any instances by yourself but rather use the
given ipython handler for this.

Usage
-----

Create a handler object in the beginning of your NB and use the two methods `process`
and `process_parameter_space` to turn a path or a path creator function into a Basf2Calculation.
Do not create calculations on you own.

    from tracking.validation.ipython_handler import handler

    path = ...

    calculation = handler.process(path)

Definition at line 14 of file ipython_handler.py.

Constructor & Destructor Documentation

__init__()

def __init__

(

self

)

Set the ipython_handler_basf2 related shortcuts.

Reimplemented from IPythonHandler.

Definition at line 35 of file ipython_handler.py.

    def __init__(self):
        """
        Set the ipython_handler_basf2 related shortcuts.
        """
        super().__init__()
 
        
        self.information = Basf2EnvironmentInformation()
 
        
        self.modules = Basf2ModulesInformation()
 
        
        self._calculation_type = Basf2Calculation
 

Member Function Documentation

process()

def process	(		self,
			path,
			result_queue = None,
			max_event = 0
	)

Shortcut for convenience.

Reimplemented from IPythonHandler.

Definition at line 50 of file ipython_handler.py.

    def process(self, path, result_queue=None, max_event=0):
        """
        Shortcut for convenience.
        """
        return IPythonHandler.process(self, result_queue=result_queue, path=path, max_event=max_event)
 

style()

def style ( )

static

Show a nice styling :-)

Definition at line 57 of file ipython_handler.py.

    def style():
        """
        Show a nice styling :-)
        """
        styling_widget = StylingWidget()
        styling_widget.show()

Member Data Documentation

_calculation_type

_calculation_type

protected

Use our own calculation type.

Definition at line 48 of file ipython_handler.py.

information

information

A shortcut for returning information on the ipython_handler_basf2 environment.

Definition at line 42 of file ipython_handler.py.

modules

modules

A shortcut for returning module information.

Definition at line 45 of file ipython_handler.py.

---

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

• framework/scripts/hep_ipython_tools/ipython_handler_basf2/ipython_handler.py