Uni10

Welcome to Uni10, the Universal Tensor Network Library.

Introduction

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:

Copyright and Changes

Installation

Download

The latest Uni10 source code can be downloaded from github.

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_PYTHON_WRAPPER Build pyUni10 wrapper (off)
BUILD_EXAMPLES Build C++ examples (on)
BUILD_DOC Build Documentation (off)
BUILD_ARPACK_SUPPORT Build ARPACK wrapper (off)
CMAKE_INSTALL_PREFIX Installation location (/usr/local/uni10)

API Documentation

API documentation can be found here

Developers and Maintainers

Alumni

Help and Bug Reports

Please report bugs on Github by creating issues.

Known issues

To Do