Changes between Version 47 and Version 48 of qcg-directives

Timestamp:

08/26/13 14:03:46 (11 years ago)

Author:

piontek

Comment:

--

qcg-directives

@@ -38 +38 @@
 
 = environment =
-'''environment''' - environment variable. The syntax is ''key'' -> ''value''. Every variable has be be specified in separate line.
+'''environment''' - environment variable. The syntax is ''key'' -> ''value''. Every variable has be be specified in separate directive.
 
 {{{
@@ -46 +46 @@
 
 = error =
-'''error''' - location where the system has to stage-out the file containing output of the standard error stream. If the location is not the gsiftp:// url it is assumed that it is relative to the directory from which the task was submitted.
+'''error''' - location where the system is requested to stage out the file containing output of the standard error stream. If the location is not the gsiftp:// url it is assumed that it is relative to the directory from which the task was submitted.
 
 {{{
@@ -55 +55 @@
 
 = executable =
-'''executable''' - location of the executable file. The location can be gsiftp:// url or the path to the file. In the second case the location is relative to the directory from which the task was submitted. Optionally it is possible to specify the target name of the file.
+'''executable''' - location of the executable file. The location can be the gsiftp:// url or the path to the file. In the second case the location is relative to the directory from which the task was submitted. Optionally it is possible to specify the target name of the file.
 {{{
 #QCG executable=gsiftp://qcg.man.poznan.pl//home/plgrid/plgpiontek/reef/executables/exec1
@@ -77 +77 @@
 
 = input =
-'''input''' - location of the file which content will be passed to standard input stream. If the location is not the gsiftp:// url it is assumed that it is relative to the directory from which the task was submitted. 
+'''input''' - location of the file which content will be passed to the standard input stream. If the location is not the gsiftp:// url it is assumed that it is relative to the directory from which the task was submitted. 
 
 {{{
@@ -83 +83 @@
 #QCG input=input.txt
 }}}
+
 = memory =
 '''memory''' - declaration of the maximal amount of memory that can be allocated by the application (in MB).
@@ -91 +92 @@
 
 = memory-per-slot =
-'''memory-per-slot''' - declared maximal amount of the memory per slot (core). The total memory requirement is the product of this value and number od slots (cores) used by the application.
+'''memory-per-slot''' - declared maximal amount of the memory per slot (core). The total memory requirement is the product of this value and the number of slots (cores) used by the application.
 
 {{{
 #QCG memory-per-slot=512
 }}}
+
 = module =
 '''module''' - name with optional version of the requested software module. This directive is taken into consideration by the broker in the process of choosing the optimal resource which the task can be executed on. Every module has to be specified in separate directive.
@@ -103 +105 @@
 #QCG module=namd
 }}}
+
 = monitor =
 '''monitor''' - task monitoring script executed together with the main application. The script can be used for example to monitor output of the application or to do perform any additional action.
@@ -124 +127 @@
 #QCG native=-r n
 }}}
+
 = nodes =
-'''nodes''' - requested topology of the parallel application. The directive allows to specify requested number of nodes and slots per node. Optionally it is possible to specify number of processes to be executed on every node. If it is not specify else the number of processes on every node is equal to the number of slots.
+'''nodes''' - requested topology of the parallel application. The directive allows to specify requested number of nodes and slots per node. Optionally it is possible to specify number of processes to be started on every node. If it is not specified else the number of processes on every node is equal to the number of slots.
 The syntax is: number_of_nodes:number_of_slots[:number_of_processes]
 
@@ -132 +136 @@
 #QCG nodes=12:12
 }}}
+
 = not-after =
-'''not-after''' - directive allowing to specify that the task or reservation has to be executed/reserved "not-later-then". The value of this directive is date with optional time. The directive requires to be specified together with the ''walltime'' one and cannot be used with the ''reservation''.
+'''not-after''' - directive allowing to specify that the task or reservation has to be executed/reserved "not-later-then". The value of this directive is date with optional time. The directive requires to be specified together with the ''walltime'' one and cannot be used with the ''reservation'' one.
+
 {{{
 #QCG not-after=2012.08.25
 #QCG walltime=PT2H
 }}}
+
 {{{
 #QCG not-after=2012.08.25 13:20
 #QCG walltime=PT2H
 }}}
+
 = not-before =
