|
HPS-MC
|
|
|
HPS-MC
|
|
Abstract component to hold shared functionality for compoents that edit the detectors in hps-java. More...
Public Member Functions | |
| __init__ (self, name, **kwargs) | |
| required_config (self) | |
| Return a list of required configuration settings. | |
| required_parameters (self) | |
| Return a list of required parameters. | |
| optional_parameters (self) | |
| Return a list of optional parameters. | |
 Public Member Functions inherited from Component | |
| cmd_line_str (self) | |
| execute (self, log_out=sys.stdout, log_err=sys.stderr) | |
| Generic component execution method. | |
| cmd_exists (self) | |
| Check if the component's assigned command exists. | |
| cmd_args (self) | |
| Return the command arguments of this component. | |
| cmd_args_str (self) | |
| Return list of arguments, making sure they are all converted to strings. | |
| setup (self) | |
| Perform any necessary setup for this component to run such as making symlinks to required directories. | |
| cleanup (self) | |
| Perform post-job cleanup such as deleting temporary files. | |
| config_logging (self, parser) | |
| Configure the logging for a component. | |
| config (self, parser) | |
| Automatic configuration. | |
| set_parameters (self, params) | |
| Set class attributes for the component based on JSON parameters. | |
| check_config (self) | |
| Raise an exception on the first missing config setting for this component. | |
| input_files (self) | |
| Get a list of input files for this component. | |
| output_files (self) | |
| Return a list of output files created by this component. | |
| config_from_environ (self) | |
| Configure component from environment variables which are just upper case versions of the required config names set in the shell environment. | |
Public Attributes | |
| java_dir | |
| detector | |
| next_detector | |
| force | |
| Public Attributes inherited from Component | |
| name | |
| command | |
| nevents | |
| seed | |
| inputs | |
| outputs | |
| append_tok | |
| output_ext | |
| ignore_job_params | |
| hpsmc_dir | |
| logger | |
Protected Member Functions | |
| _detector_dir (self, det_name) | |
| _deduce_next_detector (self, bump=False) | |
| deduce what the next detector should be given how the component has been configured | |
| _to_compact (self, parameter_set, detname, save_prev=True, prev_ext='prev') | |
| write the input parameter set into the input compact.xml file | |
| _update_readme (self, detname, msg) | |
| Update the readme for the passed detector name. | |
| Protected Member Functions inherited from Component | |
| _inputs_to_outputs (self) | |
| This is the default method for automatically transforming input file names to outputs when output file names are not explicitly provided. | |
Abstract component to hold shared functionality for compoents that edit the detectors in hps-java.
This component should never be used directly.
Required Config:
Required Job:
Optional Parameters:
| __init__ | ( | self, | |
| name, | |||
| ** | kwargs | ||
| ) |
Reimplemented from Component.
Reimplemented in ApplyPedeRes, WriteMisalignedDet, and ConstructDetector.
|
protected |
|
protected |
write the input parameter set into the input compact.xml file
Update the millepede parameters in the destination compact.xml with the parameters stored in the parameter_set map.
parameter_set : dict dict mapping parameter ID number to Parameter instance detname : str name of detector whose compact.xml we should edit save_prev : bool, optional whether to save a copy of the original compact.xml before we edited it prev_ext : str, optional extension to add to the original compact.xml if it is being saved
|
protected |
| optional_parameters | ( | self | ) |
Return a list of optional parameters.
Optional parameters are: nevents, seed
Reimplemented from Component.
Reimplemented in ApplyPedeRes, and ConstructDetector.
| required_config | ( | self | ) |
Return a list of required configuration settings.
There are none by default.
Reimplemented from Component.
Reimplemented in WriteMisalignedDet, and ConstructDetector.
| required_parameters | ( | self | ) |
Return a list of required parameters.
The job will fail if these are not present in the JSON file.
Reimplemented from Component.
Reimplemented in WriteMisalignedDet.
1.9.8