-
Choosing a Guppy package
Depending on whether you are basecalling on a CPU or a GPU, you will need to choose an appropriate Guppy package. These packages are available as separate installers on the Software Downloads page:
- GPU basecalling is available in the
ont-guppy
package and will require a GPU driver for basecalling to work. It is also possible to perform CPU basecalling using this package. You will need to specify the GPU device(s) you want to use when setting up your experiment, otherwise Guppy will default to CPU calling. - CPU-only basecalling is available in the
ont-guppy-cpu
package.
- GPU basecalling is available in the
-
Supported platforms for Guppy
Debian packages:
- 64-bit Ubuntu 16 amd64 (for either GPU-enabled Guppy or cpu-only Guppy)
- 64-bit Ubuntu 16 arm64v8 (for GPU-enabled Guppy only)
RPM packages:
- Centos 7 (for either GPU-enabled Guppy or CPU-only Guppy)
- Centos 8 (for either GPU-enabled Guppy or CPU-only Guppy)
Archive package:
- Most 64-bit amd64 Linux platforms (for either GPU-enabled Guppy or CPU-only Guppy – the package was built on Centos 7)
- 64-bit Ubuntu 16 arm64v8 (for GPU-enabled Guppy only - the package was built on a Jetson TX2)
GPU devices:
- A supported NVIDIA GPU for the ont-guppy packages
From version 6.1.0 onwards, Guppy no longer officially supports Ubuntu 16 or earlier, as that version of Ubuntu has reached its End of Life (EOL) date. It should still be possible to run the Guppy archive releases on that platform, although it is not explicitly supported.
-
Use this installation process if you are installing from .deb for Guppy:
- Add Oxford Nanopore's deb repository to your system (this is to install Oxford Nanopore Technologies-specific dependency packages):
sudo apt update
sudo apt install wget lsb-release
export PLATFORM=$(lsb_release -cs)
wget -O- https://cdn.oxfordnanoportal.com/apt/ont-repo.pub | sudo apt-key add -
echo "deb http://cdn.oxfordnanoportal.com/apt ${PLATFORM}-stable non-free" | sudo tee /etc/apt/sources.list.d/nanoporetech.sources.list
sudo apt update
2. To install the .deb for Guppy, use the following command:
sudo apt update
sudo apt install ont-guppy
This will install the GPU version of Guppy.
or:
sudo apt update
sudo apt install ont-guppy-cpu
To install the CPU-only version of Guppy.
-
Use this installation process if you are installing from .tar.gz:
- Download the .tar.gz archive file. This can be found on the Software Downloads page of the Nanopore Community.
- Unpack the archive:
tar -xf ont-guppy_xxx_linux<64 or aarch64>.tar.gz
or to unpack the CPU-only version of Guppy:
tar -xf ont-guppy-cpu_xxx_linux<64 or aarch64>.tar.gz
Note: 'xxx' in the command denotes the version number e.g. 3.0.3.
-
Use this installation process if you are installing from .rpm:
- Download the .rpm file. This can be found on the Software Downloads page of the Nanopore Community.
- Install the epel-release repository:
yum install epel-release
If using Centos 8, it will also be necessary to enable the powertools repository. Depending on the version of Centos 8 you have, the name of the repository may be slightly different:
yum install dnf-plugins-core
yum config-manager --set-enabled PowerTools || yum config-manager --set-enabled powertools
3. Install the rpm:
yum install [path]/[to]/ont-guppy_xxx.rpm
This command installs the GPU version of Guppy.or
yum install [path]/[to]/ont-guppy-cpu_xxx.rpm
This command installs the CPU-only version of Guppy.The GPU-enabled ont-guppy package will not install a GPU driver by default – it will be necessary to handle installing this yourself, e.g. by visiting NVIDIA's website. Guppy requires an NVIDIA driver of at least version 455.
-
(Ubuntu 16 only) Using unsupported NVIDIA GPUs
Starting with Ubuntu 18.04, NVIDIA driver versioning was handled differently, and Guppy debs will automatically attempt to install the latest driver version that they can find. This should mean that Guppy will work with any recently-released GPU that has the correct driver installed without any additional work required. On Ubuntu 16.04, newer GPUs may require more up-to-date versions of NVIDIA drivers and CUDA APIs than what the ont-guppy deb recommends. It is possible to install the ont-guppy deb without installing any GPU drivers by not installing the recommended ones, leaving it to the user to ensure that their system has the required minimum drivers:
apt-get install ont-guppy --no-install-recommends
In general NVIDIA APIs and drivers are backwards-compatible, so it will usually be safe to install a later/higher version than Guppy requires. Check for the minimum driver version that Guppy requires usingapt-cache show
:
$ apt-cache show ont-guppy
Package: ont-guppy
Version: 0.0.0-1~xenial
Architecture: amd64
Depends: libc6 (≥2.23), libcurl4-openssl-dev, libssl-dev, libhdf5-cpp-11, libzmq5, libboost-atomic1.58.0, libboost-chrono1.58.0, libboost-date-time1.58.0, libboost-filesystem1.58.0, libboost-program-options1.58.0, libboost-regex1.58.0, libboost-system1.58.0, libboost-log1.58.0
Recommends: nvidia-384, libcuda1-384
[...]
In this example the driver version (384) can be seen as part of thenvidia
andlibcuda1
package names in the "Recommends" section. Driver versions higher than 384 will likely be compatible with this version of Guppy.Note that Guppy only supports GPUs with an NVIDIA compute version of 6.1 or higher.