Questions And Answers

More Tutorials

The file format

Site definitions

Site definitions in the files begin with "site".

The second word is the name of the site you are defining. In these examples we will define a site called westmere.

The third word is the property.

For example:


Before the site properties are listed, it’s important to understand the terminology used.

A task, or app task is an instance of a program as defined in a Swift app() function.

A worker is the program that launches app tasks.

A job is related to schedulers. It is the mechanism by which workers are launched.

Below is the list of valid site properties with brief explanations of what they do, and an example entry.

Property Description Example
condor Pass parameters directly through to the submit script generated for the condor scheduler. For example, the setting "site.osgconnect.condor.+projectname=Swift" will generate the line "+projectname = Swift". site.osgconnect.condor.+projectname=Swift
filesystem Defines how files should be accessed site.westmere.filesystem=local
jobGranularity Specifies the granularity of a job, in nodes site.westmere.jobGranularity=2
jobManager Specifies how jobs will be launched. The supported job managers are "cobalt", "slurm", "condor", "pbs", "lsf", "local", and "sge" site.westmere.jobManager=slurm
jobProject Set the project name for the job scheduler site.westmere.project=myproject
jobQueue Set the name of the scheduler queue to use. site.westmere.jobQueue=westmere
jobWalltime The maximum number amount of time allocated in a scheduler job, in hh:mm:ss format site.westmere.jobWalltime=01:00:00
maxJobs Maximum number of scheduler jobs to submit site.westmere.maxJobs=20
maxNodesPerJob The maximum number of nodes to request per scheduler job. site.westmere.maxNodesPerJob=2
pe The parallel environment to use for SGE schedulers
providerAttributes Allows user to pass attributes through directly to scheduler submit script. Currently only implemented for sites that use PBS. site.beagle.providerAttributes=pbs.aprun;
slurm Pass parameters directly through to the submit script generated for the slurm scheduler. For example, the setting "site.midway.slurm.mailuser=username" generates the line "#SBATCH --mail-user=username". site.midway.slurm.mailuser=username
stagingMethod When provider staging is enabled, this option will specify the staging mechanism for use for each site. If set to file, staging is done from a filesystem accessible to the coaster service (typically running on the head node). If set to proxy, staging is done from a filesystem accessible to the client machine that swift is running on, and is proxied through the coaster service. If set to sfs (short for "shared filesystem"), staging is done by copying files to and from a filesystem accessible by the compute node (such as an NFS or GPFS mount) site.osg.stagingMethod=file
taskDir Tasks will be run from this directory. In the absence of a taskDir definition, Swift will run the task from workdir. site.westmere.taskDir=/scratch/local/$USER/wo
tasksPerWorker The number of tasks that each worker can run simultaneously. site.westmere.tasksPernode=12
taskThrottle The maximum number of active tasks across all workers. site.westmere.taskThrottle=100
taskWalltime The maximum amount of time a task may run, in hh:mm:ss site.westmere.taskWalltime=01:00:00
site Name of site or sites to run on. This is the same as running with swift -site site=westmere
userHomeOverride Sets the Swift user home. This must be a shared filesystem. This defaults to $HOME. For clusters where $HOME is not accessible to the worker nodes, you may override the value to point to a shared directory that you own. site.beagle.userHomeOverride=/lustre/beagle/use
workdir The workdirectory element specifies where on the site files can be stored. This directory must be available on all worker nodes that will be used for execution. A shared cluster filesystem is appropriate for this. Note that you need to specify absolute pathname for this field. site.westmere.workdir=/scratch/midway/$USER/


In this page (written and validated by ) you learned about Swift The swift properties file format . What's Next? If you are interested in completing Swift tutorial, your next topic will be learning about: Swift Grouping site properties.

Incorrect info or code snippet? We take very seriously the accuracy of the information provided on our website. We also make sure to test all snippets and examples provided for each section. If you find any incorrect information, please send us an email about the issue:

Share On:

Mockstacks was launched to help beginners learn programming languages; the site is optimized with no Ads as, Ads might slow down the performance. We also don't track any personal information; we also don't collect any kind of data unless the user provided us a corrected information. Almost all examples have been tested. Tutorials, references, and examples are constantly reviewed to avoid errors, but we cannot warrant full correctness of all content. By using, you agree to have read and accepted our terms of use, cookies and privacy policy.