INSTALLATION OPTIONS

The common way of installing parabricks package is described in GETTING STARTED. However, you can modify the following options.

--install-location

Location in which a folder by the name of parabricks will be created. The parabricks folder will contain everything needed to run the software. The user must have permission to write to this location. (default: /opt/)

--container

{docker,singularity} Type of container technology to use (default: docker)

--release

The parabricks release version you want to install. Contact parabricks-support@nvidia.com, if you do not want the default version and need more information

--extra-tools

Install extra tools like vcfqc, vcfqcbybam, and cnvkit as well. This will make installation slower (default: False)

--ampere

Install ampere based container (default: False)

--cpu-only

Install on a CPU server. No GPU accelerated tools will run with this option

--symlink

Create a symlink at /usr/bin/pbrun. You can choose to do this during the installation

--uninstall

Uninstall parabricks. Removes all the images and scripts from –install-location

--force

Disable interactive installation (default: False)

--container-path

Specific path for the container, relative to registry (default: None)

--registry

Registry to pull from (default: None)

--username

Username to login the registry with (default: None)

--access-token

Access Token/Password for the supplied username

--enable-fakeroot

Install using –fakeroot capabilities in singularity 3.3 or higher. You will need sudo to build for singularity versions below 3.3. (default: False)

--flexera-server

Flexera server name (default: None)

--skip-image-check

Use the locally present docker image (default: False)

Package contents:

  • installer.py: Installer to download and install the software

  • license.bin: License file based on your license with NVIDIA Parabricks

  • EULA.txt: End User License Agreement