README.rst 1.7 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:: https://img.shields.io/badge/docs-available-orange.svg
André Anjos's avatar
André Anjos committed
5
   :target: https://www.idiap.ch/software/bob/docs/bob/gridtk/master/index.html
6
.. image:: https://gitlab.idiap.ch/bob/gridtk/badges/master/pipeline.svg
7 8 9
   :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
10 11
.. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg
   :target: https://gitlab.idiap.ch/bob/gridtk
12

André Anjos's avatar
André Anjos committed
13

14 15 16
======================
 Parallel Job Manager
======================
André Anjos's avatar
André Anjos committed
17

André Anjos's avatar
André Anjos committed
18 19
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
20 21 22 23
``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.
24

André Anjos's avatar
André Anjos committed
25 26 27
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
28

29

André Anjos's avatar
André Anjos committed
30 31
Installation
------------
32

André Anjos's avatar
André Anjos committed
33
Complete Bob's `installation`_ instructions. Then, to install this package,
34
run::
35

André Anjos's avatar
André Anjos committed
36
  $ conda install gridtk
37 38


André Anjos's avatar
André Anjos committed
39 40
Contact
-------
41

André Anjos's avatar
André Anjos committed
42 43
For questions or reporting issues to this software package, contact our
development `mailing list`_.
44 45


André Anjos's avatar
André Anjos committed
46 47
.. Place your references here:
.. _bob: https://www.idiap.ch/software/bob
48
.. _installation: https://www.idiap.ch/software/bob/install
49
.. _mailing list: https://www.idiap.ch/software/bob/discuss