Skip to content

Commit b198de3

Browse files
committed
Show how to run commands with pixi in README
Add examples of pixi shell and pixi run usage so users know how to invoke ReLERNN commands after installation.
1 parent aa758b8 commit b198de3

1 file changed

Lines changed: 12 additions & 1 deletion

File tree

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,18 @@ This creates an environment with GPU support by default. For CPU-only use:
2323
$ pixi install -e cpu
2424
```
2525

26-
You can then run commands via `pixi run` or activate the environment with `pixi shell`.
26+
To use ReLERNN, either activate the environment or prefix commands with `pixi run`:
27+
28+
```bash
29+
# Option 1: activate the environment, then run commands directly
30+
$ pixi shell
31+
$ ReLERNN_SIMULATE --vcf input.vcf --genome genome.bed --projectDir ./output/ ...
32+
33+
# Option 2: prefix each command with pixi run
34+
$ pixi run ReLERNN_SIMULATE --vcf input.vcf --genome genome.bed --projectDir ./output/ ...
35+
```
36+
37+
All examples below show bare commands and assume an activated environment.
2738

2839
## Testing ReLERNN
2940
An example VCF file (5 contigs; 10 haploid chromosomes) and a shell script for running ReLERNN's four modules is located in `$/ReLERNN/examples`.

0 commit comments

Comments
 (0)