1
0
Fork 0
mirror of https://github.com/MillironX/nf-configs.git synced 2024-11-10 20:13:09 +00:00
nf-configs/docs/azurebatch.md
2021-11-18 18:06:54 -06:00

34 lines
935 B
Markdown

# nf-core/configs: azurebatch Configuration
To be used with the `azurebatch` profile by specifying the `-profile azurebatch` when running nf-core pipelines.
Custom queue and storage need to be supplied with `params.az_location`, `params.batch_name`, `params.batch_key`, `params.storage_name`, `params.sas_token`.
## Required Parameters
### `--az_location`
The Azure Batch region where the computation is executed in VMs. Default (`westus2`).
### `--batch_name`
The Azure Batch account name.
### `--batch_key`
The Azure Batch account key.
### `--storage_name`
The Azure Blob Storage name.
### `--sas_token`
The Azure Blob Storage shared access signature token.
### `-w`
The Azure Blob container to be used as Nextflow work directory (`-w az://work`).
## Azure Batch Setup
Please refer to the [Nextflow](https://www.nextflow.io/docs/edge/azure.html) documentation which describe how to setup the Azure Batch environment.