Skip to content

minor doc fixes #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jhamman merged 1 commit into from
May 16, 2018
Merged

minor doc fixes #58

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/examples.rst
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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