A high-performance general-purpose compute library

- Main Page
- Tutorials
- Release Notes
- Examples

ArrayFire Installer

Installing ArrayFire couldn't be easier. Navigate to https://arrayfire.com/download and download the appropriate installer for the target architecture and operating system. Although ArrayFire can be built from source, the installers conveniently package necessary dependencies.

Install the latest device drivers before using ArrayFire. If you are going to target the CPU using ArrayFire’s OpenCL backend, install the OpenCL runtime. Drivers and runtimes should be downloaded and installed from the device vendor’s website.

# Install Instructions

- Windows
- Linux
- macOS

## Windows

Prior to installing ArrayFire on Windows, download install the Visual Studio 2015 (x64) runtime libraries.

Once the ArrayFire installer has been downloaded, run the installer. If you choose not to modify the path during the installation procedure, you'll need to manually add ArrayFire to the path for all users. Simply append `%AF_PATH%/lib` to the PATH variable so that the loader can find ArrayFire DLLs.

For more information on using ArrayFire on Windows, visit the following page.

## Linux

There are two ways to install ArrayFire on Linux.

1. Package Manager
2. Using ArrayFire Linux Installer

As of today, approach (1) is only supported for Ubuntu 18.04 and 20.04. Please go through our GitHub wiki page for the detailed instructions.

For approach (2), once you have downloaded the ArrayFire installer, execute the installer from the terminal as shown below. Set the `--prefix` argument to the directory you would like to install ArrayFire to - we recommend `/opt`.

    ./Arrayfire_*_Linux_x86_64.sh --include-subdir --prefix=/opt

Given sudo permissions, you can add the ArrayFire libraries via `ldconfig` like so:

    echo /opt/arrayfire/lib64 > /etc/ld.so.conf.d/arrayfire.conf
    sudo ldconfig

Otherwise, you will need to set the `LD_LIBRARY_PATH` environment variable in order to let your shared library loader find the ArrayFire libraries.

For more information on using ArrayFire on Linux, visit the following page.

### Graphics support

ArrayFire allows you to do high performance visualizations via our Forge library. On Linux, there are a few dependencies you will need to install to enable graphics support:

FreeImage Fontconfig GLU (OpenGL Utility Library)

We show how to install these dependencies on common Linux distributions:

Debian, Ubuntu (14.04 and above), and other Debian derivatives

    apt install build-essential libfreeimage3 libfontconfig1 libglu1-mesa

Fedora, Redhat, CentOS

    yum install freeimage fontconfig mesa-libGLU

## macOS

Once you have downloaded the ArrayFire installer, execute the installer by either double clicking on the ArrayFire `pkg` file or running the following command from your terminal:

    sudo installer -pkg Arrayfire-*_OSX.pkg -target /

For more information on using ArrayFire on macOS, visit the following page.

## NVIDIA Tegra devices

ArrayFire is capable of running on TX1 and TX2 devices. The TK1 is no longer supported.

Prior to installing ArrayFire, make sure you have the latest version of JetPack (v2.3 and above) or L4T (v24.2 and above) on your device.

### Tegra prerequisites

The following dependencies are required for Tegra devices:

    sudo apt install libopenblas-dev liblapacke-dev

## Testing installation

After ArrayFire is finished installing, we recommend building and running a few of the provided examples to verify things are working as expected.

On Unix-like systems:

    cp -r /opt/arrayfire/share/ArrayFire/examples /tmp/examples
    cd /tmp/examples
    mkdir build
    cd build
    cmake -DASSETS_DIR:PATH=/tmp ..
    make
    ./helloworld/helloworld_{cpu,cuda,opencl}

On Windows, open the CMakeLists.txt file from CMake-GUI and set `ASSETS_DIR` variable to the parent folder of examples folder. Once the project is configured and generated, you can build and run the examples from Visual Studio.

## Getting help

- Google Groups: https://groups.google.com/forum/#!forum/arrayfire-users
- ArrayFire Services: Consulting | Support | Training
- ArrayFire Blogs: http://arrayfire.com/blog/
- Email: techn.nosp@m.ical.nosp@m.@arra.nosp@m.yfir.nosp@m.e.com