README.rst 1.99 KB
Newer Older
André Anjos's avatar
André Anjos committed
1
2
.. vim: set fileencoding=utf-8 :
.. Tue 16 Aug 16:07:37 CEST 2016
Amir Mohammadi's avatar
Amir Mohammadi committed
3
4
5
6

.. image:: http://img.shields.io/badge/docs-stable-yellow.png
   :target: http://pythonhosted.org/gridtk/index.html
.. image:: http://img.shields.io/badge/docs-latest-orange.png
7
   :target: https://www.idiap.ch/software/bob/docs/latest/bob/gridtk/master/index.html
8
9
.. image:: https://gitlab.idiap.ch/bob/gridtk/badges/master/build.svg
   :target: https://gitlab.idiap.ch/bob/gridtk/commits/master
André Anjos's avatar
André Anjos committed
10
11
.. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg
   :target: https://gitlab.idiap.ch/bob/gridtk
Amir Mohammadi's avatar
Amir Mohammadi committed
12
13
14
15
16
.. image:: http://img.shields.io/pypi/v/gridtk.png
   :target: https://pypi.python.org/pypi/gridtk
.. image:: http://img.shields.io/pypi/dm/gridtk.png
   :target: https://pypi.python.org/pypi/gridtk

André Anjos's avatar
André Anjos committed
17

18
19
20
======================
 Parallel Job Manager
======================
André Anjos's avatar
André Anjos committed
21

André Anjos's avatar
André Anjos committed
22
23
24
25
26
27
This package is part of the signal-processing and machine learning toolbox
Bob_. It provides a set of python wrappers around SGE utilities like ``qsub``,
``qstat`` and ``qdel``. It interacts with these tools to submit and manage
grid jobs making up a complete workflow ecosystem. Currently, it is set up to
work with the SGE grid at Idiap, but it is also possible to modify it to be
used in other SGE grids.
28

André Anjos's avatar
André Anjos committed
29
30
31
Since version 1.0.x there is also a local submission system introduced. Instead
of sending jobs to the SGE grid, it executes them in parallel processes on the
local machine, using a simple scheduling system.
André Anjos's avatar
André Anjos committed
32

33

André Anjos's avatar
André Anjos committed
34
35
Installation
------------
36

André Anjos's avatar
André Anjos committed
37
38
Follow our `installation`_ instructions. Then, using the Python interpreter
provided by the distribution, bootstrap and buildout this package::
39

40
  $ python bootstrap-buildout.py
André Anjos's avatar
André Anjos committed
41
  $ ./bin/buildout
42
43


André Anjos's avatar
André Anjos committed
44
45
Contact
-------
46

André Anjos's avatar
André Anjos committed
47
48
For questions or reporting issues to this software package, contact our
development `mailing list`_.
49
50


André Anjos's avatar
André Anjos committed
51
52
53
54
.. Place your references here:
.. _bob: https://www.idiap.ch/software/bob
.. _installation: https://gitlab.idiap.ch/bob/bob/wikis/Installation
.. _mailing list: https://groups.google.com/forum/?fromgroups#!forum/bob-devel