Skip to content

Commit

Permalink
Merge pull request #7 from alihamraoui/gh-page
Browse files Browse the repository at this point in the history
ADD: add AsaruSim logo to README.md
  • Loading branch information
alihamraoui authored Jul 15, 2024
2 parents c51760b + 233cbaf commit 8bfb9e2
Show file tree
Hide file tree
Showing 2 changed files with 70 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,12 @@
# Asaru Sim Documentation

`AsaruSim` is an automated Nextflow workflow designed for simulating 10x single-cell Nanopore reads. It allows to benchmark and optimize single-cell Nanopore long read data processing pipelines.
Full [documentation](https://alihamraoui.github.io/AsaruSim/) is avialable [here](https://alihamraoui.github.io/AsaruSim/).

![Workflow Schema](images/workflow.png)

<a href="images/asarusim_v2.svg"><img src="images/asarusim_v2.svg" align="middle" height="100" width="290" >
## Prerequisites


Before starting, ensure the following tools are installed and properly set up on your system:

- **Nextflow**: A workflow engine for complex data pipelines. [Installation guide for Nextflow](https://www.nextflow.io/docs/latest/getstarted.html).
Expand Down Expand Up @@ -166,6 +167,10 @@ To clean up temporary files generated by Nextflow:
```bash
nextflow clean -f
```

## Workflow
![Workflow Schema](images/workflow.png)

## Acknowledgements

- We would like to express our gratitude to [Youyupei](https://github.com/youyupei) for the development of [SLSim](https://github.com/youyupei/SLSim), which has been helpful to the `AsaruSim` workflow.
Expand Down
Loading

0 comments on commit 8bfb9e2

Please sign in to comment.