README.rst 2 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
.. image:: http://img.shields.io/badge/docs-stable-yellow.svg
5
   :target: http://pythonhosted.org/gridtk/index.html
6
.. image:: http://img.shields.io/badge/docs-latest-orange.svg
7
   :target: https://www.idiap.ch/software/bob/docs/latest/bob/gridtk/master/index.html
8 9 10 11
.. image:: https://gitlab.idiap.ch/bob/gridtk/badges/master/build.svg
   :target: https://gitlab.idiap.ch/bob/gridtk/commits/master
.. image:: https://gitlab.idiap.ch/bob/gridtk/badges/master/coverage.svg
   :target: https://gitlab.idiap.ch/bob/gridtk/commits/master
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
   :target: https://pypi.python.org/pypi/gridtk
16
.. image:: http://img.shields.io/pypi/dm/gridtk.svg
17 18
   :target: https://pypi.python.org/pypi/gridtk

André Anjos's avatar
André Anjos committed
19

20 21 22
======================
 Parallel Job Manager
======================
André Anjos's avatar
André Anjos committed
23

André Anjos's avatar
André Anjos committed
24 25
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
26 27 28 29
``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.
30

André Anjos's avatar
André Anjos committed
31 32 33
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
34

35

André Anjos's avatar
André Anjos committed
36 37
Installation
------------
38

39 40
Complete Bob's `installation`_ instructions. Then, to install this pacakge,
run::
41

André Anjos's avatar
André Anjos committed
42
  $ conda install gridtk
43 44


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

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


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