Data Fields
string	job_name
	Name of the job. More...

string	job_type
	Type of the job. More...

string	job_file
	Local path to the file to be executed by the job. More...

string	env_file
	Local path to a script to be sourced in the environment of the job. More...

FilesList	in_files
	List of local data files to be copied to work_directory. More...

FilesList	out_files
	List of results to get back at the end of the job. More...

string	work_directory
	Remote directory where the job will be executed. More...

string	local_directory
	Prefix to be applied to in_files. More...

string	result_directory
	Local directory where to get result files. More...

string	maximum_duration
	Maximum time for the batch execution (expected format : "hh:mm"). More...

ResourceParameters	resource_required
	Specifies the rules to choose the ressource where to execute the job. More...

string	queue
	Name of the batch queue chosen - optional. More...

boolean	exclusive
	Specifies if the job must run in exclusive mode (without sharing nodes with other jobs) More...

unsigned long	mem_per_cpu
	Specifies the memory limit per cpu (exclusive with resource_required.mem_mb) More...

string	wckey
	Workload Characterization Key - mandatory on some clusters. More...

string	extra_params
	String that is added to the job submission file - optional. More...

Engines::ParameterList	specific_parameters
	Specific parameters for each type of job - optional. More...

string	launcher_file
	Parameter for COORM More...

string	launcher_args
	Parameter for COORM More...

Field Documentation

string Engines::JobParameters::job_name

Name of the job.

string Engines::JobParameters::job_type

Type of the job.

There are three supported types:

"command" : execute job_file script without SALOME environment
"python_salome" : execute job_file python script by SALOME
"yacs_file" : execute job_file by YACS module as a xml YACS schema

string Engines::JobParameters::job_file

Local path to the file to be executed by the job.

The type of the file depends on job_type. If job_type is "command", the job_file must be a single filename specifying a self-consistent script to be executed without any argument, on the remote host.

string Engines::JobParameters::env_file

Local path to a script to be sourced in the environment of the job.

It may contain modifications of environment variables.

FilesList Engines::JobParameters::in_files

List of local data files to be copied to work_directory.

job_file and env_file are automaticaly copied, without adding them to this list. If basenames are specified, then the files are supposed to be located in local_directory.

FilesList Engines::JobParameters::out_files

List of results to get back at the end of the job.

These results can be names of files or directories, produced by the job in work_directory. Directories will be copied recursively. It is also possible to use an absolute path instead of the simple name, (string beginning with '/') and this absolute path will be used instead of result_directory when SalomeLauncher::getJobResults is called.

See Also: SalomeLauncher::getJobResults

string Engines::JobParameters::work_directory

Remote directory where the job will be executed.

It must be used to specify the remote directory where to put all the stuff to run the job. Note that the job will be executed from within this directory. A change directory toward this working directory is done by the batch system before running the job. If not specified (empty string), the launcher will use the working directory of the chosen ressource and if this is also an empty string the value used will be $HOME/Batch/workdir_"date" where $HOME is the value of the environment variable on the remote ressource and "date" is the current date.

string Engines::JobParameters::local_directory

Prefix to be applied to in_files.

It can be used to specify where to find the local input files. It's optionnal if you specify the absolute path name of input files.

string Engines::JobParameters::result_directory

Local directory where to get result files.

It must be used to specify where to download the output files on the local file system. If not specified (empty string), the value of $HOME environment variable will be used.

See Also: SalomeLauncher::getJobResults

string Engines::JobParameters::maximum_duration

Maximum time for the batch execution (expected format : "hh:mm").

Could be empty, in this case, default value of the selected resource will be used.

ResourceParameters Engines::JobParameters::resource_required

Specifies the rules to choose the ressource where to execute the job.

The additionnal two following parameters MUST be specified explicitly, because they are not provided by the resource definition:

mem_mb -> Memory expressed in megabytes.
nb_proc -> Number of Processors.

string Engines::JobParameters::queue

Name of the batch queue chosen - optional.

boolean Engines::JobParameters::exclusive

Specifies if the job must run in exclusive mode (without sharing nodes with other jobs)

unsigned long Engines::JobParameters::mem_per_cpu

Specifies the memory limit per cpu (exclusive with resource_required.mem_mb)

string Engines::JobParameters::wckey

Workload Characterization Key - mandatory on some clusters.

string Engines::JobParameters::extra_params

String that is added to the job submission file - optional.

Engines::ParameterList Engines::JobParameters::specific_parameters

Specific parameters for each type of job - optional.

This is a list of parameters (key - value pairs of strings) useful in some specific situations. Known parameters:

EnableDumpYACS : value of the "dump" option of the "driver" command when the job type is "yacs_file". It gives the number of seconds between two updates of the state dump file. There will be no dump file if this parameter is missing or if its value is less than 1.
YACSDriverOptions : options of the driver command when the job type is "yacs_file".
LoalLevelerJobType : LL_JOBTYPE.

string Engines::JobParameters::launcher_file

Parameter for COORM

string Engines::JobParameters::launcher_args

Parameter for COORM

Data Fields

Field Documentation