Skip to content

Commit f0c7693

Browse files
committed
docs: updating getting started info, badges, and adding zenodo citation.
1 parent ca521db commit f0c7693

1 file changed

Lines changed: 51 additions & 13 deletions

File tree

README.md

Lines changed: 51 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44

55
**_An awesome tool to visualize Snakemake DAGs_**
66

7+
[![DOI](https://zenodo.org/badge/719368540.svg)](https://doi.org/10.5281/zenodo.18988674)
8+
[![GitHub release (latest SemVer including pre-releases)](https://img.shields.io/github/v/release/OpenOmics/snakevision?color=blue&include_prereleases)](https://github.com/OpenOmics/snakevision/releases)<br>
9+
[![tests](https://github.com/OpenOmics/snakevision/workflows/tests/badge.svg)](https://github.com/OpenOmics/snakevision/actions/workflows/testing.yaml)
710
[![GitHub issues](https://img.shields.io/github/issues/OpenOmics/snakevision?color=brightgreen)](https://github.com/OpenOmics/snakevision/issues)
811
[![GitHub license](https://img.shields.io/github/license/OpenOmics/snakevision)](https://github.com/OpenOmics/snakevision/blob/main/LICENSE)
912

@@ -41,32 +44,43 @@ Here are a few Snakemake rule graphs rendered by snakevision. These DAGs come fr
4144

4245
**Requires:** `snakemake` `python>=3.7`
4346

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.
4548

4649
Please follow the instructions directly below to install snakevision on your local system.
4750

4851
## Installation
4952

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+
5069
### Github
5170

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:
5372

5473
```bash
5574
# Clone Repository from Github
5675
git clone https://github.com/OpenOmics/snakevision.git
57-
5876
# Change your working directory
5977
cd snakevision/
60-
6178
# Create a python virtual environment
62-
# to install required python packages
63-
python -m venv .venv
64-
79+
python3 -m venv .env
6580
# Activate the virtual environment
66-
source .venv/bin/activate
67-
68-
# Upgrade pip and install the list
69-
# of required python packages
81+
source .env/bin/activate
82+
# Install required snakevision and its
83+
# required python packages
7084
pip install -U pip
7185
pip install -e .
7286
```
@@ -77,6 +91,8 @@ Snakevision can read an input snakemake rulegraph via an input file or via stand
7791

7892
### Basic example
7993

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).
95+
8096
```bash
8197
# Create a input file for snakevision
8298
snakemake --configfile=$pipeline_outdir/config.json \
@@ -110,6 +126,18 @@ snakevision \
110126
pipeline_rulegraph.dot
111127
```
112128

129+
### Run with example rulegraphs
130+
131+
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+
113141
For the full list of available options, run `snakevision -h`.
114142

115143
## Contribute
@@ -124,7 +152,17 @@ If you use this software, please cite it as below:
124152
<summary><b><i>@BibText</i></b></summary>
125153

126154
```text
127-
Citation coming soon!
155+
@software{kuhn_2026_18988675,
156+
author = {Kuhn, Skyler and
157+
Jahn, Michael},
158+
title = {OpenOmics/snakevision: v1.0.0},
159+
month = mar,
160+
year = 2026,
161+
publisher = {Zenodo},
162+
version = {v1.0.0},
163+
doi = {10.5281/zenodo.18988674},
164+
url = {https://doi.org/10.5281/zenodo.18988674},
165+
}
128166
```
129167

130168
</details>
@@ -133,7 +171,7 @@ Citation coming soon!
133171
<summary><b><i>@APA</i></b></summary>
134172

135173
```text
136-
Citation coming soon!
174+
Kuhn, S., & Jahn, M. (2026). OpenOmics/snakevision: v1.0.0 (v1.0.0). Zenodo. https://doi.org/10.5281/zenodo.18988674
137175
```
138176

139177
</details>

0 commit comments

Comments
 (0)