1
0
Fork 0
mirror of https://github.com/MillironX/nf-configs.git synced 2024-11-21 16:16:04 +00:00
nf-configs/docs/google.md
Andrew Frank d70fc2605a
Fix parameters in google.md
Change parameters from hyphens to underscores to accurately reflect google.config
2020-11-12 11:52:58 -05:00

1.4 KiB

nf-core/configs: Google Cloud Life Sciences Configuration

To be used with the google profile by specifying the -profile google when running nf-core pipelines.

Google Cloud

Quick Start

GOOGLE_APPLICATION_CREDENTIALS=<your_key>.json
NXF_MODE=google
nextflow run nf-core/rnaseq -profile test,google --google_bucket <gs://your_bucket/work>

Required Parameters

--google_bucket

The Google Cloud Storage bucket location to be used as a Nextflow work directory. Can also be specified with (-w gs://your_bucket/work).

Optional Parameters

--google_zone

The Google zone where the computation is executed in Compute Engine VMs. Multiple zones can be provided separating them by a comma. Default (europe-west2-c).

--google_preemptible

Enables the usage of preemptible virtual machines with a retry error statergy for up to 5 retries. Default (true).

--google_debug

Copies the /google debug directory from the VM to the task bucket directory. Useful for debugging. Default (false).

Cloud Life Sciences Setup

Please refer to the Google Cloud and Nextflow documentation which describe how to setup the Google Cloud environment.