Skip to content

Commit

Permalink
Merge pull request #58 from guillaumeeb/doc_correction
Browse files Browse the repository at this point in the history
minor doc fixes
  • Loading branch information
Joe Hamman committed May 16, 2018
2 parents 5931b83 + 97ab68a commit 8c50e3f
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ PBS Deployments
cluster = PBSCluster(queue='regular',
project='DaskOnPBS',
local_directory=os.getenv('TMPDIR', '/tmp'),
local_directory='$TMPDIR',
threads=4,
processes=6,
memory='16GB',
Expand Down
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ PBS, Slurm, and SGE.*
Motivation
----------

1. While ``dask.distributed`` offers a flexible distributed parallel computing
Python, it is not always easy to deploy on systems that use job queuing
1. While ``dask.distributed`` offers a flexible library for distributed computing
in Python, it is not always easy to deploy on systems that use job queuing
systems. Dask-jobqueue provides a Pythonic interface for deploying and
managing Dask clusters.
2. In practice, deploying distributed requires customization, both for the
Expand Down
12 changes: 9 additions & 3 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ Pip can be used to install both dask-jobqueue and its dependencies (e.g. dask,
distributed, NumPy, Pandas, and so on that are necessary for different
workloads).::

pip install "dask_jobqueue" # Install everything
pip install "dask_jobqueue" # Install everything from last released version


Install from Source
-------------------
Expand All @@ -26,11 +27,16 @@ or use ``pip`` locally if you want to install all dependencies as well::

pip install -e .

You can also install directly from git master branch::

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


Test
----

Test dask with ``py.test``::
Test dask-jobqueue with ``py.test``::

cd dask
git clone https://github.com/dask/dask-jobqueue.git
cd dask-jobqueue
py.test dask_jobqueue

0 comments on commit 8c50e3f

Please sign in to comment.