program.rst 1.19 KB
Newer Older
1
2
.. vim: set fileencoding=utf-8 :
.. Andre Anjos <andre.anjos@idiap.ch>
3
.. Thu 25 Aug 2011 15:58:21 CEST
4

5
.. _developer:
6

André Anjos's avatar
André Anjos committed
7
8
9
=======================
 The GridTk User Guide
=======================
10

André Anjos's avatar
André Anjos committed
11
12
13
The ``gridtk`` framework is a python library to help submitting, tracking and
querying SGE.  Here is quick example on how to use the ``gridtk`` framework to
submit a python script:
14
15
16

.. code-block:: python

André Anjos's avatar
André Anjos committed
17
   import sys
18
   from gridtk.sge import JobManagerSGE
André Anjos's avatar
André Anjos committed
19
20
   from gridtk.tools import make_shell

21
   manager = JobManagerSGE()
André Anjos's avatar
André Anjos committed
22
23
   command = make_shell(sys.executable, ['myscript.py', '--help'])
   job = manager.submit(command)
24
25


André Anjos's avatar
André Anjos committed
26
You can do, programatically, everything you can do with the job manager - just
André Anjos's avatar
André Anjos committed
27
browse the help messages and the ``jman`` script for more information.
28
29


30
31
API to the Job Managers
=======================
32
33
34
35

.. automodule:: gridtk.manager
  :members:

36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

.. automodule:: gridtk.sge
  :members:

.. automodule:: gridtk.local
  :members:


The Models of the SQL3 Databases
================================

.. automodule:: gridtk.models
  :members:


51
52
53
54
55
56
57
58
59
60
61
Middleware
==========

.. automodule:: gridtk.tools
  :members:

Low-level Utilities
===================

.. automodule:: gridtk.setshell
  :members: