Update SLURM plugin docs (#1616)

* Update SLURM rst * Update changelog * Fix section markings in SLURM docs
AgnostiqHQ · May 4, 2023 · b6377b8 · b6377b8
1 parent ec4adce
commit b6377b8
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git 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
@@ -5,12 +5,21 @@ Slurm Executor
 
 This executor plugin interfaces Covalent with HPC systems managed by `Slurm <https://slurm.schedmd.com/documentation.html>`_. 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 <https://covalent.readthedocs.io/en/latest/how_to/config/customization.html>`_ that is modified to support Slurm: