README.rst 1.92 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
3

4 5
.. image:: http://img.shields.io/badge/docs-v1.6.2-yellow.svg
   :target: https://www.idiap.ch/software/bob/docs/bob/gridtk/v1.6.2/index.html
6
.. image:: http://img.shields.io/badge/docs-latest-orange.svg
André Anjos's avatar
André Anjos committed
7
   :target: https://www.idiap.ch/software/bob/docs/bob/gridtk/master/index.html
8 9 10 11
.. image:: https://gitlab.idiap.ch/bob/gridtk/badges/v1.6.2/build.svg
   :target: https://gitlab.idiap.ch/bob/gridtk/commits/v1.6.2
.. image:: https://gitlab.idiap.ch/bob/gridtk/badges/v1.6.2/coverage.svg
   :target: https://gitlab.idiap.ch/bob/gridtk/commits/v1.6.2
André Anjos's avatar
André Anjos committed
12 13
.. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg
   :target: https://gitlab.idiap.ch/bob/gridtk
14
.. image:: http://img.shields.io/pypi/v/gridtk.svg
15 16
   :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
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``,
André Anjos's avatar
André Anjos committed
24 25 26 27
``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
Complete Bob's `installation`_ instructions. Then, to install this package,
38
run::
39

André Anjos's avatar
André Anjos committed
40
  $ conda install gridtk
41 42


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

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


André Anjos's avatar
André Anjos committed
50 51
.. Place your references here:
.. _bob: https://www.idiap.ch/software/bob
52
.. _installation: https://www.idiap.ch/software/bob/install
53
.. _mailing list: https://www.idiap.ch/software/bob/discuss