Skip to content

Commit

Permalink
Merge pull request #91 from apeltzer/master
Browse files Browse the repository at this point in the history
Mini fixes, now all URls should be fine again 👍
  • Loading branch information
ewels authored Apr 5, 2019
2 parents 564fe40 + 21c5400 commit b351951
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 3 deletions.
38 changes: 36 additions & 2 deletions markdown/usage/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Installation
subtitle: Installing the building blocks needed for running nf-core pipelines.
---

This documentation assumes that you have already read the [introduction](introduction.md) and are familiar with the tools described below.
This documentation assumes that you have already read the [introduction](usage/introduction) and are familiar with the tools described below.

# Table of contents
<!-- Install Atom plugin markdown-toc-auto for this ToC -->
Expand Down Expand Up @@ -67,7 +67,41 @@ If you would like to make changes to the pipeline, it's best to make a fork on G


## Pipeline configuration
By default, the pipeline loads a basic server configuration [`conf/base.config`](../conf/base.config)
By default, the pipeline loads a basic resource configuration:
```bash
process {

cpus = { check_max( 2, 'cpus' ) }
memory = { check_max( 8.GB * task.attempt, 'memory' ) }
time = { check_max( 2.h * task.attempt, 'time' ) }

errorStrategy = { task.exitStatus in [143,137,104,134,139] ? 'retry' : 'terminate' }
maxRetries = 1
maxErrors = '-1'

// Process-specific resource requirements
withName: fastqc {
time = { check_max( 8.h * task.attempt, 'time' ) }
}
withName:toolX {
cpus = { check_max( 8, 'cpus' ) }
memory = { check_max( 8.GB * task.attempt, 'memory' ) }
}
withName: toolY {
cpus = { check_max( 10, 'cpus' ) }
memory = { check_max( 200.GB * task.attempt, 'memory' ) }
time = { check_max( 5.h * task.attempt, 'time' ) }
}
}

params {
// Defaults only, expecting to be overwritten
max_memory = 128.GB
max_cpus = 16
max_time = 240.h
igenomes_base = 's3://ngi-igenomes/igenomes/'
}
```
This uses a number of sensible defaults for process requirements and is suitable for running
on a simple (if powerful!) local server.
Expand Down
2 changes: 1 addition & 1 deletion public_html/usage/introduction.php
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
$title = 'Introduction';
$subtitle = 'Get to grip with the key concepts used in nf-core pipeliens.';
$subtitle = 'Get to grip with the key concepts used in nf-core pipelines.';
$markdown_fn = '../../markdown/usage/introduction.md';
include('../../includes/header.php');
include('../../includes/footer.php');
Expand Down

0 comments on commit b351951

Please sign in to comment.