Skip to content

Commit

Permalink
docs: clarify minimum Snakemake version for profiles
Browse files Browse the repository at this point in the history
  • Loading branch information
johanneskoester committed Jul 6, 2023
1 parent bad9115 commit 86dc277
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/executing/cli.rst
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 86dc277

Please sign in to comment.