Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Variable name

Explanation

Default

Example

ECF_KILL_CMD

Method to kill a running task. Depends on how the task was submitted via ECF_JOB_CMD.

ecFlow must know the value of remote-id (ECF_RID). Variable enables kill(CLI) command to be used.

Can use the generated variable %ECF_JOB%.kill for storing command output

No

rsh %SCHOST% qdel -2 %ECF_RID% > %ECF_JOB% 2>&1

ECF_JOB_CMD

Command to be executed to submit a job. May involve using a queuing system,

like NQS, or may run the job in the background.

Yes

%ECF_JOB% 1> %ECF_JOBOUT% 2>&1

"mkdir -p $(dirname %ECF_JOBOUT%) && ssh -v -o StrictHostKeyChecking=no %USER%@%REMOTE_HOST% ksh -s <%ECF_JOB% >%ECF_JOBOUT% 2>&1 &"




%SCHOST%submit %ECF_JOB%

ECF_STATUS_CMD

Command to be used to check the status of a submitted or running job.

Can use the generated variable %ECF_JOB%.stat for storing command output

No

'rsh %SCHOST% qstat -f %ECF_RID%.%SCHOST% %ECF_JOB% 2>&1'

ECF_URLCMD

Command to be executed to allow the user to view related web pages

No

${BROWSER:=firefox} -remote 'openURL(%ECF_URLBASE%/%ECF_URL%)'Where ECF_URLBASE is the base web address and ECF_URL the specific page.

ECF_HOME

The default location for ecFlow files if ECF_FILES is not used.

Yes

/tmp/ECF/$SUITE


The location for generated files.

These are the job-files and the job-output.

Setting this variable to a different directory to ECF_FILES enables you to clean up

all the files produced by running ECF.



ECF_TRIES

The number of times a job should rerun if it aborts.

If more than one and the job aborts, the job is automatically re-run by ECF.

Useful when jobs are run in unreliable environments.

For example, using commands like ftp(1) in a job can fail easily, but re-running the job will often work.

Yes

2

ECF_FILES

Alternate location for ecFlow files

No

/home/user/ECF/$SUITE

ECF_INCLUDE

Path for the include files.

No

/home/user/ECF/$SUITE/include

ECF_EXTN

Overrides the default script extension

Yes

.sms (default is .ecf)

ECF_DUMMY_TASK

Some tasks have no associated '.ecf' file.

The addition of this variable stops job generation checking from raising errors.

No

Any value is sufficient

ECF_OUT

Alternate location for job and cmd output files.

If this variable exists it is used as a base for ECF_JOBOUT but it is also used to search for the

output by ecFlow when asked by ecflow_ui/CLI. If the output is in ECF_HOME/ECF_NODE.ECF_TRYNO it is returned, otherwise ECF_OUT/ECF_NODE.ECF_TRYNO that is ECF_JOBOUT is used. Job

The job may continue to use ECF_JOBOUT (as in a QSUB directive) but should copy its own output file back into ECF_HOME/ECF_NODE.ECF_TRYNO in at the end of their run.

No

/scratch/ECF/

Anchor
SMSMICRO
SMSMICRO
ECF_MICRO

ecFlow pre-process character to be used by ecFlow pre-processor for variable substitution and including files.

Yes

%

...