Skip to main content

bactopia-download

Builds Bactopia environments for use with Nextflow.

Usage

bactopia-download UNKNOWN [OPTIONS]

Arguments

ArgumentTypeRequiredDescription
UNKNOWNUNPROCESSEDNo

Required Options

OptionTypeDefaultDescription
--bactopia-pathSTRINGDirectory where Bactopia repository is stored
OptionTypeDefaultDescription
--envtypeCHOICE (conda, docker, singularity, all)condaThe type of environment to build
--wfSTRINGbactopiaBuild a environment for a the given workflow
--build-allBOOLfalseBuilds all environments for Bactopia workflows
--condadirSTRING/home/rpetit3/.bactopia/condaDirectory to create Conda environments (NXF_CONDA_CACHEDIR env variable takes precedence)
--use-condaBOOLfalseUse Conda for building Conda environments instead of Mamba
--registrySTRINGquay.ioRegistry to pull Docker containers from
--singularity_cacheSTRING/home/rpetit3/.bactopia/singularityDirectory to download Singularity images (NXF_SINGULARITY_CACHEDIR env variable takes precedence)
--singularity_pull_docker_containerBOOLfalseForce conversion of Docker containers, instead downloading Singularity images directly
--force_rebuildBOOLfalseForce overwrite of existing pre-built environments
--max_retryINT3Maximum times to attempt creating Conda environment. (Default: 3)

Additional Options

OptionTypeDefaultDescription
--dry-runBOOLfalseShow environments that would be built, without building them
--verboseBOOLfalsePrint debug related text
--silentBOOLfalseOnly critical errors will be printed
--version, -VBOOLfalseShow the version and exit.