Process opals jobs using the ipyparallel (ipp) framework. More...
Inheritance diagram for ipp:Public Member Functions | |
| def | __init__ (self, **kwargs) |
| Instantiates an ipyparallel client object. More... | |
| def | __del__ (self) |
| def | join (self, raiseExceptions=True) |
| Waits for all incomplete runs to be finished. More... | |
| def | close (self) |
| Closes the ipp client. More... | |
Public Member Functions inherited from distributedBase | |
| def | __init__ (self) |
| Instantiates the distributed base Object. More... | |
| def | submit (self, module=None, finishedText=None, userData=None, arglist=None) |
| Submits modules to the processor which are then run. More... | |
| def | execute_all (self, module=None, finishedText=None, userData=None, raiseExceptions=True) |
| For tasks which should be exectued on all working machines (for clean up Tasks e.g.) :param module: input module (might be none, if the module should not be run because the output already exists. More... | |
| def | submit_and_join (self, module=None, finishedText=None, userData=None, raiseExceptions=True) |
| Module is submitted to a worker, then waits until all the processes are finished. More... | |
| def | __len__ (self) |
| Enables length query of the multiprocessor object :return: length of the result list. More... | |
| def | __getitem__ (self, idx) |
| Enables index queries of the multiprocessor object :param: index of the desired module :return: the module itself. More... | |
| def | was_successful (self, idx) |
| Gives information about whether or not a module run was successful :param idx: index of the module :return: Boolean. More... | |
| def | get_result (self, idx) |
| Returns the result of a module run :param idx: index of the module :return : either the result of the module or an exception that occured during that module run. More... | |
| def | get_userdata (self, idx) |
| Returns the userdata back to the user. More... | |
| def | get_error (self, idx) |
| Returns an exception that occured during a module run :param: index of a module :return: exception. More... | |
| def | clear (self, logger=None) |
| Clears the processor, i.e. More... | |
Public Member Functions inherited from processorInterface | |
| def | submit (self) |
| def | submit_and_join (self) |
| def | join (self) |
| def | clear (self) |
| def | execute_all (self) |
Public Attributes | |
| client | |
| lview | |
| not_joined_yet | |
| succesful_tasks | |
| unsuccessful_tasks | |
| engine_died_tasks | |
| exceptions | |
| dview | |
Public Attributes inherited from distributedBase | |
| results | |
| logger | |
| not_joined_yet | |
Process opals jobs using the ipyparallel (ipp) framework.
| def __init__ | ( | self, | |
| ** | kwargs | ||
| ) |
Instantiates an ipyparallel client object.
:param kwargs: optional ipp client instantiation parameters :return: None
References ipp.client, ipp.lview, local.not_joined_yet, and distributedBase.not_joined_yet.
| def close | ( | self | ) |
| def join | ( | self, | |
raiseExceptions = True |
|||
| ) |
Waits for all incomplete runs to be finished.
:param raiseExceptions: if True, exceptions are raised :return: None
Reimplemented from distributedBase.
References ipp.client, ipp.dview, ipp.engine_died_tasks, ipp.exceptions, local.logger, distributedBase.logger, ipp.lview, local.not_joined_yet, distributedBase.not_joined_yet, local.results, distributedBase.results, ipp.succesful_tasks, and ipp.unsuccessful_tasks.