@@ -59,6 +59,12 @@ generation.
5959
6060## Requirements
6161The pipeline can use either Conda/Mamba or Singularity to provide the required software.
62+ All software versions are defined in [ the Conda YAML files] ( https://github.com/Mayrlab/scUTRquant/tree/main/envs ) .
63+
64+ ### OS Requirements
65+ The software has been tested on MacOS (11-13) and Linux (Ubuntu 20,22; CentOS 7). Windows
66+ is not directly supported, but WSL2 should work. The [ scUTRquant-demo] ( https://github.com/mfansler/scUTRquant-demo )
67+ repository directly tests running examples on the GitHub-hosted runners.
6268
6369### Conda/Mamba Mode (MacOS or Linux)
6470Snakemake can use Conda to install the needed software. This configuration requires:
@@ -114,6 +120,8 @@ This configuration requires installing:
114120 **Reuse Tip:** Similar to the UTRome files, these can also be centralized
115121 and referenced by the `bx_whitelist` variable in the `configfile`.
116122
123+ For GitHub runners, it takes ~ 3 mins to clone and download the scUTRquant files.
124+
117125# Running Examples
118126Examples are provided in the `scUTRquant/examples` folder. Each includes a script
119127for downloading the raw data, a `sample_sheet.csv` formatted for use in the pipeline,
@@ -183,6 +191,10 @@ Note that the `config.yaml` uses paths relative to the `scUTRquant` folder.
183191 > sce_genes <- readRDS("data/sce/utrome_hg38_v1/pbmc_1k_v3_fastq.genes.Rds")
184192 ```
185193
194+ On GitHub runners with 2-3 cores, these examples have typical execution times of 5-10 mins.
195+ On HPC systems with multiple nodes with multiple cores, a large job (e.g., 1-2TB raw data)
196+ can process in under an hour when properly configured.
197+
186198# File Specifications
187199## Configuration File
188200
0 commit comments