Skip to content
This repository has been archived by the owner on Feb 10, 2021. It is now read-only.

Commit

Permalink
Refresh README (#71)
Browse files Browse the repository at this point in the history
* Prefer installing with `pip`

It is preferable to install from `pip` in basically all cases including
when working with local source. So update the recommendation in the
docs.

[ci skip]

* Explain `DRMAA_LIBRARY_PATH` must be set

Point out to users that they must set the environment variable
`DRMAA_LIBRARY_PATH` to point to their copy of `libdrmaa.so`.

[ci skip]

* Add PyPI and conda-forge badges

Provide some basic badges from Shields.io to indicate that dask-drmaa is
available on PyPI and conda-forge with links to the respective sites.

[ci skip]

* Mention PyPI and conda-forge packages

Explain to users that the package can be gotten from PyPI with `pip` or
conda-forge with `conda` along with example install instructions.

[ci skip]

* Fix a small typo

Correct verb conjugation.

[ci skip]
  • Loading branch information
jakirkham authored Apr 4, 2018
1 parent c4346c3 commit 30f6d25
Showing 1 changed file with 20 additions and 4 deletions.
24 changes: 20 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Dask on DRMAA
=============

|Build Status|
|Build Status| |PyPI Release| |conda-forge Release|

Deploy a Dask.distributed_ cluster on top of a cluster running a
DRMAA_-compliant job scheduler.
Expand Down Expand Up @@ -33,18 +33,28 @@ Or launch from the command line::
Install
-------

Currently this is only available through GitHub and source installation::
Python packages are available from PyPI and can be installed with ``pip``::

pip install dask-drmaa

Also ``conda`` packages are available from conda-forge::

conda install -c conda-forge dask-drmaa

Additionally the package can be installed from GitHub with the latest changes::

pip install git+https://github.com/dask/dask-drmaa.git --upgrade

or::

git clone git@github.com:dask/dask-drmaa.git
cd dask-drmaa
python setup.py install
pip install .

You must have the DRMAA system library installed and be able to submit jobs
from your local machine.
from your local machine. Please make sure to set the environment variable
``DRMAA_LIBRARY_PATH`` to point to the location of ``libdrmaa.so`` for your
system.


Testing
Expand Down Expand Up @@ -137,3 +147,9 @@ Related Work

.. |Build Status| image:: https://travis-ci.org/dask/dask-drmaa.svg?branch=master
:target: https://travis-ci.org/dask/dask-drmaa

.. |PyPI Release| image:: https://img.shields.io/pypi/v/dask-drmaa.svg
:target: https://pypi.python.org/pypi/dask-drmaa

.. |conda-forge Release| image:: https://img.shields.io/conda/vn/conda-forge/dask-drmaa.svg
:target: https://github.com/conda-forge/dask-drmaa-feedstock

0 comments on commit 30f6d25

Please # to comment.