1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
|
ecflow.JobCreationCtrl
//////////////////////
.. py:class:: JobCreationCtrl
:module: ecflow
Bases: :py:class:`~Boost.Python.instance`
The class JobCreationCtrl is used in `job creation` checking
Constructor::
JobCreationCtrl()
Usage:
.. code-block:: python
defs = Defs('my.def') # specify the definition we want to check, load into memory
job_ctrl = JobCreationCtrl()
job_ctrl.set_node_path('/suite/to_check') # will hierarchically check job creation under this node
defs.check_job_creation(job_ctrl) # job files generated to ECF_JOB
print(job_ctrl.get_error_msg()) # report any errors in job generation
job_ctrl = JobCreationCtrl() # no set_node_path() hence check job creation for all tasks
job_ctrl.set_dir_for_job_creation(tmp) # generate jobs file under this directory
defs.check_job_creation(job_ctrl)
print(job_ctrl.get_error_msg())
job_ctrl = JobCreationCtrl() # no set_node_path() hence check job creation for all tasks
job_ctrl.generate_temp_dir() # automatically generate directory for job file
defs.check_job_creation(job_ctrl)
print(job_ctrl.get_error_msg())
.. py:method:: JobCreationCtrl.generate_temp_dir( (JobCreationCtrl)arg1) -> None :
:module: ecflow
Automatically generated temporary directory for job creation. Directory written to stdout for information
.. py:method:: JobCreationCtrl.get_dir_for_job_creation( (JobCreationCtrl)arg1) -> str :
:module: ecflow
Returns the directory set for job creation
.. py:method:: JobCreationCtrl.get_error_msg( (JobCreationCtrl)arg1) -> str :
:module: ecflow
Returns an error message generated during checking of job creation
.. py:method:: JobCreationCtrl.set_dir_for_job_creation( (JobCreationCtrl)arg1, (str)arg2) -> None :
:module: ecflow
Specify directory, for job creation
.. py:method:: JobCreationCtrl.set_node_path( (JobCreationCtrl)arg1, (str)arg2) -> None :
:module: ecflow
The node we want to check job creation for. If no node specified check all tasks
.. py:method:: JobCreationCtrl.set_verbose( (JobCreationCtrl)arg1, (bool)arg2) -> None :
:module: ecflow
Output each task as its being checked.
|
