Changes between Version 11 and Version 12 of WikiStart

Timestamp:

06/03/11 00:45:27 (14 years ago)

Author:

mmatloka

Comment:

--

WikiStart

@@ -13 +13 @@
 and control over Web Services.
 
+== Download ==
+
+DRMAA for Torque/PBS Pro is distributed as a source package which can be downloaded directly from [download:1 here] or via the [http://apps.man.poznan.pl/trac/pbs-drmaa/downloads Downloads] section.
+
+== SVN access ==
+
+
+{{{
+  $ svn co https://apps.man.poznan.pl/svn/pbs-drmaa/
+}}}
+
+Please note the `./autogen.sh` and `./autoclean.sh` scripts which calls the autotools command chain in appropriate order.
+
+**note:** You need some [#dev_tools developer tools] to compile the svn version. Also the trunk version may not always compile.
 
 == Installation ==
@@ -40 +54 @@
 The value of the `keep_completed parameter denotes a number of
 seconds jobs will have to wait in the queue after the completion (and
-should be greater then ``pool_delay`` value in PBS DRMAA configuration_).
+should be greater then `pool_delay` value in PBS DRMAA configuration_).
 It enables the DRMAA library to retrieve the information about finished
 jobs.
@@ -49 +63 @@
 == Configuration ==
 
-During DRMAA session initialization (``drmaa_init``) library tries to read
+During DRMAA session initialization (`drmaa_init`) library tries to read
 its configuration parameters from locations:
 
-* `PREFIX/etc/pbs_drmaa.conf, 
-* `~/.pbs_drmaa.conf
-* and from file given in `PBS_DRMAA_CONF environment variable (if set to non-empty string).
+* `PREFIX/etc/pbs_drmaa.conf`, 
+* `~/.pbs_drmaa.conf`
+* and from file given in `PBS_DRMAA_CONF` environment variable (if set to non-empty string).
 
 If multiple configuration sources are present then all configurations
 are merged with values from user-defined files taking precedence
-(in following order: `$PBS_DRMAA_CONF, `~/.pbs_drmaa.conf``,
-`PREFIX/etc/pbs_drmaa.conf).
+(in following order: `PBS_DRMAA_CONF`, `~/.pbs_drmaa.conf`,
+`PREFIX/etc/pbs_drmaa.conf`).
 
 Currently recognized configuration parameters are:
@@ -70 +84 @@
   wait_thread::
     Value 1 enables single "wait thread" for updating jobs status. 
-    With ``pbs_home`` set enables wait_thread which reads PBS log files (instead of polling PBS daemons).
+    With `pbs_home` set enables wait_thread which reads PBS log files (instead of polling PBS daemons).
      
      Type: integer, Default: 0
@@ -152 +166 @@
 
 DRMAA interface allows to pass DRM dependant job submission options.
-Those options may be specified by settings ``drmaa_native_specification``. ``drmaa_native_specification``
-accepts space delimited ``qsub``. ``qsub``
+Those options may be specified by settings `drmaa_native_specification`. `drmaa_native_specification`
+accepts space delimited `qsub`. `qsub`
 options which does not set job attributes (`-b`, `-z`, `-C`) as
 well as meant for submission of interactive jobs (`-I`, `-X`) or
@@ -176 +190 @@
 ||  drmaa_start_time    ||  Execution_Time             ||  `-a` start time     ||
 ||  drmaa_js_state      ||  Hold_Types                 ||  `-h`                ||
-||  ..                  ||  Account_Name               ||  `-A` account string ||
+||  ..                  ||  Account_Name               ||  `-A` account string  ||
 ||  ..                  ||  Checkpoint                 ||  `-c` interval       ||
 ||  ..                  ||  Keep_Files                 ||  `-k` keep           ||
@@ -184 +198 @@
 ||  ..                  ||  Shell_Path_List            ||  `-S` path list      ||
 ||  ..                  ||  User_List                  ||  `-u` user list      ||
-||  ..                  ||  group_list                 ||  `--group_list=`\groups ||
+||  ..                  ||  group_list                 ||  `--group_list=`\groups  ||
 ||  drmaa_v_env         ||  Variable_List              ||  `-v` variable list  ||
 ||  ..                  ||  Variable_List              ||  `-V`                ||
 ||  drmaa_v_email       ||  Mail_Users                 ||  `-M` user list      ||
 ||  drmaa_duration_hlimit ||  Resource_List   cput     ||    `-l cput=`\limit    ||
-||  drmaa_wct_hlimit      ||  Resource_List   walltime ||    `-l walltime=`\limit||
+||  drmaa_wct_hlimit      ||  Resource_List   walltime ||    `-l walltime=`\limit  ||
 ||  ..                    ||  Resource_List            ||    `-l` resources      ||
 
@@ -209 +223 @@
  * memleak fixes
  * testsuite passed on PBS Pro 10
- * exit codes 126-127 cause the drmaa_wifaborted() to return true
+ * exit codes 126-127 cause the `drmaa_wifaborted()` to return true
  * other bug fixes
 
@@ -222 +236 @@
  * number of attributes implemented:
 
-   - ``drmaa_start_time``
-   - ``drmaa_duration_hlimit``
-   - ``drmaa_wct_hlimit``
-   - ``drmaa_native_specification``
-   - ``drmaa_job_category``
+   - `drmaa_start_time`
+   - `drmaa_duration_hlimit`
+   - `drmaa_wct_hlimit`
+   - `drmaa_native_specification`
+   - `drmaa_job_category`
 
  * configuration file(s)
@@ -261 +275 @@
    by sending SIGTERM and/or SIGKILL therefore retrieving
    those signals cannot be distinguished from abort using
-   ``drmaa_control(DRMAA_CONTROL_TERMINATE)``.  Then job termination
+   `drmaa_control(DRMAA_CONTROL_TERMINATE)`.  Then job termination
    state is marked as "aborted" and "signaled" whatever is the state.
 
- * ``drmaa_wcoredump()`` always returns ``false``.
-
- * Waiting functions (``drmaa_wait()`` and ``drmaa_synchronize()``)
+ * `drmaa_wcoredump()` always returns `false`.
+
+ * Waiting functions (`drmaa_wait()` and `drmaa_synchronize()`)
    must pool DRM to find out whether job finished.
+
+[=#dev_tools]
+=== Developer tools ===
+
+Although not needed for library user the following tools may be required
+if you intend to develop PSNC DRMAA for Torque/PBS Pro:
+
+ * GNU autotools
+ ** autoconf (tested with version 2.67)
+ ** automake (tested with version 1.11)
+ ** libtool (tested with version 2.2.8)
+ ** m4 (tested with version 1.4.14)
+ * [http://www.gnu.org/software/bison/ Bison] parser generator,
+ * [http://www.complang.org/ragel/ RAGEL] State Machine Compiler,
+ * [http://www.gnu.org/software/gperf/ gperf] gperf - a perfect hash function generator.
+
+=== Links ===
+
+[=#drmaa] DRMAA: http://www.drmaa.org/ \\
+[=#open_grid_forum] Open Grid Forum: http://www.gridforum.org/ \\
+[=#specification] DRMAA 1.0 specification: http://www.ogf.org/documents/GFD.133.pdf \\
+[=#testsuite] Official DRMAA test-suite: http://drmaa.org/testsuite.php \\
+[=#smoa_comp] Smoa Computing: http://apps.man.poznan.pl/trac/smoa-comp \\
+[=#bison] Bison:     http://www.gnu.org/software/bison/ \\