Giters

Arcadia-Science / noveltree

NovelTree is a highly parallelized and computationally efficient phylogenomic workflow that infers gene families, gene family trees, species trees, and gene family evolutionary history.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Add example of memory/cpu specification to quickstart of readme

austinhpatton opened this issue · comments

commented

Description of feature

Given that nextflow can't seem to automatically detect and scale available resources (annoying), it would be good if we included an example in the readme of how to specify available computational resources in the quickstart section of the readme.

In particular, it might be useful to simple add two lines before the commandline run example:

  1. a bash command to save as variable the number of cpus available for --max_cpus
  2. a bash command to save as variable the available memory for --max_memory in the format of 31GB

Then in the example command to run the workflow, we just use those variables to specify available resources. Would need to specify that these specs are mostly necessary when running locally/on a single instance.