[1] | 1 | ================================= |
---|
| 2 | DRMAA for Torque/PBS Professional |
---|
| 3 | ================================= |
---|
| 4 | |
---|
| 5 | :Authors: Åukasz CieÅnik <lukasz.ciesnik@fedstage.com>, |
---|
| 6 | MichaÅ MatÅoka <michal.matloka@student.put.poznan.pl>, |
---|
| 7 | Mariusz Mamonski <mamonski@man.poznan.pl> |
---|
| 8 | :Contact: Mariusz Mamonski <mamonski@man.poznan.pl> |
---|
| 9 | :Date: $Date: 2010-07-07 17:05:39 +0200 (Wed, 07 Jul 2010) $ |
---|
| 10 | :Version: 1.0.3 |
---|
| 11 | :Revision: $Revision: 386 $ |
---|
| 12 | :Copyright: Copyright (C) 2006-2008 FedStage Systems |
---|
| 13 | |
---|
| 14 | :Abstract: This document describes installation, configuration and usage |
---|
| 15 | of `DRMAA for Torque/PBS Pro`_ library (PBS DRMAA for short). |
---|
| 16 | |
---|
| 17 | .. meta:: |
---|
| 18 | :http-equiv=Content-Language: en |
---|
| 19 | :http-equiv=Content-Type: application/xhtml+xml; charset=UTF-8 |
---|
| 20 | :description lang=en: DRMAA implementation for PBS systems. |
---|
| 21 | :keywords: DRMAA, PBS, Torque, PBS Professional, PBS Pro, Portable Batch System |
---|
| 22 | |
---|
| 23 | .. contents:: |
---|
| 24 | |
---|
| 25 | .. default-role:: literal |
---|
| 26 | |
---|
| 27 | |
---|
| 28 | Introduction |
---|
| 29 | ============ |
---|
| 30 | |
---|
| 31 | DRMAA for Torque/PBS Pro is implementation of `Open Grid Forum`_ DRMAA_ |
---|
| 32 | (Distributed Resource Management Application API) specification_ for |
---|
| 33 | submission and control jobs to PBS_ systems: `PBS Professional`_, Torque_ |
---|
| 34 | and OpenPBS_. Using DRMAA, grid applications builders, portal developers |
---|
| 35 | and ISVs can use the same high-level API to link their software with |
---|
| 36 | different cluster/resource management systems. |
---|
| 37 | |
---|
| 38 | This software also enables the integration of `SMOA Computing`_ |
---|
| 39 | with the underlying Torque/PBS Pro system for remote multi-user job submission |
---|
| 40 | and control over Web Services. |
---|
| 41 | |
---|
| 42 | This manual can be found in HTML and PDF formats in ``doc`` directory. |
---|
| 43 | |
---|
| 44 | |
---|
| 45 | Installation |
---|
| 46 | ============ |
---|
| 47 | |
---|
| 48 | To compile the library just go to main source directory and type:: |
---|
| 49 | |
---|
| 50 | $ ./configure [--prefix=/installation/directory] && make |
---|
| 51 | |
---|
| 52 | If you had installed PBS in a non standard directory pass it |
---|
| 53 | in ``--with-pbs`` configure parameter. There are no unusual requirements |
---|
| 54 | for basic usage of library: ANSI C compiler and standard make should |
---|
| 55 | suffice (if linking against PBS Professional you will need also the OpenSSL library). |
---|
| 56 | If you have taken sources directly from SVN repository you would |
---|
| 57 | need additional `developer tools`_. For further information regarding GNU |
---|
| 58 | build system see the INSTALL file. |
---|
| 59 | |
---|
| 60 | For Torque_ it is advised to configure queues so jobs are leaved after |
---|
| 61 | the completion. To achieve this simply type the following command for |
---|
| 62 | all queues which are intended to use with PBS DRMAA:: |
---|
| 63 | |
---|
| 64 | # qmgr -c "set queue QUEUE_NAME keep_completed = 60" |
---|
| 65 | |
---|
| 66 | The value of the ``keep_completed`` parameter denotes a number of |
---|
| 67 | seconds jobs will have to wait in the queue after the completion (and |
---|
| 68 | should be greater then ``pool_delay`` value in PBS DRMAA configuration_). |
---|
| 69 | It enables the DRMAA library to retrieve the information about finished |
---|
| 70 | jobs. |
---|
| 71 | |
---|
| 72 | Alternatively you can configure the DRMAA library to use Torque server daemon logs |
---|
| 73 | as information source for terminated jobs (consult next section for details) |
---|
| 74 | |
---|
| 75 | Configuration |
---|
| 76 | ============= |
---|
| 77 | |
---|
| 78 | During DRMAA session initialization (``drmaa_init``) library tries to read |
---|
| 79 | its configuration parameters from locations: |
---|
| 80 | ``/etc/pbs_drmaa.conf``, ``~/.pbs_drmaa.conf`` and from file given in |
---|
| 81 | ``PBS_DRMAA_CONF`` environment variable (if set to non-empty string). |
---|
| 82 | If multiple configuration sources are present then all configurations |
---|
| 83 | are merged with values from user-defined files taking precedence |
---|
| 84 | (in following order: ``$PBS_DRMAA_CONF``, ``~/.pbs_drmaa.conf``, |
---|
| 85 | ``/etc/pbs_drmaa.conf``). |
---|
| 86 | |
---|
| 87 | Currently recognized configuration parameters are: |
---|
| 88 | |
---|
| 89 | pool_delay |
---|
| 90 | Amount of time (in seconds) between successive checks of unfinished job(s). |
---|
| 91 | |
---|
| 92 | Type: integer, Default: 5 |
---|
| 93 | |
---|
| 94 | wait_thread |
---|
| 95 | Value 1 enables single "wait thread" for updating jobs status. |
---|
| 96 | With ``pbs_home`` set enables wait_thread which reads PBS log files (instead of polling PBS daemons). |
---|
| 97 | |
---|
| 98 | Type: integer, Default: 0 |
---|
| 99 | |
---|
| 100 | pbs_home |
---|
| 101 | Path to Torque/PBS Pro spool directory that contains server logs (e.g.: /var/spool/pbs). |
---|
| 102 | |
---|
| 103 | Type: string, Default: not set |
---|
| 104 | |
---|
| 105 | job_categories |
---|
| 106 | Dictionary of job categories. It's keys are job categories names |
---|
| 107 | mapped to `native specification`_ strings. Attributes set by |
---|
| 108 | job category can be overridden by corresponding DRMAA attributes |
---|
| 109 | or native specification. Special category name ``default`` |
---|
| 110 | is used when ``drmaa_job_category`` job attribute was not set. |
---|
| 111 | |
---|
| 112 | cache_job_state |
---|
| 113 | According to the DRMAA specification every `drmaa_job_ps()` call should |
---|
| 114 | query DRM system for job state. With this option one may optimize |
---|
| 115 | communication with DRM. If set to positive integer `drmaa_job_ps()` |
---|
| 116 | returns remembered job state without communicating with DRM for |
---|
| 117 | `cache_job_state` seconds since last update. By default library |
---|
| 118 | conforms to specification (no caching will be performed). |
---|
| 119 | |
---|
| 120 | Type: integer, default: 0 |
---|
| 121 | |
---|
| 122 | |
---|
| 123 | .. table:: |
---|
| 124 | Different modes of operation |
---|
| 125 | |
---|
| 126 | =========== ========= =========== ======================= =================================== |
---|
| 127 | wait_thread pbs_home mode keep_completed needed comments |
---|
| 128 | =========== ========= =========== ======================= =================================== |
---|
| 129 | 0 not set polling yes default configuration |
---|
| 130 | 1 not set polling yes more effective than above |
---|
| 131 | 1 set triggered no read access to server logs needed |
---|
| 132 | =========== ========= =========== ======================= =================================== |
---|
| 133 | |
---|
| 134 | |
---|
| 135 | Configuration file syntax |
---|
| 136 | ------------------------- |
---|
| 137 | |
---|
| 138 | Configuration file is in form a dictionary. |
---|
| 139 | Dictionary is set of zero or more key-value pairs. |
---|
| 140 | Key is a string while value could be a string, an integer |
---|
| 141 | or another dictionary. |
---|
| 142 | :: |
---|
| 143 | |
---|
| 144 | configuration: dictionary | dictionary_body |
---|
| 145 | dictionary: '{' dictionary_body '}' |
---|
| 146 | dictionary_body: (string ':' value ',')* |
---|
| 147 | value: integer | string | dictionary |
---|
| 148 | string: unquoted-string | single-quoted-string | double-quoted-string |
---|
| 149 | unquoted-string: [^ \t\n\r:,0-9][^ \t\n\r:,]* |
---|
| 150 | single-quoted-string: '[^']*' |
---|
| 151 | double-quoted-string: "[^"]*" |
---|
| 152 | integer: [0-9]+ |
---|
| 153 | |
---|
| 154 | Configuration file example |
---|
| 155 | -------------------------- |
---|
| 156 | |
---|
| 157 | :: |
---|
| 158 | |
---|
| 159 | # pbs_drmaa.conf - Sample pbs_drmaa configuration file. |
---|
| 160 | |
---|
| 161 | wait_thread: 0, |
---|
| 162 | |
---|
| 163 | #pool_delay: 5, |
---|
| 164 | |
---|
| 165 | job_categories: { |
---|
| 166 | #default: "-k n", # delete output files from execution hosts |
---|
| 167 | longterm: "-p -100 -l nice=5", |
---|
| 168 | amd64: "-l arch=amd64", |
---|
| 169 | python: "-l software=python", |
---|
| 170 | java: "-l software=java,vmem=500mb -v PATH=/opt/sun-jdk-1.6:/usr/bin:/bin", |
---|
| 171 | #test: "-u test -q testing", |
---|
| 172 | }, |
---|
| 173 | |
---|
| 174 | |
---|
| 175 | Native specification |
---|
| 176 | ==================== |
---|
| 177 | |
---|
| 178 | DRMAA interface allows to pass DRM dependant job submission options. |
---|
| 179 | Those options may be specified by settings ``drmaa_native_specification``. ``drmaa_native_specification`` |
---|
| 180 | accepts space delimited ``qsub``. ``qsub`` |
---|
| 181 | options which does not set job attributes (`-b`, `-z`, `-C`) as |
---|
| 182 | well as meant for submission of interactive jobs (`-I`, `-X`) or |
---|
| 183 | to specify directories (`-d`, `-D`) are *not* supported. |
---|
| 184 | Also instead of `-W` option following long options are accepted |
---|
| 185 | within native specification: `--depend`, `--group-list`, `--stagein` |
---|
| 186 | and `--stageout`. For detailed description of each option see PBS |
---|
| 187 | documentation. |
---|
| 188 | |
---|
| 189 | Attributes set in native specification overrides corresponding DRMAA job |
---|
| 190 | attributes. |
---|
| 191 | |
---|
| 192 | .. table:: |
---|
| 193 | Native specification strings with corresponding DRMAA attributes. |
---|
| 194 | |
---|
| 195 | ===================== =============== ============ ==================== |
---|
| 196 | DRMAA attribute PBS attribute PBS resource native specification |
---|
| 197 | ===================== =============== ============ ==================== |
---|
| 198 | Attributes which get overridden |
---|
| 199 | ----------------------------------------------------------------------- |
---|
| 200 | drmaa_job_name Job_Name `-N` job name |
---|
| 201 | drmaa_output_path Output_Path `-o` output path |
---|
| 202 | drmaa_error_path Error_Path `-e` error path |
---|
| 203 | drmaa_join_files Join_Path `-j` join options |
---|
| 204 | drmaa_block_email Mail_Points `-m` mail options |
---|
| 205 | drmaa_start_time Execution_Time `-a` start time |
---|
| 206 | drmaa_js_state Hold_Types `-h` |
---|
| 207 | .. Account_Name `-A` account string |
---|
| 208 | .. Checkpoint `-c` interval |
---|
| 209 | .. Keep_Files `-k` keep |
---|
| 210 | .. Priority `-p` priority |
---|
| 211 | .. destination `-q` queue |
---|
| 212 | .. Rerunable `-r` y/n |
---|
| 213 | .. Shell_Path_List `-S` path list |
---|
| 214 | .. User_List `-u` user list |
---|
| 215 | .. group_list `--group_list=`\groups |
---|
| 216 | drmaa_v_env Variable_List `-v` variable list |
---|
| 217 | .. Variable_List `-V` |
---|
| 218 | drmaa_v_email Mail_Users `-M` user list |
---|
| 219 | drmaa_duration_hlimit Resource_List cput `-l cput=`\limit |
---|
| 220 | drmaa_wct_hlimit Resource_List walltime `-l walltime=`\limit |
---|
| 221 | .. Resource_List `-l` resources |
---|
| 222 | .. depend `--depend=`\dependency |
---|
| 223 | .. stagein `--stagein=`\stagein |
---|
| 224 | .. stageout `--stageout=`\stageout |
---|
| 225 | ===================== =============== ============ ==================== |
---|
| 226 | |
---|
| 227 | |
---|
| 228 | Release notes |
---|
| 229 | ============= |
---|
| 230 | |
---|
| 231 | Changes in 1.0.4 release |
---|
| 232 | ------------------------ |
---|
| 233 | * fix "mtime" date parsing ('triggered' mode) |
---|
| 234 | * fix "submit_args" attribute bug (PBS Professional only) |
---|
| 235 | |
---|
| 236 | Changes in 1.0.3 release |
---|
| 237 | ------------------------ |
---|
| 238 | |
---|
| 239 | * new implementation of the "wait thread" which reads PBS log files (increased scalability) |
---|
| 240 | * support for native specification attribute |
---|
| 241 | * memleak fixes |
---|
| 242 | * testsuite passed on PBS Pro 10 |
---|
| 243 | * exit codes 126-127 cause the drmaa_wifaborted() to return true |
---|
| 244 | * other bug fixes |
---|
| 245 | |
---|
| 246 | Changes in 1.0.2 release |
---|
| 247 | ------------------------ |
---|
| 248 | |
---|
| 249 | * automatic reconnect on PBS connection errors |
---|
| 250 | * static linkage with DRMAA utilities |
---|
| 251 | * other bug fixes |
---|
| 252 | |
---|
| 253 | Changes in 1.0.1 release |
---|
| 254 | ------------------------ |
---|
| 255 | |
---|
| 256 | * number of attributes implemented: |
---|
| 257 | |
---|
| 258 | - ``drmaa_start_time`` |
---|
| 259 | - ``drmaa_duration_hlimit`` |
---|
| 260 | - ``drmaa_wct_hlimit`` |
---|
| 261 | - ``drmaa_native_specification`` |
---|
| 262 | - ``drmaa_job_category`` |
---|
| 263 | |
---|
| 264 | * configuration file(s) |
---|
| 265 | * separate wait thread |
---|
| 266 | * lot of bug fixes |
---|
| 267 | * more robust code |
---|
| 268 | * separated DRMAA utilities library |
---|
| 269 | * Python driven test-suite |
---|
| 270 | |
---|
| 271 | |
---|
| 272 | Known bugs and limitations |
---|
| 273 | -------------------------- |
---|
| 274 | |
---|
| 275 | Library covers nearly all DRMAA 1.0 specification_ with exceptions |
---|
| 276 | listed below. It passes the `official DRMAA test-suite`_ except of tests |
---|
| 277 | which require job termination status. All mandatory and some optional |
---|
| 278 | job attributes (namely: transfer files, wall clock time hard limit, |
---|
| 279 | job run duration hard limit) are implemented. |
---|
| 280 | |
---|
| 281 | Known limitations imposed by PBS API: |
---|
| 282 | |
---|
| 283 | * With `PBS Pro`_ (and OpenPBS_) retrieving of job termination status is |
---|
| 284 | impossible. For this DRM finished jobs are marked as done with 0 |
---|
| 285 | return code unless job was terminated through library when they are |
---|
| 286 | treated as aborted and killed after receiving SIGTERM. |
---|
| 287 | |
---|
| 288 | * Library accepts job identifiers only of those jobs which |
---|
| 289 | were submitted under current session (specification says it should |
---|
| 290 | also accept job identifiers from previous sessions and even of |
---|
| 291 | jobs submitted in former execution of DRMAA enabled application). |
---|
| 292 | This could only be partially fixed as job state needs to be kept by |
---|
| 293 | library in order to cope with PBS shortcomings. |
---|
| 294 | |
---|
| 295 | * Job termination (when job is running) is realized by PBS |
---|
| 296 | by sending SIGTERM and/or SIGKILL therefore retrieving |
---|
| 297 | those signals cannot be distinguished from abort using |
---|
| 298 | ``drmaa_control(DRMAA_CONTROL_TERMINATE)``. Then job termination |
---|
| 299 | state is marked as "aborted" and "signaled" whatever is the state. |
---|
| 300 | |
---|
| 301 | * ``drmaa_wcoredump()`` always returns ``false``. |
---|
| 302 | |
---|
| 303 | * Waiting functions (``drmaa_wait()`` and ``drmaa_synchronize()``) |
---|
| 304 | must pool DRM to find out whether job finished. |
---|
| 305 | |
---|
| 306 | |
---|
| 307 | Test-suite |
---|
| 308 | ---------- |
---|
| 309 | |
---|
| 310 | The DRMAA for Torque/PBS Pro library was successfully tested with |
---|
| 311 | `PBS Pro`_ 10 (10.0.0.82981) and Torque_ 2.5.1 on Linux OS. Following |
---|
| 312 | table presents results of tests from |
---|
| 313 | `Official DRMAA test-suite`_ (originally developed for Sun Grid Engine). |
---|
| 314 | |
---|
| 315 | .. table:: |
---|
| 316 | Mode - Polling |
---|
| 317 | |
---|
| 318 | =============================================== =========== ============ |
---|
| 319 | Test name PBS Pro 10 Torque 2.5.1 |
---|
| 320 | =============================================== =========== ============ |
---|
| 321 | test_mt_exit_during_submit passed passed |
---|
| 322 | test_mt_exit_during_submit_or_wait passed passed |
---|
| 323 | test_mt_submit_before_init_wait passed passed |
---|
| 324 | test_mt_submit_mt_wait passed passed |
---|
| 325 | test_mt_submit_wait passed passed |
---|
| 326 | test_st_attribute_change passed passed |
---|
| 327 | test_st_bulk_singlesubmit_wait_individual passed passed |
---|
| 328 | test_st_bulk_submit_in_hold_session_delete passed passed |
---|
| 329 | test_st_bulk_submit_in_hold_session_release passed passed |
---|
| 330 | test_st_bulk_submit_in_hold_single_delete passed passed |
---|
| 331 | test_st_bulk_submit_in_hold_single_release passed passed |
---|
| 332 | test_st_bulk_submit_wait passed passed |
---|
| 333 | test_st_contact passed passed |
---|
| 334 | test_st_drm_system passed passed |
---|
| 335 | test_st_drmaa_impl passed passed |
---|
| 336 | test_st_empty_session_control passed passed |
---|
| 337 | test_st_empty_session_synchronize_dispose passed passed |
---|
| 338 | test_st_empty_session_synchronize_nodispose passed passed |
---|
| 339 | test_st_empty_session_wait passed passed |
---|
| 340 | test_st_error_file_failure FAILED [1]_ passed |
---|
| 341 | test_st_exit_status FAILED [1]_ passed |
---|
| 342 | test_st_input_file_failure FAILED [1]_ passed |
---|
| 343 | test_st_mult_exit passed passed |
---|
| 344 | test_st_mult_init passed passed |
---|
| 345 | test_st_output_file_failure FAILED [1]_ passed |
---|
| 346 | test_st_submit_in_hold_delete passed passed |
---|
| 347 | test_st_submit_in_hold_release passed passed |
---|
| 348 | test_st_submit_kill_sig FAILED [1]_ passed |
---|
| 349 | test_st_submit_polling_synchronize_timeout passed passed |
---|
| 350 | test_st_submit_polling_synchronize_zerotimeout passed passed |
---|
| 351 | test_st_submit_polling_wait_timeout passed passed |
---|
| 352 | test_st_submit_polling_wait_zerotimeout passed passed |
---|
| 353 | test_st_submit_suspend_resume_wait passed passed |
---|
| 354 | test_st_submit_wait passed passed |
---|
| 355 | test_st_submitmixture_sync_all_dispose passed passed |
---|
| 356 | test_st_submitmixture_sync_all_nodispose passed passed |
---|
| 357 | test_st_submitmixture_sync_allids_dispose passed passed |
---|
| 358 | test_st_submitmixture_sync_allids_nodispose passed passed |
---|
| 359 | test_st_supported_attr passed passed |
---|
| 360 | test_st_supported_vattr passed passed |
---|
| 361 | test_st_usage_check passed passed |
---|
| 362 | test_st_version passed passed |
---|
| 363 | =============================================== =========== ============ |
---|
| 364 | |
---|
| 365 | .. [1] Due to unavailability of job termination status. |
---|
| 366 | |
---|
| 367 | .. table:: |
---|
| 368 | Mode - Triggered |
---|
| 369 | |
---|
| 370 | =============================================== =========== ============ |
---|
| 371 | Test name PBS Pro 10 Torque 2.5.1 |
---|
| 372 | =============================================== =========== ============ |
---|
| 373 | test_mt_exit_during_submit passed passed |
---|
| 374 | test_mt_exit_during_submit_or_wait passed passed |
---|
| 375 | test_mt_submit_before_init_wait passed passed |
---|
| 376 | test_mt_submit_mt_wait passed passed |
---|
| 377 | test_mt_submit_wait passed passed |
---|
| 378 | test_st_attribute_change passed passed |
---|
| 379 | test_st_bulk_singlesubmit_wait_individual passed passed |
---|
| 380 | test_st_bulk_submit_in_hold_session_delete passed passed |
---|
| 381 | test_st_bulk_submit_in_hold_session_release passed passed |
---|
| 382 | test_st_bulk_submit_in_hold_single_delete passed passed |
---|
| 383 | test_st_bulk_submit_in_hold_single_release passed passed |
---|
| 384 | test_st_bulk_submit_wait passed passed |
---|
| 385 | test_st_contact passed passed |
---|
| 386 | test_st_drm_system passed passed |
---|
| 387 | test_st_drmaa_impl passed passed |
---|
| 388 | test_st_empty_session_control passed passed |
---|
| 389 | test_st_empty_session_synchronize_dispose passed passed |
---|
| 390 | test_st_empty_session_synchronize_nodispose passed passed |
---|
| 391 | test_st_empty_session_wait passed passed |
---|
| 392 | test_st_error_file_failure passed passed |
---|
| 393 | test_st_exit_status passed passed |
---|
| 394 | test_st_input_file_failure passed passed |
---|
| 395 | test_st_mult_exit passed passed |
---|
| 396 | test_st_mult_init passed passed |
---|
| 397 | test_st_output_file_failure passed passed |
---|
| 398 | test_st_submit_in_hold_delete passed passed |
---|
| 399 | test_st_submit_in_hold_release passed passed |
---|
| 400 | test_st_submit_kill_sig passed passed |
---|
| 401 | test_st_submit_polling_synchronize_timeout passed passed |
---|
| 402 | test_st_submit_polling_synchronize_zerotimeout passed passed |
---|
| 403 | test_st_submit_polling_wait_timeout passed passed |
---|
| 404 | test_st_submit_polling_wait_zerotimeout passed passed |
---|
| 405 | test_st_submit_suspend_resume_wait passed passed |
---|
| 406 | test_st_submit_wait passed passed |
---|
| 407 | test_st_submitmixture_sync_all_dispose passed passed |
---|
| 408 | test_st_submitmixture_sync_all_nodispose passed passed |
---|
| 409 | test_st_submitmixture_sync_allids_dispose passed passed |
---|
| 410 | test_st_submitmixture_sync_allids_nodispose passed passed |
---|
| 411 | test_st_supported_attr passed passed |
---|
| 412 | test_st_supported_vattr passed passed |
---|
| 413 | test_st_usage_check passed passed |
---|
| 414 | test_st_version passed passed |
---|
| 415 | =============================================== =========== ============ |
---|
| 416 | |
---|
| 417 | Developers |
---|
| 418 | ========== |
---|
| 419 | |
---|
| 420 | Core functionality of DRMAA is put into ``drmaa_utils`` library. |
---|
| 421 | This library was created in order to keep consistent common functionality |
---|
| 422 | of `DRMAA for Torque/PBS Pro`_ and other DRMAA libraries. As it is |
---|
| 423 | independent from any particular DRM you may found this library useful for |
---|
| 424 | developing other DRMAAs. |
---|
| 425 | |
---|
| 426 | Developer tools |
---|
| 427 | --------------- |
---|
| 428 | Although not needed for library user the following tools may be required |
---|
| 429 | if you intend to develop DRMAA for Torque/PBS Pro library or run tests: |
---|
| 430 | |
---|
| 431 | * GNU autotools (autoconf, automake, libtool), |
---|
| 432 | * Bison_ parser generator, |
---|
| 433 | * gperf_ perfect hash function generator, |
---|
| 434 | * Python_ (with development files) for Docutils_ and running test-suite |
---|
| 435 | (at least 2.5 version but not Python 3.* which will introduce |
---|
| 436 | incompatibilities), |
---|
| 437 | * Pyrex_ a Language for writing Python extension modules (>=0.9.6), |
---|
| 438 | * Docutils_ for processing this ``README``, |
---|
| 439 | * LaTeX_ for creating documentation in PDF format, |
---|
| 440 | * Doxygen_ for generating code documentation. |
---|
| 441 | |
---|
| 442 | .. _Bison: http://www.gnu.org/software/bison/ |
---|
| 443 | .. _gperf: http://www.gnu.org/software/gperf/ |
---|
| 444 | .. _Python: http://www.python.org/ |
---|
| 445 | .. _Pyrex: http://www.cosc.canterbury.ac.nz/greg.ewing/python/Pyrex/ |
---|
| 446 | .. _Docutils: http://docutils.sourceforge.net/ |
---|
| 447 | .. _LaTeX: http://www.latex-project.org/ |
---|
| 448 | .. _Doxygen: http://www.stack.nl/~dimitri/doxygen/ |
---|
| 449 | |
---|
| 450 | |
---|
| 451 | |
---|
| 452 | Contact |
---|
| 453 | ======= |
---|
| 454 | |
---|
| 455 | The DRMAA library for Torque and PBSPro is curently maintained by `Poznan Supercomputing and Networking Center`_. Please send |
---|
| 456 | your comments, questions and bug reports to: |
---|
| 457 | |
---|
| 458 | Mariusz Mamonski <mamonski@man.poznan.pl> |
---|
| 459 | |
---|
| 460 | |
---|
| 461 | |
---|
| 462 | |
---|
| 463 | .. _DRMAA: http://drmaa.org/ |
---|
| 464 | .. _Open Grid Forum: http://www.gridforum.org/ |
---|
| 465 | .. _specification: http://www.ogf.org/documents/GFD.22.pdf |
---|
| 466 | .. _Official DRMAA test-suite: http://www.drmaa.org/wiki/index.php?pagename=DrmaaTestsuite |
---|
| 467 | .. _FedStage DRMAA for PBS Pro: |
---|
| 468 | http://www.fedstage.com/wiki/FedStage_DRMAA_for_PBS_Pro |
---|
| 469 | .. _PBS DRMAA: http://www.fedstage.com/wiki/FedStage_DRMAA_for_PBS_Pro |
---|
| 470 | .. _FedStage Computing: http://www.fedstage.com/wiki/FedStage_Computing |
---|
| 471 | .. _PBS: http://en.wikipedia.org/wiki/Portable_Batch_System |
---|
| 472 | .. _PBS Professional: http://www.pbsgridworks.com/ |
---|
| 473 | .. _PBS Pro: http://www.pbsgridworks.com/ |
---|
| 474 | .. _Torque: http://www.clusterresources.com/pages/products/torque-resource-manager.php |
---|
| 475 | .. _OpenPBS: http://www.openpbs.org/ |
---|
| 476 | .. _Poznan Supercomputing and Networking Center: http://www.man.poznan.pl/online/en/ |
---|
| 477 | |
---|
| 478 | |
---|
| 479 | License |
---|
| 480 | ======= |
---|
| 481 | |
---|
| 482 | Copyright (C) 2006-2008 FedStage Systems |
---|
| 483 | |
---|
| 484 | This program is free software: you can redistribute it and/or modify |
---|
| 485 | it under the terms of the `GNU General Public License`_ as published |
---|
| 486 | by the Free Software Foundation, either version 3 of the License, or |
---|
| 487 | (at your option) any later version. |
---|
| 488 | |
---|
| 489 | This program is distributed in the hope that it will be useful, |
---|
| 490 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
| 491 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
---|
| 492 | GNU General Public License for more details. |
---|
| 493 | |
---|
| 494 | You should have received a copy of the `GNU General Public License`_ |
---|
| 495 | along with this program. If not, see <http://www.gnu.org/licenses/>. |
---|
| 496 | |
---|
| 497 | |
---|
| 498 | GNU General Public License |
---|
| 499 | -------------------------- |
---|
| 500 | Version 3, 29 June 2007 |
---|
| 501 | |
---|
| 502 | | Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> |
---|
| 503 | | Everyone is permitted to copy and distribute verbatim copies |
---|
| 504 | | of this license document, but changing it is not allowed. |
---|
| 505 | |
---|
| 506 | Preamble |
---|
| 507 | ........ |
---|
| 508 | |
---|
| 509 | The GNU General Public License is a free, copyleft license for |
---|
| 510 | software and other kinds of works. |
---|
| 511 | |
---|
| 512 | The licenses for most software and other practical works are designed |
---|
| 513 | to take away your freedom to share and change the works. By contrast, |
---|
| 514 | the GNU General Public License is intended to guarantee your freedom to |
---|
| 515 | share and change all versions of a program--to make sure it remains free |
---|
| 516 | software for all its users. We, the Free Software Foundation, use the |
---|
| 517 | GNU General Public License for most of our software; it applies also to |
---|
| 518 | any other work released this way by its authors. You can apply it to |
---|
| 519 | your programs, too. |
---|
| 520 | |
---|
| 521 | When we speak of free software, we are referring to freedom, not |
---|
| 522 | price. Our General Public Licenses are designed to make sure that you |
---|
| 523 | have the freedom to distribute copies of free software (and charge for |
---|
| 524 | them if you wish), that you receive source code or can get it if you |
---|
| 525 | want it, that you can change the software or use pieces of it in new |
---|
| 526 | free programs, and that you know you can do these things. |
---|
| 527 | |
---|
| 528 | To protect your rights, we need to prevent others from denying you |
---|
| 529 | these rights or asking you to surrender the rights. Therefore, you have |
---|
| 530 | certain responsibilities if you distribute copies of the software, or if |
---|
| 531 | you modify it: responsibilities to respect the freedom of others. |
---|
| 532 | |
---|
| 533 | For example, if you distribute copies of such a program, whether |
---|
| 534 | gratis or for a fee, you must pass on to the recipients the same |
---|
| 535 | freedoms that you received. You must make sure that they, too, receive |
---|
| 536 | or can get the source code. And you must show them these terms so they |
---|
| 537 | know their rights. |
---|
| 538 | |
---|
| 539 | Developers that use the GNU GPL protect your rights with two steps: |
---|
| 540 | (1) assert copyright on the software, and (2) offer you this License |
---|
| 541 | giving you legal permission to copy, distribute and/or modify it. |
---|
| 542 | |
---|
| 543 | For the developers' and authors' protection, the GPL clearly explains |
---|
| 544 | that there is no warranty for this free software. For both users' and |
---|
| 545 | authors' sake, the GPL requires that modified versions be marked as |
---|
| 546 | changed, so that their problems will not be attributed erroneously to |
---|
| 547 | authors of previous versions. |
---|
| 548 | |
---|
| 549 | Some devices are designed to deny users access to install or run |
---|
| 550 | modified versions of the software inside them, although the manufacturer |
---|
| 551 | can do so. This is fundamentally incompatible with the aim of |
---|
| 552 | protecting users' freedom to change the software. The systematic |
---|
| 553 | pattern of such abuse occurs in the area of products for individuals to |
---|
| 554 | use, which is precisely where it is most unacceptable. Therefore, we |
---|
| 555 | have designed this version of the GPL to prohibit the practice for those |
---|
| 556 | products. If such problems arise substantially in other domains, we |
---|
| 557 | stand ready to extend this provision to those domains in future versions |
---|
| 558 | of the GPL, as needed to protect the freedom of users. |
---|
| 559 | |
---|
| 560 | Finally, every program is threatened constantly by software patents. |
---|
| 561 | States should not allow patents to restrict development and use of |
---|
| 562 | software on general-purpose computers, but in those that do, we wish to |
---|
| 563 | avoid the special danger that patents applied to a free program could |
---|
| 564 | make it effectively proprietary. To prevent this, the GPL assures that |
---|
| 565 | patents cannot be used to render the program non-free. |
---|
| 566 | |
---|
| 567 | The precise terms and conditions for copying, distribution and |
---|
| 568 | modification follow. |
---|
| 569 | |
---|
| 570 | TERMS AND CONDITIONS |
---|
| 571 | .................... |
---|
| 572 | |
---|
| 573 | 0. Definitions. |
---|
| 574 | |
---|
| 575 | "This License" refers to version 3 of the GNU General Public License. |
---|
| 576 | |
---|
| 577 | "Copyright" also means copyright-like laws that apply to other kinds of |
---|
| 578 | works, such as semiconductor masks. |
---|
| 579 | |
---|
| 580 | "The Program" refers to any copyrightable work licensed under this |
---|
| 581 | License. Each licensee is addressed as "you". "Licensees" and |
---|
| 582 | "recipients" may be individuals or organizations. |
---|
| 583 | |
---|
| 584 | To "modify" a work means to copy from or adapt all or part of the work |
---|
| 585 | in a fashion requiring copyright permission, other than the making of an |
---|
| 586 | exact copy. The resulting work is called a "modified version" of the |
---|
| 587 | earlier work or a work "based on" the earlier work. |
---|
| 588 | |
---|
| 589 | A "covered work" means either the unmodified Program or a work based |
---|
| 590 | on the Program. |
---|
| 591 | |
---|
| 592 | To "propagate" a work means to do anything with it that, without |
---|
| 593 | permission, would make you directly or secondarily liable for |
---|
| 594 | infringement under applicable copyright law, except executing it on a |
---|
| 595 | computer or modifying a private copy. Propagation includes copying, |
---|
| 596 | distribution (with or without modification), making available to the |
---|
| 597 | public, and in some countries other activities as well. |
---|
| 598 | |
---|
| 599 | To "convey" a work means any kind of propagation that enables other |
---|
| 600 | parties to make or receive copies. Mere interaction with a user through |
---|
| 601 | a computer network, with no transfer of a copy, is not conveying. |
---|
| 602 | |
---|
| 603 | An interactive user interface displays "Appropriate Legal Notices" |
---|
| 604 | to the extent that it includes a convenient and prominently visible |
---|
| 605 | feature that (1) displays an appropriate copyright notice, and (2) |
---|
| 606 | tells the user that there is no warranty for the work (except to the |
---|
| 607 | extent that warranties are provided), that licensees may convey the |
---|
| 608 | work under this License, and how to view a copy of this License. If |
---|
| 609 | the interface presents a list of user commands or options, such as a |
---|
| 610 | menu, a prominent item in the list meets this criterion. |
---|
| 611 | |
---|
| 612 | 1. Source Code. |
---|
| 613 | |
---|
| 614 | The "source code" for a work means the preferred form of the work |
---|
| 615 | for making modifications to it. "Object code" means any non-source |
---|
| 616 | form of a work. |
---|
| 617 | |
---|
| 618 | A "Standard Interface" means an interface that either is an official |
---|
| 619 | standard defined by a recognized standards body, or, in the case of |
---|
| 620 | interfaces specified for a particular programming language, one that |
---|
| 621 | is widely used among developers working in that language. |
---|
| 622 | |
---|
| 623 | The "System Libraries" of an executable work include anything, other |
---|
| 624 | than the work as a whole, that (a) is included in the normal form of |
---|
| 625 | packaging a Major Component, but which is not part of that Major |
---|
| 626 | Component, and (b) serves only to enable use of the work with that |
---|
| 627 | Major Component, or to implement a Standard Interface for which an |
---|
| 628 | implementation is available to the public in source code form. A |
---|
| 629 | "Major Component", in this context, means a major essential component |
---|
| 630 | (kernel, window system, and so on) of the specific operating system |
---|
| 631 | (if any) on which the executable work runs, or a compiler used to |
---|
| 632 | produce the work, or an object code interpreter used to run it. |
---|
| 633 | |
---|
| 634 | The "Corresponding Source" for a work in object code form means all |
---|
| 635 | the source code needed to generate, install, and (for an executable |
---|
| 636 | work) run the object code and to modify the work, including scripts to |
---|
| 637 | control those activities. However, it does not include the work's |
---|
| 638 | System Libraries, or general-purpose tools or generally available free |
---|
| 639 | programs which are used unmodified in performing those activities but |
---|
| 640 | which are not part of the work. For example, Corresponding Source |
---|
| 641 | includes interface definition files associated with source files for |
---|
| 642 | the work, and the source code for shared libraries and dynamically |
---|
| 643 | linked subprograms that the work is specifically designed to require, |
---|
| 644 | such as by intimate data communication or control flow between those |
---|
| 645 | subprograms and other parts of the work. |
---|
| 646 | |
---|
| 647 | The Corresponding Source need not include anything that users |
---|
| 648 | can regenerate automatically from other parts of the Corresponding |
---|
| 649 | Source. |
---|
| 650 | |
---|
| 651 | The Corresponding Source for a work in source code form is that |
---|
| 652 | same work. |
---|
| 653 | |
---|
| 654 | 2. Basic Permissions. |
---|
| 655 | |
---|
| 656 | All rights granted under this License are granted for the term of |
---|
| 657 | copyright on the Program, and are irrevocable provided the stated |
---|
| 658 | conditions are met. This License explicitly affirms your unlimited |
---|
| 659 | permission to run the unmodified Program. The output from running a |
---|
| 660 | covered work is covered by this License only if the output, given its |
---|
| 661 | content, constitutes a covered work. This License acknowledges your |
---|
| 662 | rights of fair use or other equivalent, as provided by copyright law. |
---|
| 663 | |
---|
| 664 | You may make, run and propagate covered works that you do not |
---|
| 665 | convey, without conditions so long as your license otherwise remains |
---|
| 666 | in force. You may convey covered works to others for the sole purpose |
---|
| 667 | of having them make modifications exclusively for you, or provide you |
---|
| 668 | with facilities for running those works, provided that you comply with |
---|
| 669 | the terms of this License in conveying all material for which you do |
---|
| 670 | not control copyright. Those thus making or running the covered works |
---|
| 671 | for you must do so exclusively on your behalf, under your direction |
---|
| 672 | and control, on terms that prohibit them from making any copies of |
---|
| 673 | your copyrighted material outside their relationship with you. |
---|
| 674 | |
---|
| 675 | Conveying under any other circumstances is permitted solely under |
---|
| 676 | the conditions stated below. Sublicensing is not allowed; section 10 |
---|
| 677 | makes it unnecessary. |
---|
| 678 | |
---|
| 679 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. |
---|
| 680 | |
---|
| 681 | No covered work shall be deemed part of an effective technological |
---|
| 682 | measure under any applicable law fulfilling obligations under article |
---|
| 683 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or |
---|
| 684 | similar laws prohibiting or restricting circumvention of such |
---|
| 685 | measures. |
---|
| 686 | |
---|
| 687 | When you convey a covered work, you waive any legal power to forbid |
---|
| 688 | circumvention of technological measures to the extent such circumvention |
---|
| 689 | is effected by exercising rights under this License with respect to |
---|
| 690 | the covered work, and you disclaim any intention to limit operation or |
---|
| 691 | modification of the work as a means of enforcing, against the work's |
---|
| 692 | users, your or third parties' legal rights to forbid circumvention of |
---|
| 693 | technological measures. |
---|
| 694 | |
---|
| 695 | 4. Conveying Verbatim Copies. |
---|
| 696 | |
---|
| 697 | You may convey verbatim copies of the Program's source code as you |
---|
| 698 | receive it, in any medium, provided that you conspicuously and |
---|
| 699 | appropriately publish on each copy an appropriate copyright notice; |
---|
| 700 | keep intact all notices stating that this License and any |
---|
| 701 | non-permissive terms added in accord with section 7 apply to the code; |
---|
| 702 | keep intact all notices of the absence of any warranty; and give all |
---|
| 703 | recipients a copy of this License along with the Program. |
---|
| 704 | |
---|
| 705 | You may charge any price or no price for each copy that you convey, |
---|
| 706 | and you may offer support or warranty protection for a fee. |
---|
| 707 | |
---|
| 708 | 5. Conveying Modified Source Versions. |
---|
| 709 | |
---|
| 710 | You may convey a work based on the Program, or the modifications to |
---|
| 711 | produce it from the Program, in the form of source code under the |
---|
| 712 | terms of section 4, provided that you also meet all of these conditions: |
---|
| 713 | |
---|
| 714 | a) The work must carry prominent notices stating that you modified |
---|
| 715 | it, and giving a relevant date. |
---|
| 716 | |
---|
| 717 | b) The work must carry prominent notices stating that it is |
---|
| 718 | released under this License and any conditions added under section |
---|
| 719 | 7. This requirement modifies the requirement in section 4 to |
---|
| 720 | "keep intact all notices". |
---|
| 721 | |
---|
| 722 | c) You must license the entire work, as a whole, under this |
---|
| 723 | License to anyone who comes into possession of a copy. This |
---|
| 724 | License will therefore apply, along with any applicable section 7 |
---|
| 725 | additional terms, to the whole of the work, and all its parts, |
---|
| 726 | regardless of how they are packaged. This License gives no |
---|
| 727 | permission to license the work in any other way, but it does not |
---|
| 728 | invalidate such permission if you have separately received it. |
---|
| 729 | |
---|
| 730 | d) If the work has interactive user interfaces, each must display |
---|
| 731 | Appropriate Legal Notices; however, if the Program has interactive |
---|
| 732 | interfaces that do not display Appropriate Legal Notices, your |
---|
| 733 | work need not make them do so. |
---|
| 734 | |
---|
| 735 | A compilation of a covered work with other separate and independent |
---|
| 736 | works, which are not by their nature extensions of the covered work, |
---|
| 737 | and which are not combined with it such as to form a larger program, |
---|
| 738 | in or on a volume of a storage or distribution medium, is called an |
---|
| 739 | "aggregate" if the compilation and its resulting copyright are not |
---|
| 740 | used to limit the access or legal rights of the compilation's users |
---|
| 741 | beyond what the individual works permit. Inclusion of a covered work |
---|
| 742 | in an aggregate does not cause this License to apply to the other |
---|
| 743 | parts of the aggregate. |
---|
| 744 | |
---|
| 745 | 6. Conveying Non-Source Forms. |
---|
| 746 | |
---|
| 747 | You may convey a covered work in object code form under the terms |
---|
| 748 | of sections 4 and 5, provided that you also convey the |
---|
| 749 | machine-readable Corresponding Source under the terms of this License, |
---|
| 750 | in one of these ways: |
---|
| 751 | |
---|
| 752 | a) Convey the object code in, or embodied in, a physical product |
---|
| 753 | (including a physical distribution medium), accompanied by the |
---|
| 754 | Corresponding Source fixed on a durable physical medium |
---|
| 755 | customarily used for software interchange. |
---|
| 756 | |
---|
| 757 | b) Convey the object code in, or embodied in, a physical product |
---|
| 758 | (including a physical distribution medium), accompanied by a |
---|
| 759 | written offer, valid for at least three years and valid for as |
---|
| 760 | long as you offer spare parts or customer support for that product |
---|
| 761 | model, to give anyone who possesses the object code either (1) a |
---|
| 762 | copy of the Corresponding Source for all the software in the |
---|
| 763 | product that is covered by this License, on a durable physical |
---|
| 764 | medium customarily used for software interchange, for a price no |
---|
| 765 | more than your reasonable cost of physically performing this |
---|
| 766 | conveying of source, or (2) access to copy the |
---|
| 767 | Corresponding Source from a network server at no charge. |
---|
| 768 | |
---|
| 769 | c) Convey individual copies of the object code with a copy of the |
---|
| 770 | written offer to provide the Corresponding Source. This |
---|
| 771 | alternative is allowed only occasionally and noncommercially, and |
---|
| 772 | only if you received the object code with such an offer, in accord |
---|
| 773 | with subsection 6b. |
---|
| 774 | |
---|
| 775 | d) Convey the object code by offering access from a designated |
---|
| 776 | place (gratis or for a charge), and offer equivalent access to the |
---|
| 777 | Corresponding Source in the same way through the same place at no |
---|
| 778 | further charge. You need not require recipients to copy the |
---|
| 779 | Corresponding Source along with the object code. If the place to |
---|
| 780 | copy the object code is a network server, the Corresponding Source |
---|
| 781 | may be on a different server (operated by you or a third party) |
---|
| 782 | that supports equivalent copying facilities, provided you maintain |
---|
| 783 | clear directions next to the object code saying where to find the |
---|
| 784 | Corresponding Source. Regardless of what server hosts the |
---|
| 785 | Corresponding Source, you remain obligated to ensure that it is |
---|
| 786 | available for as long as needed to satisfy these requirements. |
---|
| 787 | |
---|
| 788 | e) Convey the object code using peer-to-peer transmission, provided |
---|
| 789 | you inform other peers where the object code and Corresponding |
---|
| 790 | Source of the work are being offered to the general public at no |
---|
| 791 | charge under subsection 6d. |
---|
| 792 | |
---|
| 793 | A separable portion of the object code, whose source code is excluded |
---|
| 794 | from the Corresponding Source as a System Library, need not be |
---|
| 795 | included in conveying the object code work. |
---|
| 796 | |
---|
| 797 | A "User Product" is either (1) a "consumer product", which means any |
---|
| 798 | tangible personal property which is normally used for personal, family, |
---|
| 799 | or household purposes, or (2) anything designed or sold for incorporation |
---|
| 800 | into a dwelling. In determining whether a product is a consumer product, |
---|
| 801 | doubtful cases shall be resolved in favor of coverage. For a particular |
---|
| 802 | product received by a particular user, "normally used" refers to a |
---|
| 803 | typical or common use of that class of product, regardless of the status |
---|
| 804 | of the particular user or of the way in which the particular user |
---|
| 805 | actually uses, or expects or is expected to use, the product. A product |
---|
| 806 | is a consumer product regardless of whether the product has substantial |
---|
| 807 | commercial, industrial or non-consumer uses, unless such uses represent |
---|
| 808 | the only significant mode of use of the product. |
---|
| 809 | |
---|
| 810 | "Installation Information" for a User Product means any methods, |
---|
| 811 | procedures, authorization keys, or other information required to install |
---|
| 812 | and execute modified versions of a covered work in that User Product from |
---|
| 813 | a modified version of its Corresponding Source. The information must |
---|
| 814 | suffice to ensure that the continued functioning of the modified object |
---|
| 815 | code is in no case prevented or interfered with solely because |
---|
| 816 | modification has been made. |
---|
| 817 | |
---|
| 818 | If you convey an object code work under this section in, or with, or |
---|
| 819 | specifically for use in, a User Product, and the conveying occurs as |
---|
| 820 | part of a transaction in which the right of possession and use of the |
---|
| 821 | User Product is transferred to the recipient in perpetuity or for a |
---|
| 822 | fixed term (regardless of how the transaction is characterized), the |
---|
| 823 | Corresponding Source conveyed under this section must be accompanied |
---|
| 824 | by the Installation Information. But this requirement does not apply |
---|
| 825 | if neither you nor any third party retains the ability to install |
---|
| 826 | modified object code on the User Product (for example, the work has |
---|
| 827 | been installed in ROM). |
---|
| 828 | |
---|
| 829 | The requirement to provide Installation Information does not include a |
---|
| 830 | requirement to continue to provide support service, warranty, or updates |
---|
| 831 | for a work that has been modified or installed by the recipient, or for |
---|
| 832 | the User Product in which it has been modified or installed. Access to a |
---|
| 833 | network may be denied when the modification itself materially and |
---|
| 834 | adversely affects the operation of the network or violates the rules and |
---|
| 835 | protocols for communication across the network. |
---|
| 836 | |
---|
| 837 | Corresponding Source conveyed, and Installation Information provided, |
---|
| 838 | in accord with this section must be in a format that is publicly |
---|
| 839 | documented (and with an implementation available to the public in |
---|
| 840 | source code form), and must require no special password or key for |
---|
| 841 | unpacking, reading or copying. |
---|
| 842 | |
---|
| 843 | 7. Additional Terms. |
---|
| 844 | |
---|
| 845 | "Additional permissions" are terms that supplement the terms of this |
---|
| 846 | License by making exceptions from one or more of its conditions. |
---|
| 847 | Additional permissions that are applicable to the entire Program shall |
---|
| 848 | be treated as though they were included in this License, to the extent |
---|
| 849 | that they are valid under applicable law. If additional permissions |
---|
| 850 | apply only to part of the Program, that part may be used separately |
---|
| 851 | under those permissions, but the entire Program remains governed by |
---|
| 852 | this License without regard to the additional permissions. |
---|
| 853 | |
---|
| 854 | When you convey a copy of a covered work, you may at your option |
---|
| 855 | remove any additional permissions from that copy, or from any part of |
---|
| 856 | it. (Additional permissions may be written to require their own |
---|
| 857 | removal in certain cases when you modify the work.) You may place |
---|
| 858 | additional permissions on material, added by you to a covered work, |
---|
| 859 | for which you have or can give appropriate copyright permission. |
---|
| 860 | |
---|
| 861 | Notwithstanding any other provision of this License, for material you |
---|
| 862 | add to a covered work, you may (if authorized by the copyright holders of |
---|
| 863 | that material) supplement the terms of this License with terms: |
---|
| 864 | |
---|
| 865 | a) Disclaiming warranty or limiting liability differently from the |
---|
| 866 | terms of sections 15 and 16 of this License; or |
---|
| 867 | |
---|
| 868 | b) Requiring preservation of specified reasonable legal notices or |
---|
| 869 | author attributions in that material or in the Appropriate Legal |
---|
| 870 | Notices displayed by works containing it; or |
---|
| 871 | |
---|
| 872 | c) Prohibiting misrepresentation of the origin of that material, or |
---|
| 873 | requiring that modified versions of such material be marked in |
---|
| 874 | reasonable ways as different from the original version; or |
---|
| 875 | |
---|
| 876 | d) Limiting the use for publicity purposes of names of licensors or |
---|
| 877 | authors of the material; or |
---|
| 878 | |
---|
| 879 | e) Declining to grant rights under trademark law for use of some |
---|
| 880 | trade names, trademarks, or service marks; or |
---|
| 881 | |
---|
| 882 | f) Requiring indemnification of licensors and authors of that |
---|
| 883 | material by anyone who conveys the material (or modified versions of |
---|
| 884 | it) with contractual assumptions of liability to the recipient, for |
---|
| 885 | any liability that these contractual assumptions directly impose on |
---|
| 886 | those licensors and authors. |
---|
| 887 | |
---|
| 888 | All other non-permissive additional terms are considered "further |
---|
| 889 | restrictions" within the meaning of section 10. If the Program as you |
---|
| 890 | received it, or any part of it, contains a notice stating that it is |
---|
| 891 | governed by this License along with a term that is a further |
---|
| 892 | restriction, you may remove that term. If a license document contains |
---|
| 893 | a further restriction but permits relicensing or conveying under this |
---|
| 894 | License, you may add to a covered work material governed by the terms |
---|
| 895 | of that license document, provided that the further restriction does |
---|
| 896 | not survive such relicensing or conveying. |
---|
| 897 | |
---|
| 898 | If you add terms to a covered work in accord with this section, you |
---|
| 899 | must place, in the relevant source files, a statement of the |
---|
| 900 | additional terms that apply to those files, or a notice indicating |
---|
| 901 | where to find the applicable terms. |
---|
| 902 | |
---|
| 903 | Additional terms, permissive or non-permissive, may be stated in the |
---|
| 904 | form of a separately written license, or stated as exceptions; |
---|
| 905 | the above requirements apply either way. |
---|
| 906 | |
---|
| 907 | 8. Termination. |
---|
| 908 | |
---|
| 909 | You may not propagate or modify a covered work except as expressly |
---|
| 910 | provided under this License. Any attempt otherwise to propagate or |
---|
| 911 | modify it is void, and will automatically terminate your rights under |
---|
| 912 | this License (including any patent licenses granted under the third |
---|
| 913 | paragraph of section 11). |
---|
| 914 | |
---|
| 915 | However, if you cease all violation of this License, then your |
---|
| 916 | license from a particular copyright holder is reinstated (a) |
---|
| 917 | provisionally, unless and until the copyright holder explicitly and |
---|
| 918 | finally terminates your license, and (b) permanently, if the copyright |
---|
| 919 | holder fails to notify you of the violation by some reasonable means |
---|
| 920 | prior to 60 days after the cessation. |
---|
| 921 | |
---|
| 922 | Moreover, your license from a particular copyright holder is |
---|
| 923 | reinstated permanently if the copyright holder notifies you of the |
---|
| 924 | violation by some reasonable means, this is the first time you have |
---|
| 925 | received notice of violation of this License (for any work) from that |
---|
| 926 | copyright holder, and you cure the violation prior to 30 days after |
---|
| 927 | your receipt of the notice. |
---|
| 928 | |
---|
| 929 | Termination of your rights under this section does not terminate the |
---|
| 930 | licenses of parties who have received copies or rights from you under |
---|
| 931 | this License. If your rights have been terminated and not permanently |
---|
| 932 | reinstated, you do not qualify to receive new licenses for the same |
---|
| 933 | material under section 10. |
---|
| 934 | |
---|
| 935 | 9. Acceptance Not Required for Having Copies. |
---|
| 936 | |
---|
| 937 | You are not required to accept this License in order to receive or |
---|
| 938 | run a copy of the Program. Ancillary propagation of a covered work |
---|
| 939 | occurring solely as a consequence of using peer-to-peer transmission |
---|
| 940 | to receive a copy likewise does not require acceptance. However, |
---|
| 941 | nothing other than this License grants you permission to propagate or |
---|
| 942 | modify any covered work. These actions infringe copyright if you do |
---|
| 943 | not accept this License. Therefore, by modifying or propagating a |
---|
| 944 | covered work, you indicate your acceptance of this License to do so. |
---|
| 945 | |
---|
| 946 | 10. Automatic Licensing of Downstream Recipients. |
---|
| 947 | |
---|
| 948 | Each time you convey a covered work, the recipient automatically |
---|
| 949 | receives a license from the original licensors, to run, modify and |
---|
| 950 | propagate that work, subject to this License. You are not responsible |
---|
| 951 | for enforcing compliance by third parties with this License. |
---|
| 952 | |
---|
| 953 | An "entity transaction" is a transaction transferring control of an |
---|
| 954 | organization, or substantially all assets of one, or subdividing an |
---|
| 955 | organization, or merging organizations. If propagation of a covered |
---|
| 956 | work results from an entity transaction, each party to that |
---|
| 957 | transaction who receives a copy of the work also receives whatever |
---|
| 958 | licenses to the work the party's predecessor in interest had or could |
---|
| 959 | give under the previous paragraph, plus a right to possession of the |
---|
| 960 | Corresponding Source of the work from the predecessor in interest, if |
---|
| 961 | the predecessor has it or can get it with reasonable efforts. |
---|
| 962 | |
---|
| 963 | You may not impose any further restrictions on the exercise of the |
---|
| 964 | rights granted or affirmed under this License. For example, you may |
---|
| 965 | not impose a license fee, royalty, or other charge for exercise of |
---|
| 966 | rights granted under this License, and you may not initiate litigation |
---|
| 967 | (including a cross-claim or counterclaim in a lawsuit) alleging that |
---|
| 968 | any patent claim is infringed by making, using, selling, offering for |
---|
| 969 | sale, or importing the Program or any portion of it. |
---|
| 970 | |
---|
| 971 | 11. Patents. |
---|
| 972 | |
---|
| 973 | A "contributor" is a copyright holder who authorizes use under this |
---|
| 974 | License of the Program or a work on which the Program is based. The |
---|
| 975 | work thus licensed is called the contributor's "contributor version". |
---|
| 976 | |
---|
| 977 | A contributor's "essential patent claims" are all patent claims |
---|
| 978 | owned or controlled by the contributor, whether already acquired or |
---|
| 979 | hereafter acquired, that would be infringed by some manner, permitted |
---|
| 980 | by this License, of making, using, or selling its contributor version, |
---|
| 981 | but do not include claims that would be infringed only as a |
---|
| 982 | consequence of further modification of the contributor version. For |
---|
| 983 | purposes of this definition, "control" includes the right to grant |
---|
| 984 | patent sublicenses in a manner consistent with the requirements of |
---|
| 985 | this License. |
---|
| 986 | |
---|
| 987 | Each contributor grants you a non-exclusive, worldwide, royalty-free |
---|
| 988 | patent license under the contributor's essential patent claims, to |
---|
| 989 | make, use, sell, offer for sale, import and otherwise run, modify and |
---|
| 990 | propagate the contents of its contributor version. |
---|
| 991 | |
---|
| 992 | In the following three paragraphs, a "patent license" is any express |
---|
| 993 | agreement or commitment, however denominated, not to enforce a patent |
---|
| 994 | (such as an express permission to practice a patent or covenant not to |
---|
| 995 | sue for patent infringement). To "grant" such a patent license to a |
---|
| 996 | party means to make such an agreement or commitment not to enforce a |
---|
| 997 | patent against the party. |
---|
| 998 | |
---|
| 999 | If you convey a covered work, knowingly relying on a patent license, |
---|
| 1000 | and the Corresponding Source of the work is not available for anyone |
---|
| 1001 | to copy, free of charge and under the terms of this License, through a |
---|
| 1002 | publicly available network server or other readily accessible means, |
---|
| 1003 | then you must either (1) cause the Corresponding Source to be so |
---|
| 1004 | available, or (2) arrange to deprive yourself of the benefit of the |
---|
| 1005 | patent license for this particular work, or (3) arrange, in a manner |
---|
| 1006 | consistent with the requirements of this License, to extend the patent |
---|
| 1007 | license to downstream recipients. "Knowingly relying" means you have |
---|
| 1008 | actual knowledge that, but for the patent license, your conveying the |
---|
| 1009 | covered work in a country, or your recipient's use of the covered work |
---|
| 1010 | in a country, would infringe one or more identifiable patents in that |
---|
| 1011 | country that you have reason to believe are valid. |
---|
| 1012 | |
---|
| 1013 | If, pursuant to or in connection with a single transaction or |
---|
| 1014 | arrangement, you convey, or propagate by procuring conveyance of, a |
---|
| 1015 | covered work, and grant a patent license to some of the parties |
---|
| 1016 | receiving the covered work authorizing them to use, propagate, modify |
---|
| 1017 | or convey a specific copy of the covered work, then the patent license |
---|
| 1018 | you grant is automatically extended to all recipients of the covered |
---|
| 1019 | work and works based on it. |
---|
| 1020 | |
---|
| 1021 | A patent license is "discriminatory" if it does not include within |
---|
| 1022 | the scope of its coverage, prohibits the exercise of, or is |
---|
| 1023 | conditioned on the non-exercise of one or more of the rights that are |
---|
| 1024 | specifically granted under this License. You may not convey a covered |
---|
| 1025 | work if you are a party to an arrangement with a third party that is |
---|
| 1026 | in the business of distributing software, under which you make payment |
---|
| 1027 | to the third party based on the extent of your activity of conveying |
---|
| 1028 | the work, and under which the third party grants, to any of the |
---|
| 1029 | parties who would receive the covered work from you, a discriminatory |
---|
| 1030 | patent license (a) in connection with copies of the covered work |
---|
| 1031 | conveyed by you (or copies made from those copies), or (b) primarily |
---|
| 1032 | for and in connection with specific products or compilations that |
---|
| 1033 | contain the covered work, unless you entered into that arrangement, |
---|
| 1034 | or that patent license was granted, prior to 28 March 2007. |
---|
| 1035 | |
---|
| 1036 | Nothing in this License shall be construed as excluding or limiting |
---|
| 1037 | any implied license or other defenses to infringement that may |
---|
| 1038 | otherwise be available to you under applicable patent law. |
---|
| 1039 | |
---|
| 1040 | 12. No Surrender of Others' Freedom. |
---|
| 1041 | |
---|
| 1042 | If conditions are imposed on you (whether by court order, agreement or |
---|
| 1043 | otherwise) that contradict the conditions of this License, they do not |
---|
| 1044 | excuse you from the conditions of this License. If you cannot convey a |
---|
| 1045 | covered work so as to satisfy simultaneously your obligations under this |
---|
| 1046 | License and any other pertinent obligations, then as a consequence you may |
---|
| 1047 | not convey it at all. For example, if you agree to terms that obligate you |
---|
| 1048 | to collect a royalty for further conveying from those to whom you convey |
---|
| 1049 | the Program, the only way you could satisfy both those terms and this |
---|
| 1050 | License would be to refrain entirely from conveying the Program. |
---|
| 1051 | |
---|
| 1052 | 13. Use with the GNU Affero General Public License. |
---|
| 1053 | |
---|
| 1054 | Notwithstanding any other provision of this License, you have |
---|
| 1055 | permission to link or combine any covered work with a work licensed |
---|
| 1056 | under version 3 of the GNU Affero General Public License into a single |
---|
| 1057 | combined work, and to convey the resulting work. The terms of this |
---|
| 1058 | License will continue to apply to the part which is the covered work, |
---|
| 1059 | but the special requirements of the GNU Affero General Public License, |
---|
| 1060 | section 13, concerning interaction through a network will apply to the |
---|
| 1061 | combination as such. |
---|
| 1062 | |
---|
| 1063 | 14. Revised Versions of this License. |
---|
| 1064 | |
---|
| 1065 | The Free Software Foundation may publish revised and/or new versions of |
---|
| 1066 | the GNU General Public License from time to time. Such new versions will |
---|
| 1067 | be similar in spirit to the present version, but may differ in detail to |
---|
| 1068 | address new problems or concerns. |
---|
| 1069 | |
---|
| 1070 | Each version is given a distinguishing version number. If the |
---|
| 1071 | Program specifies that a certain numbered version of the GNU General |
---|
| 1072 | Public License "or any later version" applies to it, you have the |
---|
| 1073 | option of following the terms and conditions either of that numbered |
---|
| 1074 | version or of any later version published by the Free Software |
---|
| 1075 | Foundation. If the Program does not specify a version number of the |
---|
| 1076 | GNU General Public License, you may choose any version ever published |
---|
| 1077 | by the Free Software Foundation. |
---|
| 1078 | |
---|
| 1079 | If the Program specifies that a proxy can decide which future |
---|
| 1080 | versions of the GNU General Public License can be used, that proxy's |
---|
| 1081 | public statement of acceptance of a version permanently authorizes you |
---|
| 1082 | to choose that version for the Program. |
---|
| 1083 | |
---|
| 1084 | Later license versions may give you additional or different |
---|
| 1085 | permissions. However, no additional obligations are imposed on any |
---|
| 1086 | author or copyright holder as a result of your choosing to follow a |
---|
| 1087 | later version. |
---|
| 1088 | |
---|
| 1089 | 15. Disclaimer of Warranty. |
---|
| 1090 | |
---|
| 1091 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY |
---|
| 1092 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT |
---|
| 1093 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY |
---|
| 1094 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, |
---|
| 1095 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |
---|
| 1096 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM |
---|
| 1097 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF |
---|
| 1098 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. |
---|
| 1099 | |
---|
| 1100 | 16. Limitation of Liability. |
---|
| 1101 | |
---|
| 1102 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING |
---|
| 1103 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS |
---|
| 1104 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY |
---|
| 1105 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE |
---|
| 1106 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF |
---|
| 1107 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD |
---|
| 1108 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), |
---|
| 1109 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF |
---|
| 1110 | SUCH DAMAGES. |
---|
| 1111 | |
---|
| 1112 | 17. Interpretation of Sections 15 and 16. |
---|
| 1113 | |
---|
| 1114 | If the disclaimer of warranty and limitation of liability provided |
---|
| 1115 | above cannot be given local legal effect according to their terms, |
---|
| 1116 | reviewing courts shall apply local law that most closely approximates |
---|
| 1117 | an absolute waiver of all civil liability in connection with the |
---|
| 1118 | Program, unless a warranty or assumption of liability accompanies a |
---|
| 1119 | copy of the Program in return for a fee. |
---|
| 1120 | |
---|
| 1121 | END OF TERMS AND CONDITIONS |
---|
| 1122 | |
---|
| 1123 | How to Apply These Terms to Your New Programs |
---|
| 1124 | ............................................. |
---|
| 1125 | |
---|
| 1126 | If you develop a new program, and you want it to be of the greatest |
---|
| 1127 | possible use to the public, the best way to achieve this is to make it |
---|
| 1128 | free software which everyone can redistribute and change under these terms. |
---|
| 1129 | |
---|
| 1130 | To do so, attach the following notices to the program. It is safest |
---|
| 1131 | to attach them to the start of each source file to most effectively |
---|
| 1132 | state the exclusion of warranty; and each file should have at least |
---|
| 1133 | the "copyright" line and a pointer to where the full notice is found. |
---|
| 1134 | :: |
---|
| 1135 | |
---|
| 1136 | <one line to give the program's name and a brief idea of what it does.> |
---|
| 1137 | Copyright (C) <year> <name of author> |
---|
| 1138 | |
---|
| 1139 | This program is free software: you can redistribute it and/or modify |
---|
| 1140 | it under the terms of the GNU General Public License as published by |
---|
| 1141 | the Free Software Foundation, either version 3 of the License, or |
---|
| 1142 | (at your option) any later version. |
---|
| 1143 | |
---|
| 1144 | This program is distributed in the hope that it will be useful, |
---|
| 1145 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
| 1146 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
---|
| 1147 | GNU General Public License for more details. |
---|
| 1148 | |
---|
| 1149 | You should have received a copy of the GNU General Public License |
---|
| 1150 | along with this program. If not, see <http://www.gnu.org/licenses/>. |
---|
| 1151 | |
---|
| 1152 | Also add information on how to contact you by electronic and paper mail. |
---|
| 1153 | |
---|
| 1154 | If the program does terminal interaction, make it output a short |
---|
| 1155 | notice like this when it starts in an interactive mode:: |
---|
| 1156 | |
---|
| 1157 | <program> Copyright (C) <year> <name of author> |
---|
| 1158 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. |
---|
| 1159 | This is free software, and you are welcome to redistribute it |
---|
| 1160 | under certain conditions; type `show c' for details. |
---|
| 1161 | |
---|
| 1162 | The hypothetical commands ``show w`` and ``show c`` should show the |
---|
| 1163 | appropriate parts of the General Public License. Of course, your |
---|
| 1164 | program's commands might be different; for a GUI interface, you would |
---|
| 1165 | use an "about box". |
---|
| 1166 | |
---|
| 1167 | You should also get your employer (if you work as a programmer) or school, |
---|
| 1168 | if any, to sign a "copyright disclaimer" for the program, if necessary. |
---|
| 1169 | For more information on this, and how to apply and follow the GNU GPL, see |
---|
| 1170 | <http://www.gnu.org/licenses/>. |
---|
| 1171 | |
---|
| 1172 | The GNU General Public License does not permit incorporating your program |
---|
| 1173 | into proprietary programs. If your program is a subroutine library, you |
---|
| 1174 | may consider it more useful to permit linking proprietary applications with |
---|
| 1175 | the library. If this is what you want to do, use the GNU Lesser General |
---|
| 1176 | Public License instead of this License. But first, please read |
---|
| 1177 | <http://www.gnu.org/philosophy/why-not-lgpl.html>. |
---|
| 1178 | |
---|
| 1179 | |
---|
| 1180 | |
---|
| 1181 | .. role:: raw-html(raw) |
---|
| 1182 | :format: html |
---|
| 1183 | .. role:: raw-latex(raw) |
---|
| 1184 | :format: latex |
---|
| 1185 | .. |--| unicode:: U+02013 .. en dash |
---|
| 1186 | :trim: |
---|
| 1187 | .. |---| unicode:: U+02014 .. em dash |
---|
| 1188 | .. |LaTeX| replace:: :raw-html:`LaTeX` :raw-latex:`\LaTeX{}` |
---|
| 1189 | |
---|
| 1190 | .. vim: ft=rest |
---|
| 1191 | .. vim700: spell spelllang=en |
---|