diff --git a/docs/source/history.rst b/docs/source/history.rst index 1838286..9b501be 100644 --- a/docs/source/history.rst +++ b/docs/source/history.rst @@ -1,7 +1,7 @@ History ======= -This package came out of the Dask_Distributed_ project with help from the +This package came out of the `Dask Distributed`_ project with help from the Pangeo_ collaboration. The original code was contained in the ``distributed.cli.dask_mpi`` module and the original tests were contained in the ``distributed.cli.tests.test_dask_mpi`` module. The impetus for pulling Dask-MPI out of Dask-Distributed was provided by feedback @@ -9,5 +9,5 @@ on the Dask Distributted `Issue 2402 `_ to deploy Dask +directly on a job queuing system like SLURM, SGE, PBS, LSF, Torque, or others. +This can be especially nice when you want to dynamically scale your cluster +during your computation, or for interactive use. - mpirun -np 4 python my_client_script.py .. toctree:: :maxdepth: 1 + :hidden: :caption: Getting Started install - interactive batch + interactive .. toctree:: :maxdepth: 1 + :hidden: :caption: Detailed use cli @@ -68,6 +86,7 @@ which makes your Python script launchable directly with ``mpirun`` or ``mpiexec` .. toctree:: :maxdepth: 1 + :hidden: :caption: Help & Reference howitworks diff --git a/docs/source/install.rst b/docs/source/install.rst index 97926ad..aa6dd31 100644 --- a/docs/source/install.rst +++ b/docs/source/install.rst @@ -29,11 +29,7 @@ To install Dask-MPI from source, clone the repository from `github git clone https://github.com/dask/dask-mpi.git cd dask-mpi - python setup.py install - -or use ``pip`` locally if you want to install all dependencies as well:: - - pip install -e . + pip install . You can also install directly from git master branch::