Universal Tensor Network Library - Uni10

Uni10 is an open-source C++ library designed for the development of tensor network algorithms. Programming tensor network algorithms is tedious and prone to errors. The task of keeping track of tensor indices while performing contraction of a complicated tensor network can be daunting. It is desirable to have a platform that provides bookkeeping capability and optimization.

This software distinguishes itself from other available software solutions by providing the following advantages:

Current Release

Latest release: v2.0.0

What’s new?

See GPL and LGPL for copyright conditions.

See Release Notes for release notes and changes.

Installation

See install guide

Download

The latest Uni10 source code can be downloaded from GitLab.

Requirements

Build

To build Un10, follow the following steps:

  1. Create a build directory

  2. Use Cmake to generate makefile

  3. Build library and exmamples

  4. Install library and examples (May require root access)

Examples

Using system c++, blas and lapack

> mkdir build
> cd build
> cmake </path/to/uni10/>
> make
> sudo make install

The installation path defaults to /usr/local/uni10.

To override the default path, use CMAKE_INSTALL_PREFIX :

> cmake -DCMAKE_INSTALL_PREFIX=</installation_path> </path/to/uni10/>

To use MKL and Intel compiler:

> cmake -DBUILD_WITH_MKL=on -DBUILD_WITH_INTEL_COMPILER=on </path/to/uni10/>

If cmake failes to find blas and lapack, specify the libraries by

> cmake -DBLAS_LIBRARIES=</path/to/blas> -DLAPACK_LIBRARIES=</path/to/lapack> </path/to/uni10/>

Build Options

Option Description (Default value)
BUILD_WITH_MKL Use Intel MKL for lapack and blas (off)
BUILD_WITH_INTEL_COMPILERS Use Intel C++ compiler (off)
BUILD_EXAMPLES Build C++ examples (on)
BUILD_DOC Build Documentation (off)
BUILD_CUDA_SUPPORT Build Library for CUDA GPUs (off)
CMAKE_INSTALL_PREFIX Installation location (/usr/local/uni10)

Developers

Contributors and maintainers

Alumni

How to Contribute

Known issues

pipeline status

coverage report