Additional Installation Options

The common way of installing parabricks package is described using one of the methods above. However, you can modify the following options when using the installer.py script

--install-location

The location where the parabricks folder will be created. The the parabricks folder contains everything needed to run the software. The user must have permission to write to this location. (default: /opt/)

--container

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

--release

The parabricks release version 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. This will make installation slower. (default: False)

--ampere

Install the 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 installation.

--uninstall

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

--force

Disable interactive installation. (default: False)

--container-path

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

--registry

The registry to pull from (default: None)

--username

Username to login to the registry (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

The Flexera server name (default: None)

--skip-image-check

Use the locally present Docker image. (default: False)

Package contents:

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

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

  • EULA.txt: The End User License Agreement

© Copyright 2022, Nvidia. Last updated on Jun 28, 2023.