You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -41,32 +44,43 @@ Here are a few Snakemake rule graphs rendered by snakevision. These DAGs come fr
41
44
42
45
**Requires:**`snakemake``python>=3.7`
43
46
44
-
At the current moment, the tool is designed to visualize rule graphs of existing snakemake pipelines. As so, [Snakemake<sup>1</sup>](https://snakemake.readthedocs.io/en/stable/) and any dependencies of the pipeline should be installed on the target system. This tool relies on a few 3rd-party pypi python packages which can be installed via pip from the provided [requirements.txt](https://github.com/OpenOmics/snakevision/blob/main/requirements.txt).
47
+
At the current moment, the tool is designed to visualize rule graphs of existing snakemake pipelines. As so, [Snakemake<sup>1</sup>](https://snakemake.readthedocs.io/en/stable/) and any dependencies of the pipeline should be installed on the target system. This tool relies on a few 3rd-party pypi python packages which can be installed via pip.
45
48
46
49
Please follow the instructions directly below to install snakevision on your local system.
47
50
48
51
## Installation
49
52
53
+
### PyPi
54
+
55
+
Snakevision is available on PyPi and can be installed using pip:
56
+
57
+
```bash
58
+
# Install directly from PyPi
59
+
# Create a python virtual environment
60
+
python3 -m venv .env
61
+
# Activate the virtual environment
62
+
source .env/bin/activate
63
+
# Install required snakevision and its
64
+
# required python packages
65
+
pip install -U pip
66
+
pip install snakevision
67
+
```
68
+
50
69
### Github
51
70
52
-
Please clone this repository to your local filesystem using the following command:
71
+
Snakevision is available on Github and can be installed using pip:
@@ -77,6 +91,8 @@ Snakevision can read an input snakemake rulegraph via an input file or via stand
77
91
78
92
### Basic example
79
93
94
+
Here’s a basic example showing how to generate a rule graph for a Snakemake workflow and visualize it with snakevision. For details on creating rule graphs, see the [Snakemake documentation](https://snakemake.readthedocs.io).
In the `examples/` folder, there are a few example `.dot` input files that you can use to get started. These input files are generated from a slimmed-down version of the pipelines available from OpenOmics, and they are included in this repository for demonstration and testing purposes.
132
+
133
+
```bash
134
+
snakevision \
135
+
-y node_radius=10 \
136
+
-s all rnaseq_multiqc \
137
+
-o rnaseq_rulegraph.svg \
138
+
examples/rna-seek_rulegraph.dot
139
+
```
140
+
113
141
For the full list of available options, run `snakevision -h`.
114
142
115
143
## Contribute
@@ -124,7 +152,17 @@ If you use this software, please cite it as below:
0 commit comments