Skip to content

Commit 41f5d69

Browse files
committed
Document core bioinformatics tool dependencies in README
1 parent b8dda68 commit 41f5d69

1 file changed

Lines changed: 24 additions & 11 deletions

File tree

README.md

Lines changed: 24 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -72,24 +72,37 @@ Validation & Sensitivity Analyses
7272
```
7373

7474
---
75-
7675
## Requirements
7776

78-
### Software
77+
I-SAGE is designed to run on HPC systems and relies on a combination of workflow, bioinformatics, and Python-based tools.
7978

80-
- Nextflow ≥ 22
81-
- Java ≥ 11
82-
- Python ≥ 3.9
79+
### Workflow & Runtime
80+
- **Nextflow** ≥ 22
81+
- **Java** ≥ 11
82+
- **Bash / core UNIX utilities**
8383

84-
### Python Packages
84+
### Bioinformatics Tools
85+
The following tools must be available in the execution environment (typically via modules or Conda):
8586

86-
- numpy
87-
- pandas
88-
- scipy
89-
- matplotlib
87+
- **samtools** — BAM processing, sorting, indexing
88+
- **pysam** — Python bindings for BAM/CRAM access
89+
- **bwa** (or equivalent aligner) — read alignment
90+
- **bedGraph / UCSC utilities** — bedGraph and bigWig handling
9091

91-
**Note:** Packages are typically managed via environment/profile on HPC systems.
92+
Exact tool versions are managed via the active Nextflow profile (e.g. `eden_local`) and HPC environment.
9293

94+
### Python
95+
- **Python** ≥ 3.9
96+
97+
### Python Packages
98+
- `numpy`
99+
- `pandas`
100+
- `scipy`
101+
- `matplotlib`
102+
103+
> **Note:**
104+
> I-SAGE assumes these tools are provided by the execution environment (HPC modules, Conda, or container).
105+
> The pipeline does not install system-level dependencies automatically.
93106
---
94107

95108
## Quick Start

0 commit comments

Comments
 (0)