From b6377b810174639d8469b230c4644a9dfbd64f29 Mon Sep 17 00:00:00 2001 From: "Andrew S. Rosen" Date: Tue, 2 May 2023 18:31:42 -0700 Subject: [PATCH] Update SLURM plugin docs (#1616) * Update SLURM rst * Update changelog * Fix section markings in SLURM docs --- CHANGELOG.md | 1 + doc/source/api/executors/slurm.rst | 9 +++++++++ 2 files changed, 10 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index cefdef958..d9f52ce22 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Docs - Redispatch feature page in Read the Docs. +- Clarify installation instructions for SLURM plugin in Read the Docs. ### Fixed diff --git a/doc/source/api/executors/slurm.rst b/doc/source/api/executors/slurm.rst index c78401789..f581e8d85 100644 --- a/doc/source/api/executors/slurm.rst +++ b/doc/source/api/executors/slurm.rst @@ -5,12 +5,21 @@ Slurm Executor This executor plugin interfaces Covalent with HPC systems managed by `Slurm `_. For workflows to be deployable, users must have SSH access to the Slurm login node, writable storage space on the remote filesystem, and permissions to submit jobs to Slurm. +============ +Installation +============ + To use this plugin with Covalent, simply install it using :code:`pip`: .. code:: bash pip install covalent-slurm-plugin +On the remote system, the Python version in the environment you plan to use must match that used when dispatching the calculations. Additionally, the remote system's Python environment must have the base covalent package installed (e.g. :code:`pip install covalent`). + +===== +Usage +===== The following shows an example of a Covalent `configuration `_ that is modified to support Slurm: