Installation

Installation with Docker

The recommended way to use katgpucbf is via Docker. There is currently no published Docker image, so it is necessary to build your own. To do so, change to the root directory of the repository and run

docker build -t NAME .

where NAME is the name to assign to the image.

You will need to have the NVIDIA container runtime installed to provide Docker with access to the GPU.

Installation with pip

It is also possible to install katgpucbf with pip. In this case, you will need to have CUDA already installed, as well as Vulkan drivers [1]. Change to the root directory of the repository and run

pip install ".[gpu]"

Note that if you are planning to do development on katgpucbf, you should refer to the Developers’ guide.

[1]

Standard driver installation should include Vulkan support, although you may need to install a package such as libvulkan1.