Installation

Birch is open source software released under the Apache License, Version 2.0. It works on a wide variety of operating systems running on x86 and ARM architectures, as well as Nvidia GPUs. Follow the instructions below for your system, or install from source.

Info

To enable CUDA support, install CUDA separately and then the NumBirch CUDA backend, which comes as a package named numbirch-cuda-dev or numbirch-cuda-devel depending on your system.

Ubuntu

Ubuntu 24.10 Oracular Oriole (amd64)

echo 'deb http://download.indii.org/deb oracular main' | sudo tee /etc/apt/sources.list.d/indii.org.list
curl -fsSL https://download.indii.org/deb/Release.key | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/indii.org.gpg > /dev/null
sudo apt update
sudo apt install birch

Ubuntu 24.04 Noble Numbat (amd64)

echo 'deb http://download.indii.org/deb noble main' | sudo tee /etc/apt/sources.list.d/indii.org.list
curl -fsSL https://download.indii.org/deb/Release.key | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/indii.org.gpg > /dev/null
sudo apt update
sudo apt install birch

Debian

Debian 12 Bookworm (amd64)

echo 'deb http://download.indii.org/deb bookworm main' | sudo tee /etc/apt/sources.list.d/indii.org.list
curl -fsSL https://download.indii.org/deb/Release.key | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/indii.org.gpg > /dev/null
sudo apt update
sudo apt install birch

Fedora

Fedora 40 (x86_64)

sudo dnf config-manager --add-repo https://download.indii.org/rpm/fedora/40/indii.org.repo
sudo dnf update
sudo dnf install birch

Fedora 39 (x86_64)

sudo dnf config-manager --add-repo https://download.indii.org/rpm/fedora/39/indii.org.repo
sudo dnf update
sudo dnf install birch

openSUSE

openSUSE Tumbleweed (x86_64)

sudo zypper addrepo https://download.indii.org/rpm/opensuse/tumbleweed/indii.org.repo
sudo zypper refresh
sudo zypper install birch

Mac

Homebrew

Install Homebrew if not already, then install Birch with:

brew tap lawmurray/all
brew install birch

Windows

Native support is not yet provided, but you can install Windows Subsystem for Linux with one of the Linux distributions above and follow the instructions for it.

Others: Install from source

If a package is not available for your operating system or you have special requirements, you can install from source. See the README.md file for up-to-date instructions.