From 86dc277d530a557c9bdd6784b863f63ab859a1c7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johannes=20K=C3=B6ster?= Date: Thu, 6 Jul 2023 12:28:42 +0200 Subject: [PATCH] docs: clarify minimum Snakemake version for profiles --- docs/executing/cli.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/executing/cli.rst b/docs/executing/cli.rst index 1e1b52904..9c5f9ae40 100644 --- a/docs/executing/cli.rst +++ b/docs/executing/cli.rst @@ -113,10 +113,10 @@ Profiles Adapting Snakemake to a particular environment can entail many flags and options. Therefore, since Snakemake 4.1, it is possible to specify configuration profiles to be used to obtain default options. -Two kinds of profiles are supported: +Since Snakemake 7.29, two kinds of profiles are supported: * A global profile that is defined in a system-wide or user-specific configuration directory (on Linux, this will be ``$HOME/.config/snakemake`` and ``/etc/xdg/snakemake``, you can find the answer for your system via ``snakemake --help``). -* A workflow specific profile that is defined via a flag (``--workflow-profile``) or searched in a default location (``profile/default``) in the working directory or next to the Snakefile. +* A workflow specific profile (introduced in Snakemake 7.29) that is defined via a flag (``--workflow-profile``) or searched in a default location (``profile/default``) in the working directory or next to the Snakefile. The workflow specific profile is meant to be used to define default options for a particular workflow, like providing constraints for certain custom resources the workflow uses (e.g. ``api_calls``) or overwriting the threads and resource definitions of individual rules without modifying the workflow code itself. In contrast, the global profile is meant to be used to define default options for a particular environment, like the default cluster submission command or the default number of jobs to run in parallel. @@ -174,7 +174,7 @@ For example, when the workflow has its Snakefile at ``workflow/Snakefile``, the Use templating in profiles ~~~~~~~~~~~~~~~~~~~~~~~~~~ -When the profile starts with +In Snakemake 7.30 or newer, when the profile starts with .. code-block:: yaml