Skip to content

Commit

Permalink
document
Browse files Browse the repository at this point in the history
  • Loading branch information
kpedro88 committed Oct 3, 2017
1 parent 05b44e8 commit 373b7aa
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,14 +85,22 @@ At least one mode must be specified to run the script.

Internally, `jobSubmitter` stores job information in a list `protoJobs`, where each entry is an instance of the class `protoJob`:
* `name`: base name for the set of jobs (see [submit mode](#submit-mode))
* `names`: list of all job names in this set
* `nums`: list of job numbers in this set (i.e. `$(Process)` values)
* `njobs`: total number of jobs (used in [count mode](#count-mode))
* `jdl`: JDL filename for this set of jobs
* `queue`: queue command for this set of jobs
* `patterns`: `OrderedDict` of find/replace pairs to create the JDL from template
* `appends`: list of strings to append to the JDL

The `protoJob` class also has a function `makeName(num)` to make an individual job name by combining the job base name and a given job number.
This function is important to match job names with finished or running jobs in [missing mode](#missing-mode), and may also be used for other purposes.
The user can override this function if desired:
```
def makeNameNew(self,num):
...
protoJob.makeName = makeNameNew
```

#### Count mode

This mode simply counts the number of jobs expected. This is useful if testing some automatic job splitting algorithm
Expand Down

0 comments on commit 373b7aa

Please sign in to comment.