Skip to content

Commit 7de22ee

Browse files
committed
Simplify main README.md
1 parent 3b80bf9 commit 7de22ee

File tree

2 files changed

+17
-11
lines changed

2 files changed

+17
-11
lines changed

README.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ configuring [the inputs and outputs](config/README.md#inputs-and-outputs) and
2424
[the context dataset](config/README.md#automated-construction-of-a-context-dataset):
2525

2626
```shell
27-
snakemake --use-conda --cores 4 # command for Snakemake v7.32
27+
snakemake --use-conda --cores 4 # command for Snakemake v7
2828
```
2929

3030
We provide a simple script that downloads the [data](https://doi.org/10.20350/digitalCSIC/15648) from [our study](https://doi.org/10.1093/ve/veae018)
@@ -39,15 +39,12 @@ The latter requires installing the [Snakemake executor plugin for SLURM](https:/
3939
It supports dependency management through either conda or Singularity, as detailed in the
4040
[run modes documentation](config/README.md#run-modes).
4141

42-
Please refer to the [**full workflow documentation**](config/README.md) for detailed setup instructions.
42+
We use continuous integration (CI) to verify that all dependencies install correctly
43+
with Snakemake v7.32.4 (see GitHub Action `Install`), and to test that VIPERA runs
44+
successfully with Snakemake v7.32.4, v8.30.0, and v9.1.6 (see GitHub Actions
45+
`Test Sm v[7-9]`).
4346

44-
> The documentation in this repository provides instructions for running VIPERA
45-
> with Snakemake <8. We used Snakemake 7.32 for the original publication,
46-
> but using Snakemake 8 or 9 is possible with minimal modifications (see the
47-
> [migration documentation](https://snakemake.readthedocs.io/en/stable/getting_started/migration.html)).
48-
> For example, [profiles](https://snakemake.readthedocs.io/en/stable/getting_started/migration.html#profiles)
49-
should be backwards compatible, but `--use-conda` is deprecated starting on Snakemake 8 and
50-
`--software-deployment-method conda` is the preferred way to provide the options.
47+
Please refer to the [**full workflow documentation**](config/README.md) for detailed instructions.
5148

5249
## Contributors
5350

config/README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,16 @@
11
# Instructions
22

3-
To run the pipeline, you will need an environment with `snakemake`
4-
(check [the Snakemake docs](https://snakemake.readthedocs.io/en/stable/getting_started/installation.html)).
3+
To run VIPERA, an environment with Snakemake version 7.19 or later is needed
4+
(see [the Snakemake docs](https://snakemake.readthedocs.io/en/stable/getting_started/installation.html)
5+
for setup instructions).
6+
7+
> This guide provides command-line instructions for running VIPERA with Snakemake versions prior to 8.
8+
All configuration parameters are fully cross-compatible. The original publication used Snakemake 7.32,
9+
but newer versions can also be used with only minor changes. For details, see the Snakemake
10+
[migration guide](https://snakemake.readthedocs.io/en/stable/getting_started/migration.html).
11+
For example, existing [profiles](https://snakemake.readthedocs.io/en/stable/getting_started/migration.html#profiles)
12+
are cross-compatible as well, but note that the `--use-conda` flag is deprecated starting with Snakemake 8.
13+
Instead, use `--software-deployment-method conda`.
514

615
## Inputs and outputs
716

0 commit comments

Comments
 (0)