Base class for external processes.
More...
|
def | __init__ (self, name, *executable_path) |
| Constructor. More...
|
|
def | needs_scheduling (self, process) |
| Report whether this external process should be scheduled. More...
|
|
def | add_keyword (self, keyword, value=None, name=None, frozen=None, hidden=None, description=None, **kwargs) |
| Register configurable parameter that is exposed to the user. More...
|
|
def | expose (self) |
| Add all names to the interface of this object. More...
|
|
def | has_keyword (self, keyword) |
|
def | has_parameter (self, parameter) |
|
def | parameters_by_keyword (self, keyword) |
| Retrieve all parameters that use a given keyword. More...
|
|
def | parameters_by_name (self, name) |
| Retrieve all parameters that use a given name. More...
|
|
Base class for external processes.
All external processes inherit from this class.
- Author
- James Robinson james.nosp@m..rob.nosp@m.inson.nosp@m.@cer.nosp@m.n.ch
Definition at line 11 of file external_base.py.
◆ __init__()
def python.processes.external.external_base.ExternalBase.__init__ |
( |
|
self, |
|
|
|
name, |
|
|
* |
executable_path |
|
) |
| |
Constructor.
- Parameters
-
name | name of this external process. |
executable_path | path to appropriate PowhegBox executable. |
Definition at line 19 of file external_base.py.
19 def __init__(self, name, *executable_path):
22 @param name name of this external process.
23 @param executable_path path to appropriate PowhegBox executable.
32 self.executable = os.path.join(*executable_path)
34 self.executable =
None
◆ add_keyword()
def python.processes.configurable.Configurable.add_keyword |
( |
|
self, |
|
|
|
keyword, |
|
|
|
value = None , |
|
|
|
name = None , |
|
|
|
frozen = None , |
|
|
|
hidden = None , |
|
|
|
description = None , |
|
|
** |
kwargs |
|
) |
| |
|
inherited |
Register configurable parameter that is exposed to the user.
- Parameters
-
keyword | Powheg keyword that gets written to the runcard. |
value | Value of the parameter. |
name | Configurable parameter name exposed to the user. |
hidden | True if this parameter should be hidden from the user. |
frozen | True if this parameter cannot be changed. |
description | Description for the run card. |
parameter | Name used in the run card if different. |
Definition at line 21 of file configurable.py.
21 def add_keyword(self, keyword, value=None, name=None, frozen=None, hidden=None, description=None, **kwargs):
22 """! Register configurable parameter that is exposed to the user.
24 @param keyword Powheg keyword that gets written to the runcard.
25 @param value Value of the parameter.
26 @param name Configurable parameter name exposed to the user.
27 @param hidden True if this parameter should be hidden from the user.
28 @param frozen True if this parameter cannot be changed.
29 @param description Description for the run card.
30 @param parameter Name used in the run card if different.
33 defaults = Registry().get_defaults(keyword)
34 if value == defaults[
"value"]
and value
is not None and (hidden
is not True):
35 if keyword
not in [
"ebeam1",
"ebeam2"]:
36 logger.debug(
"Unnecessarily setting parameter {} to {} which is its default value!".
format(keyword, value))
37 value = [value, defaults[
"value"]][value
is None]
38 name = [name, defaults[
"name"]][name
is None]
39 description = [description, defaults[
"description"]][description
is None]
40 hidden = [hidden, defaults[
"hidden"]][hidden
is None]
41 frozen = [frozen, defaults[
"frozen"]][frozen
is None]
42 if keyword
in [p.keyword
for p
in self.parameters]:
43 raise AttributeError(
"Keyword '{}' has already been defined for this process".
format(keyword))
44 self.parameters.
append(Parameter(keyword, name=name, value=value, frozen=frozen, hidden=hidden, description=description, **kwargs))
◆ expose()
def python.processes.configurable.Configurable.expose |
( |
|
self | ) |
|
|
inherited |
Add all names to the interface of this object.
Definition at line 46 of file configurable.py.
47 """! Add all names to the interface of this object."""
48 for parameter
in self.parameters:
49 setattr(self, parameter.name, parameter.value)
◆ has_keyword()
def python.processes.configurable.Configurable.has_keyword |
( |
|
self, |
|
|
|
keyword |
|
) |
| |
|
inherited |
Definition at line 51 of file configurable.py.
52 return (len(
list(self.parameters_by_keyword(keyword))) > 0)
◆ has_parameter()
def python.processes.configurable.Configurable.has_parameter |
( |
|
self, |
|
|
|
parameter |
|
) |
| |
|
inherited |
Definition at line 54 of file configurable.py.
55 return (len(
list(self.parameters_by_name(parameter))) > 0)
◆ needs_scheduling()
def python.processes.external.external_base.ExternalBase.needs_scheduling |
( |
|
self, |
|
|
|
process |
|
) |
| |
◆ parameters_by_keyword()
def python.processes.configurable.Configurable.parameters_by_keyword |
( |
|
self, |
|
|
|
keyword |
|
) |
| |
|
inherited |
Retrieve all parameters that use a given keyword.
- Parameters
-
keyword | Powheg keyword that gets written to the runcard. |
Definition at line 57 of file configurable.py.
58 """! Retrieve all parameters that use a given keyword.
60 @param keyword Powheg keyword that gets written to the runcard.
62 return [p
for p
in self.parameters
if p.keyword == keyword]
◆ parameters_by_name()
def python.processes.configurable.Configurable.parameters_by_name |
( |
|
self, |
|
|
|
name |
|
) |
| |
|
inherited |
Retrieve all parameters that use a given name.
- Parameters
-
Definition at line 64 of file configurable.py.
65 """! Retrieve all parameters that use a given name.
67 @param name Configurable parameter name exposed to the user.
69 return [p
for p
in self.parameters
if p.name == name]
◆ executable
python.processes.external.external_base.ExternalBase.executable |
◆ name
python.processes.external.external_base.ExternalBase.name |
◆ parameters
python.processes.configurable.Configurable.parameters |
|
inherited |
The documentation for this class was generated from the following file:
def add_keyword(self, keyword, value=None, name=None, frozen=None, hidden=None, description=None, **kwargs)
Register configurable parameter that is exposed to the user.