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.

Linux

Install from the software repository, following the instructions provided there.

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.

Mac

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.