Skip to content

Commit 64797b9

Browse files
committed
update readme
1 parent b84bf3f commit 64797b9

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,14 @@ Numba needs NumPy 1.24 or less
4444
```
4545
Detailed package version information is provided in the requirements.txt file.
4646

47+
Installation, verified on Linux and Unix systems, takes less than a minute once all dependencies are resolved.
4748

4849
## Tutorial
4950

5051
Follow [tutorial-1](https://github.com/delipouya/sciRED/blob/main/tutorial1_scMixology.ipynb) and [tutorial-2](https://github.com/delipouya/sciRED/blob/main/tutorial2_stimulatedPBMC.ipynb) to learn how to use sciRED. These tutorials introduce the standard processing pipeline and demonstrate the application of sciRED on the scMixology and stimulated PBMC datasets. Further details about the input datasets are available in the manuscript. The data processing scripts are available in the _data_prep_ folder.
5152

53+
The input data for Tutorial 1 is provided in the "Data" folder. Instructions for downloading and saving data for Tutorial 2 can be found in the `data_stimPBMC.R` script inside the _data_prep_ folder. The demo for Tutorial 1 took less than a minute to run on a workstation with 24 CPUs and 64 GB RAM.
54+
5255

5356
## Citation
5457

0 commit comments

Comments
 (0)