Skip to content

Commit 0b8fb01

Browse files
committed
update README
1 parent 907656d commit 0b8fb01

File tree

1 file changed

+21
-8
lines changed

1 file changed

+21
-8
lines changed

README.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -211,11 +211,17 @@ yourself, this can be achieved as described in [](#manual-installation-for-devel
211211

212212
### Slurm (with singularity/conda)
213213
On a HPC system you typically run processes using a scheduler system such as slurm or LSF. We provide
214-
profiles `-profile slurm`, `-profile slurm_singularity` and `-profile slurm_conda` to run FastOMA with
215-
the respective engine using [slurm](https://slurm.schedmd.com/overview.html) as a scheduler system.
216-
If you need a different scheduler, it is quite straight forward to
217-
set it up in `nextflow.config` based on the existing profiles and the documentation of
218-
[nextflow executors](https://www.nextflow.io/docs/latest/executor.html).
214+
a basic profile for slurm `-profile slurm` to run FastOMA with [slurm](https://slurm.schedmd.com/overview.html) as a scheduler system.
215+
Note that multiple profiles can be combined, e.g. `-profile slurm,singularity`, or `-profile slurm,conda`.
216+
217+
For many HPC systems, there exists already a nf-core profile, which can be directly used with FastOMA. Check the
218+
available profiles interactively [here](https://nf-co.re/configs/) or on [github](https://github.com/nf-core/configs/tree/master/conf).
219+
If you found one for your HPC, you can use it directly with `-profile <profile_name>`, e.g. `-profile ethz_euler`
220+
221+
If none of those profiles fit directly your needs, you can create your own profile file somewhere on your system and
222+
specify it with the `-c <path_to_profile_file>` argument. The nf-core profiles should give you a
223+
good overview of what is possible, together with the
224+
[nextflow documentation on executors](https://www.nextflow.io/docs/latest/executor.html).
219225

220226

221227
# How to run FastOMA on the test data
@@ -407,19 +413,21 @@ Let's save the planet together with
407413

408414

409415
### Run on a cluster
410-
For running on a SLURM cluster you can add `-c ../nextflow_slurm.config` to the commond line.
416+
For running on a SLURM cluster, you can add the slurm profile argument: `-profile slurm` to the command line.
411417

412418
```
413419
# cd FastOMA/testdata
414420
# rm -r out_folder work # You may remove stuff from previous run
415421
# ls ../FastOMA.nf
416422
417-
nextflow ../FastOMA.nf -c ../nextflow_slurm.config --input_folder in_folder --output_folder out_folder
423+
nextflow ../FastOMA.nf -profile slurm \
424+
--input_folder in_folder \
425+
--output_folder out_folder
418426
```
419427

420428
You may need to re-run nextflow command line by adding `-resume`, if the allocated time is not enough for your dataset.
421429

422-
You may need to increase the number of opoened files in your system with `ulimit -n 131072` or higher as nextflow generates hundreds of files depending on the size of your input dataset.
430+
You may need to increase the limit of number of opened file handles in your system with `ulimit -n 131072` or higher as nextflow generates hundreds of files depending on the size of your input dataset.
423431

424432

425433
## Handle splice files
@@ -459,6 +467,11 @@ Citation: Majidian, Sina, Yannis Nevers, Ali Yazdizadeh Kharrazi, Alex Warwick
459467

460468

461469
## Change log
470+
- Update v0.5dev (not released yet):
471+
- better configuration setup (close to nf-core)
472+
- improved resource allocation for nextflow
473+
- improved handling of alternative splicing variants in reporting
474+
- adding test profile and nf-test based CI checks
462475
- Update v0.4.0:
463476
- Improvements for nextflow: alternative version selection, README updates
464477
- Split HOG and sampling improvements

0 commit comments

Comments
 (0)