| type | method name | argument(s) | return | description | comment
|
| environment | setEnvironment | environment(str) | ¡¡ | sets environment (Local, SMP, SGE, Globus, etc.) | set before calling registerjob() or registerEcellSession()
|
| ¡¡ | getEnvironment | ¡¡ | str | return current environment (Local, SMP, SGE, Globus, etc.) | ¡¡
|
| ¡¡ | setConcurrency | number(int) | ¡¡ | set the number of jobs to be runned concurrently¡¡ | number=0:no limit is set
|
| ¡¡ | getConcurrency | ¡¡ | int | return the number of jobs to be runned concurrently | ¡¡
|
| ¡¡ | getDefaultConcurrency | ¡¡ | int | return default number of jobs to be runned cuncurrently¡¡ | ¡¡
|
| ¡¡ | setTmpRootDir | dir(str) | ¡¡ | sets the root of temporary directory | ¡¡
|
| ¡¡ | getTmpRootDir | ¡¡ | str | returns the root of temporary directory | ¡¡
|
| ¡¡ | getTmpDir | ¡¡ | str | returns temporary directory | temporary directory is for including JobDirectory?
|
| ¡¡ | setGlobalRunTimeout | timeout=0(int) | ¡¡ | set a timeout of run method | timeout=0 : no limit
|
| ¡¡ | getGlobalRunTimeout | ¡¡ | int | return a timeout of run method | ¡¡
|
| ¡¡ | setUpdateInterval | interval=1(int) | ¡¡ | set an update interval (sec.) | ¡¡
|
| ¡¡ | getUpdateInterval | ¡¡ | int | return an update interval (sec.) | ¡¡
|
| ¡¡ | setRetryLimit | retrylimit(int) | ¡¡ | sets the limit number of retry | ¡¡
|
|
|
| Input | loadScript | esmfile (str or file object) | ¡¡ | load ESM file | IOException will be raised when the file can not be read.
|
|
|
| register job | registerJob | script(str), interpreter(str), argument=("")(str), extrafilelist=[](list), timeout=0(int) | int | registers new job and returns job ID | timeout=0:no limit is set
|
| ¡¡ | registerECellSession | essfile(str), argument={}(dict), extrafilelist=[](list), timeout=0(int) | int | registers new session and returns job ID | timeout=0:no limit is set
|
|
|
| remove job | clearJob | jobid(int) | removes all registered jobs | deletes running job and remove them if there are | ¡¡
|
| ¡¡ | clearQueuedJobs | ¡¡ | ¡¡ | removes all queued jobs | ¡¡
|
| ¡¡ | clearRunningJobs | ¡¡ | ¡¡¡¡ | removes all running jobs | ¡¡
|
| ¡¡ | clearErrorJobs | ¡¡ | ¡¡¡¡ | removes all error jobs | ¡¡
|
| ¡¡ | clearFinishedJobs | ¡¡ | ¡¡¡¡ | removes all finished jobs | ¡¡
|
|
|
| job status | update | ¡¡ | ¡¡ | update jobs' status | When block flag of run method is True, this method is called automatically. When it is False, user have to call this method manually to update the status of jobs
|
| ¡¡ | getQueuedJobList | ¡¡ | list | return ID list of queued job | ¡¡
|
| ¡¡ | getRunningJobList | ¡¡ | list | return a list of running jobs | ¡¡
|
| ¡¡ | getErrorJobList | ¡¡ | list | return a list of error jobs | ¡¡
|
| ¡¡ | getFinishedJobList | ¡¡ | list | return a list of finished job | ¡¡
|
| ¡¡ | isFinished | ¡¡ | boolean | return the status where all jobs were finished or not | ¡¡
|
| ¡¡ | isError | ¡¡ | boolean | returns the status where error jobs exist or not | ¡¡
|
| ¡¡ | isRunning | ¡¡ | boolean | returns the status where running jobs exist or not | ¡¡
|
|
|
| run/stop | run | updateinterval, timeout=0 | list(list of Job ID) | When block is True, this method is blocked until all jobs finished and update jobs' status with updateinterval. | Error is raised when a register of job is failed. When block is False,updateinterval is unuse.
|
| ¡¡ | stop | jobid | ¡¡ | stops running and queued jobs | set jobs status as ERROR
|
|
|
| file management | getJobDirectory | jobid(int) | str | returns job directory name | ¡¡
|
| ¡¡ | setStdoutFileName | outputname(str) | ¡¡ | set the standard output file name | ¡¡
|
| ¡¡ | getStdoutFileName | ¡¡ | str | return the standard output file name | ¡¡
|
| ¡¡ | setStderrFileName | erroroutputname(str) | ¡¡ | set the standard error output file name | ¡¡
|
| ¡¡ | getStderrFileName | ¡¡ | str | return the standard error output file name | ¡¡
|
|
|
| for advanced users | getSessionProxy | jobid(int) | SessionProxy? | returns the SessionProxy? | ¡¡
|
