Skip to content

Commit

Permalink
update readme with clarifications for tutorials
Browse files Browse the repository at this point in the history
  • Loading branch information
LaraFuhrmann committed May 7, 2024
1 parent 732bf89 commit cb52480
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,11 @@ Also see [snakemake's documentation](https://snakemake.readthedocs.io/en/stable/
Tutorials introducing usage of V-pipe are available in the [docs/](docs/README.md) subdirectory.
### Tutorials
First steps with V-pipe for different scenarios are available in the [docs/](docs/README.md) subdirectory.
### Using quick install script
To deploy V-pipe, use the [installation script](utils/README.md#quick-installer) with the following parameters:
Expand All @@ -50,6 +55,8 @@ cd work
./vpipe --jobs 4 --printshellcmds --dry-run
```

Test data is available with the tutorials provided in the [docs/](docs/README.md) subdirectory.

### Using Docker

Note: the [docker image](https://github.com/cbg-ethz/V-pipe/pkgs/container/v-pipe) is only setup with components to run the workflow for HIV and SARS-CoV-2 virus base configurations.
Expand Down

0 comments on commit cb52480

Please sign in to comment.