-not-before - directive allowing to specify that the task or reservation has to be executed/reserved "not-earlier-then". The value of this directive is the date with optional time. The directive requires to be specified together with the ''walltime'' one and cannot be used with the ''reservation''.
+not-before - directive allowing to specify that the task or reservation has to be executed/reserved "not-earlier-then". The value of this directive is the date with optional time. The directive requires to be specified together with the ''walltime'' one and cannot be used with the ''reservation'' one.
 
 {{{
@@ -162 +170 @@
 
 = notify =
-'''notify''' - notify about changes of task status. The directive allows to define the protocol and address which the notification about the change of the status should be sent to. Supported protocols are mail and xmpp/jabber messages.
+'''notify''' - notify about changes of task status. The directive allows to define the protocol and address to which the notification about the change of the status should be sent. Supported protocols are mail and xmpp/jabber messages.
 
 {{{
@@ -170 +178 @@
 
 To allow receiving xmpp/jabber messages it can be necessary to add the qcg-notification@plgrid.pl sender address to contacts.
+
 = output =
-'''output''' - location where the file containing the standard output should be transfered. The location can be the gsiftp:// url or the path relative to the directory which the task was submitted from.
+'''output''' - location where the file containing the standard output should be transfered. The location can be the gsiftp:// url or the path relative to the directory from which the task was submitted.
 
 {{{
@@ -177 +186 @@
 #QCG output=output.txt
 }}}
+
 = persistent =
-'''persistent''' - do not remove the working directory. 
+'''persistent''' - the directive informing the system to not remove the working directory. 
 
 '''IMPORTANT:''' the directive should be used only for testing as it causes that the working directory is left and consumes storage resource. The working directory can be later cleaned by the '''qcg-clean''' command.
@@ -228 +238 @@
 
 = reservation =
-'''reservation''' - reservation identifier. The identifier can be of the '''local''' type when the reservation was made directly in the queueing system or of '''qcg''' one (default) when the reservation was created by the qcg-reserve command. The directive requires to be used together with the '''host''' one to ensure that the task will be submitted to the host where the reservation was done.
+'''reservation''' - reservation identifier. The identifier can be of the '''local''' type when the reservation was made directly in the queueing system or of the '''qcg''' one (default) when the reservation was created by the qcg-reserve command. The directive requires to be used together with the '''host''' one to ensure that the task will be submitted to the host where the reservation was done.
 
 {{{
@@ -234 +244 @@
 #QCG reservation=R1366398248299__4039
 }}}
+
 {{{
 #QCG host=reef.man.poznan.pl
 #QCG reservation=piontek.0 local
 }}}
+
 = stage-in-dir =
-'''stage-in-dir''' - input directory. The location of the input directory which can be either gsiftp:// url or the path to the directory relative to the directory which the task was submitted from. The syntax is "location" -> "target name". If the "target name" is not present the directory is stored under its original name.
+'''stage-in-dir''' - input directory. The location of the input directory which can be either the gsiftp:// url or the path to the directory relative to the directory from which the task was submitted. The syntax is "location" -> "target name". If the "target name" is not present the directory is stored under its original name.
 
 {{{
@@ -255 +267 @@
 #QCG stage-in-dir=. -> input
 }}}
+
 = stage-in-file =
-'''stage-in-file''' - input file. The location of the input file which can be either gsiftp:// url or the path to the directory relative to the directory which the task was submitted from. The syntax is "location" -> "target name". If the "target name" is not present the file is stored under its original name. 
+'''stage-in-file''' - input file. The location of the input file which can be either the gsiftp:// url or the path to the directory relative to the directory which the task was submitted from. The syntax is "location" -> "target name". If the "target name" is not present the file is stored under its original name. 
 
 {{{
@@ -264 +277 @@
 #QCG stage-in-file=input_file.txt
 }}}
+
 = stage-out-dir =
 '''stage-out-dir''' - output directory. The location of the output directory which can be either the gsiftp:// url or the path to the directory relative to the directory which the task was submitted from. The syntax is "location" -> "target name". If the "target name" is not present the directory is stored under its original name. 
@@ -274 +288 @@
 }}}
 
-To transfer the whole working directory plesease specify the location as "." (dot).
+To transfer the whole working directory please specify the location as "." (dot).
 
 {{{
@@ -293 +307 @@
 #QCG stage-out-file=result.txt
 }}}
+
 = use-reservation =
-'''use-reservation''' - use the advance reservation mechanism. The directive allows to force the system to use advance reservation in case when directives '''not-after''', '''not-before''', '''deadline''' were not used. The directive requires to be used together with the '''walltime'''. The directive cannot be used together with the '''reservation''' one. 
+'''use-reservation''' - use the advance reservation mechanism. The directive allows to force the system to use advance reservation in case when directives '''not-after''', '''not-before''', '''deadline''' were not used. The directive requires to be used together with the '''walltime''' one. The directive cannot be used together with the '''reservation''' one. 
 
 {{{
@@ -301 +316 @@
 }}}
 = use-scratch =
-'''use-scratch''' - use the scratch space. The directive forces system to use the scratch space if possible.
+'''use-scratch''' - use the scratch space. The directive forces the system to use the scratch space if possible.
 
 {{{
@@ -325 +340 @@
 
 = watch-output =
-'''watch-output''' - monitor the output and send notifications about the progress. The directive allows to monitor the output of the application and to send notifications in the requested form. The argument of the directive is the triple of parameters separated by comma:
-*  adress where the notification will be sent to (supported protocols are mail and xmpp/jabber - see the '''notify''' directives)
+'''watch-output''' - monitor the output and send notifications about the progress. The directive allows to monitor the output of the application and to send notifications in the requested form. The argument of the directive is the triple of parameters separated by commas:
+*  address which the notification will be sent to (supported protocols are mail and xmpp/jabber - see the '''notify''' directives for details)
 * number of seconds between next notifications
 * regular expression or path to the file to generate the content of notification.
@@ -337 +352 @@
 #QCG watch-output=mailto:piontek@man.poznan.pl,30,ntf_expr_file
 }}}
+
 = variable =
 '''variable''' - description variable (replaced only in values of QCG directives)