From 373b7aa67fdf1b7230d51cddbb344090488501c2 Mon Sep 17 00:00:00 2001 From: Kevin Pedro Date: Tue, 3 Oct 2017 11:45:59 -0500 Subject: [PATCH] document --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 28ababf..745b4ac 100755 --- a/README.md +++ b/README.md @@ -85,7 +85,6 @@ 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 @@ -93,6 +92,15 @@ Internally, `jobSubmitter` stores job information in a list `protoJobs`, where e * `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