|
1 | 1 | DRMAA Python |
2 | 2 | ------------ |
3 | 3 |
|
4 | | -.. image:: https://travis-ci.org/drmaa-python/drmaa-python.png |
5 | | - :target: https://travis-ci.org/drmaa-python/drmaa-python |
6 | | - :alt: Travis build status |
| 4 | +.. image:: https://img.shields.io/travis/pygridtools/drmaa-python/stable.svg |
| 5 | + :alt: Build status |
| 6 | + :target: https://travis-ci.org/pygridtools/drmaa-python |
7 | 7 |
|
8 | | -.. image:: https://coveralls.io/repos/drmaa-python/drmaa-python/badge.png |
9 | | - :target: https://coveralls.io/r/drmaa-python/drmaa-python |
10 | | - :alt: Test coverage |
| 8 | +.. image:: https://img.shields.io/coveralls/pygridtools/drmaa-python/stable.svg |
| 9 | + :target: https://coveralls.io/r/pygridtools/drmaa-python |
11 | 10 |
|
12 | | -.. image:: https://pypip.in/d/drmaa/badge.png |
13 | | - :target: https://crate.io/packages/drmaa |
| 11 | +.. image:: https://img.shields.io/pypi/dm/drmaa.svg |
| 12 | + :target: https://warehouse.python.org/project/drmaa/ |
14 | 13 | :alt: PyPI downloads |
15 | 14 |
|
16 | | -.. image:: https://pypip.in/v/drmaa/badge.png |
17 | | - :target: https://crate.io/packages/drmaa |
| 15 | +.. image:: https://img.shields.io/pypi/v/drmaa.svg |
| 16 | + :target: https://warehouse.python.org/project/drmaa/ |
18 | 17 | :alt: Latest version on PyPI |
19 | 18 |
|
20 | | -.. image:: https://d2weczhvl823v0.cloudfront.net/drmaa-python/drmaa-python/trend.png |
21 | | - :alt: Bitdeli badge |
22 | | - :target: https://bitdeli.com/free |
| 19 | +.. image:: https://img.shields.io/pypi/l/drmaa.svg |
| 20 | + :alt: License |
23 | 21 |
|
24 | 22 | `Distributed Resource Management Application API <http://en.wikipedia.org/wiki/DRMAA>`__ |
25 | 23 | (DRMAA) bindings for Python. For more information |
26 | | -`read the docs <http://drmaa-python.readthedocs.org>`__. |
| 24 | +`read the docs <http://drmaa-python.readthedocs.org>`__. |
| 25 | + |
| 26 | +If you simply want to run Python functions on a DRMAA-compatible grid, use |
| 27 | +`GridMap <https://github.com/pygridtools/gridmap>`__. |
27 | 28 |
|
28 | 29 | Requirements |
29 | 30 | ~~~~~~~~~~~~ |
30 | 31 |
|
31 | 32 | - Python 2.6+ |
32 | 33 | - A DRMAA-compatible cluster (e.g., Grid Engine) |
33 | 34 |
|
34 | | -License |
35 | | -~~~~~~~ |
| 35 | +Installation |
| 36 | +~~~~~~~~~~~~ |
36 | 37 |
|
37 | | -- BSD (3 Clause) |
| 38 | +To use the DRMAA Python library, you need to install it via ``pip``: |
38 | 39 |
|
39 | | -Changelog |
40 | | -~~~~~~~~~ |
41 | 40 |
|
42 | | -- v0.7.6 |
| 41 | +.. code-block:: bash |
43 | 42 |
|
44 | | - - Fix a typo in ``DictAttribute`` that was causing a crash. |
| 43 | + pip install drmaa |
45 | 44 |
|
46 | | -- v0.7.5 |
47 | 45 |
|
48 | | - - Fix an issue where dictionary attributes (like ``jtEnvironment``) could |
49 | | - encounter ``UnicodeDecodeError``s upon assignment. |
| 46 | +and then setup any environment variables that are necessary for your particular DRM system. |
| 47 | +For SGE, this means ``SGE_ROOT`` and ``SGE_CELL``, which should be set as follows: |
50 | 48 |
|
51 | | -- v0.7.4 |
52 | | - |
53 | | - - Switch to using preferred encoding from ``locale`` module for converting |
54 | | - strings to binary. This should prevent some lingering ``UnicodeEncodeError`` |
55 | | - crashes on Python 2.7. |
56 | 49 |
|
57 | | -- v0.7.3 |
| 50 | +.. code-block:: bash |
58 | 51 | |
59 | | - - Fix a couple crashes when certain functions that expect ``str`` were passed |
60 | | - integers. |
| 52 | + export SGE_ROOT=/path/to/gridengine |
| 53 | + export SGE_CELL=default |
61 | 54 |
|
62 | | -- v0.7.2 |
63 | | - |
64 | | - - Fix a couple inconsistencies with ``str`` vs ``bytes`` in Python 3 in |
65 | | - ``drmaa.session``. |
66 | | - |
67 | | -- v0.7.1 |
68 | | - |
69 | | - - Add `Read The Docs documentation <http://drmaa-python.readthedocs.org>`__ |
70 | | - - Add ``const`` module identifiers back into package namespace |
71 | | - - Remove ``b`` prefixes from strings inserted into error messages. |
72 | | - |
73 | | -- v0.7.0 |
74 | | - |
75 | | - - String attribute issues with Python 3 have all been resolved, and now each |
76 | | - function that takes a string can handle unicode strings, and returns |
77 | | - unicode strings. |
78 | | - - All code has been updated to use future imports for ``unicode_literals`` |
79 | | - and ``print_function``, so we're effectively writing Python 3 code now. |
80 | | - - PEP8 compliance changes all over the place, except those that would break |
81 | | - names required by underlying C DRMAA library. |
82 | | - - Now automatically run unit tests of Travis-CI with SGE, and all tests pass |
83 | | - for Python 2.6, 2.7, and 3.3. SGE is installed using scripts I describe |
84 | | - in `this gist <https://gist.github.com/dan-blanchard/6586533>`__. |
85 | | - - Unit tests are now in a top-level directory instead of a sub-directory |
86 | | - under the drmaa package. |
87 | | - - There is now a `session.py` module that contains most of the code that was |
88 | | - in ``__init__.py`` before, and ``__init__`` just imports things and sets |
89 | | - ``__all__`` and ``__version__``, as is typically recommended now. |
90 | | - - Drops support for Python 2.5. |
| 55 | +
|
| 56 | +where ``/path/to/gridengine/`` is replaced with the actual path to your Grid Engine installation, |
| 57 | +and ``default`` is replaced with your installation's actual cell. The path is typically |
| 58 | +``/var/lib/gridengine``. |
| 59 | + |
| 60 | +You will also need access to the ``libdrmaa.so.1.0`` C library, which can often be installed as |
| 61 | +part of the ``libdrmaa-dev`` package on most Unixes. Once you have installed that, you may need to |
| 62 | +tell DRMAA Python where it is installed by setting the ``DRMAA_LIBRARY_PATH`` environment variable, |
| 63 | +if it is not installed in a location that Python usually looks for libraries. |
| 64 | + |
| 65 | + |
| 66 | +.. code-block:: bash |
| 67 | +
|
| 68 | + export DRMAA_LIBRARY_PATH=/usr/lib/libdrmaa.so.1.0 |
| 69 | +
|
| 70 | +Acknowledgments |
| 71 | +~~~~~~~~~~~~~~~ |
| 72 | + |
| 73 | +Thank you to `StatPro <http://www.statpro.com/>`__ and |
| 74 | +`Educational Testing Service <https://github.com/EducationalTestingService>`__ for |
| 75 | +funding the development of DRMAA Python. |
| 76 | + |
| 77 | +Changelog |
| 78 | +~~~~~~~~~ |
| 79 | + |
| 80 | +`See GitHub releases <https://github.com/drmaa-python/drmaa-python/releases>`__. |
0 commit comments