DOC: reference psweep in batch docs

elcorto · Jul 30, 2024 · 6e1e20f · 6e1e20f
1 parent ed39016
commit 6e1e20f
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/doc/source/written/background/param_study.rst b/doc/source/written/background/param_study.rst
@@ -3,6 +3,10 @@
 Parameter studies
 =================
 
+.. note::
+   For a modern version of the tools in :mod:`~pwtools.batch` with more
+   features, see https://github.com/elcorto/psweep.
+
 :mod:`~pwtools.batch` has tools for setting up parameter studies: automatic
 input generation, database tools (see also :mod:`~pwtools.sql`), ...
 

diff --git a/src/pwtools/batch.py b/src/pwtools/batch.py
@@ -1,3 +1,5 @@
+"""Tools for parameter studies. See :ref:`param_study`."""
+
 import os
 import copy
 import shutil