The more common ways of installing Parabricks are described above. The following additional options are also supported.
- --release
The parabricks release version to install. Contact parabricks-support@nvidia.com if you do not want the default version and need more information.
- --install-location
The location where the
parabricks
folder will be created. Theparabricks
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
)- --container-path
A specific path for the container, relative to the registry (default: None)
- --registry
Registry to pull from (default: None)
- --username
Username to login to the registry (default: None)
- --uninstall
Uninstall parabricks. Removes all the images and scripts from
--install-location
.- --symlink
Create a symlink at
/usr/bin/pbrun
. You can choose to do this during installation.- --force
Disable interactive installation. (default:
False
)- --ngc
Pull image from NGC. DEPRECATED: use
--registry
instead. (default:False
)- --cpu-only
Install on a CPU server. No GPU accelerated tools will run with this option.
- --flexera-server
The Flexera server name (default: None)
- --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
)- --enable-fakeroot
Install using
--fakeroot
capabilities in Singularity 3.3 or higher. You will needsudo
to build for Singularity versions below 3.3. (default:False
)- --skip-image-check
Use the locally present Docker image. (default:
False
)
Package contents:
installer.py
: The installer to download and install the softwarelicense.bin
: The license file based on your license with NVIDIA ParabricksEULA.txt
: The End User License Agreement