From ef91030b019ed37752fb0bbab37c92815a014d8c Mon Sep 17 00:00:00 2001 From: Per Unneberg Date: Thu, 25 Apr 2024 15:15:17 +0200 Subject: [PATCH] Update README.md --- README.md | 35 ++++++++++++++++++----------------- 1 file changed, 18 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 439ce20..037d925 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,24 @@ ![Test SnakemakeProfiles/slurm](https://github.com/Snakemake-Profiles/slurm/workflows/Test%20SnakemakeProfiles/slurm/badge.svg) +> [!IMPORTANT] +> +> ## Snakemake version 8 currently unsupported +> +> Snakemake version 8 introduces breaking changes with respect to the Snakemake cookiecutter profile. One new +> feature is that execution of jobs on a cluster or the cloud are handled by +> [executor plugins](https://snakemake.readthedocs.io/en/stable/tutorial/additional_features.html#cluster-or-cloud-execution). +> For instance, there is a +> [dedicated executor plugin for SLURM](https://snakemake.github.io/snakemake-plugin-catalog/plugins/executor/slurm.html) that +> provides much of the functionality that was previously catered for by this snakemake profile. Profiles are still needed, but their +> role changes somewhat to that of fine-tuning executor plugins for particular sites, only requiring the yaml configuration +> file. +> +> With this in mind, support for Snakemake version 8 has currently been put on hold and I recommend that users consult +> the executor plugin documentation for slurm. +> + + # Contents - [Introduction](#introduction) @@ -28,23 +46,6 @@ SnakemakeProfiles/slurm](https://github.com/Snakemake-Profiles/slurm/workflows/T - [Anatomy of the tests (WIP)](#anatomy-of-the-tests-wip) - [Adding new tests (WIP)](#adding-new-tests-wip) -> [!IMPORTANT] -> -> ## Snakemake version 8 unsupported -> -> Snakemake version 8 introduces breaking changes with respect to the Snakemake cookiecutter profile. One new -> feature is that execution of jobs on a cluster or the cloud are handled by -> [executor plugins](https://snakemake.readthedocs.io/en/stable/tutorial/additional_features.html#cluster-or-cloud-execution). -> For instance, there is a -> [dedicated executor plugin for SLURM](https://snakemake.github.io/snakemake-plugin-catalog/plugins/executor/slurm.html) that -> provides much of the functionality that was previously catered for by this snakemake profile. Profiles are still needed, but their -> role changes somewhat to that of fine-tuning executor plugins for particular sites, only requiring the yaml configuration -> file. -> -> With this in mind, support for Snakemake version 8 has currently been put on hold and I recommend that users consult -> the executor plugin documentation for slurm. -> - ## Introduction This cookiecutter provides a template Snakemake profile for configuring