From 6e1e20f0d039c4837d40de12063fc447714fdbb9 Mon Sep 17 00:00:00 2001 From: Steve Schmerler Date: Wed, 31 Jul 2024 00:16:11 +0200 Subject: [PATCH] DOC: reference psweep in batch docs --- doc/source/written/background/param_study.rst | 4 ++++ src/pwtools/batch.py | 2 ++ 2 files changed, 6 insertions(+) diff --git a/doc/source/written/background/param_study.rst b/doc/source/written/background/param_study.rst index 457534ec..2e673d37 100644 --- 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 index d5c37f7c..627a3152 100644 --- 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