Skip to content

Commit

Permalink
Add installation info
Browse files Browse the repository at this point in the history
  • Loading branch information
xies4 committed Oct 18, 2024
1 parent 893d281 commit 4494171
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,38 @@
# scMaestro

`scMaestro`, developed by CCRSF IFX, is aim to provide an end-to-end solution for single cell sequencing data.

## Quick start

To run `scMastro`, activation of an conda environment `singularity` are required.

* Clone git repo

```
git clone --recurse-submodules https://github.com/CCRSF-IFX/scMaestro.git
cd scMaestro/
```

* Install conda environment:

```
conda env create -n scMastro -f environment.yml
```

You only need to run the command above once.

* Activate conda environment


```
conda activate scMastro
```

* Run `scMastro`

```
./scMastro
```



0 comments on commit 4494171

Please sign in to comment.