README

Installing Autotune

Autotune and its dependent libraries can be downloaded and installed by calling make install from within the autotune directory.

This procedure will download and install Blossom V a software library written by Vladimir Kolmogorov and required by Autotune. Please take careful note of the license of this software as outlined in blossomv/LICENSE.TXT after installation. Research using Autotune and therefore Blossom V must cite Blossom V in any publications, and commercial use is forbidden without consent. Please email vnk@ist.ac.at with issues regarding licensing of Blossom V.

Building Autotune

To build (make) Autotune, Blossom V, and the example files:

cd ./autotune;
make install;

Now you can run any of the examples from the directory:

autotune/ex/bin

Complete Installation Instructions

git clone git@github.com:adamcw/autotune.git;
cd ./autotune;
make install;

NOTE: This process may fail when trying to install the Python dependencies. See 'Known Issues' below for more information should this occur, and/or follow on screen instructions.

Running the Example

cd ./process;
./run.py --input example_runs.json;

NOTE: For instructions on the use of run.py and other pieces of the processing pipeline, please read: ./process/README.md

Potential Issues

Incorrect Compiler

By default the script will try and use g++ if the environment variable CXX is not set. If there are build issues, you can try and build using a specific version of gcc by modifying your environment to export $CXX. If using bash, edit your .bashrc or .bash_profile to include:

export CXX=g++;

NOTE: On OSX the default value for CXX may be clang (c++) rather than gcc (g++). As the script will look at CXX before any other value, be sure to use this line to ensure gcc is being used.

No Python / Incorrect Version of Python

The processing pipeline (process directory) requires Python 2.7. If this is not available, the installation of the processing pipeline will fail.

Python Package Installer (pip) Not Available

If you have Python but the python package installer, pip, is not installed. Then you will need to install pip, or use a virtualenv (virtual environment). See below for this case.

Insufficient Privliages to Install/Use pip

If this is required make install will suggest using make virtualenv. Run this command. If it fails due to virtualenv not being installed on your system, then it will suggest using make virtualenv_install. Once a virtualenv (virtual environment) is created via this process, onscreen instructions will be provided as to its use.

Detailed instructions on virtual environments, their creation, and their usage are available in ./process/README.md with relevant sections listed below

• Installation
• Creating a Virtual Environment
• Using a Virtual Environment

What's in Autotune?

Autotune is comprised of three modules.

• The Autotune libraries known as libautotune. This contains the following libraries:
  • match (A wrapper for the Blossom V matching library)
  • depolar (Depolarizing Quantum Computer)
  • qc (Quantum Computer)
  • bfs (Breadth First Search)
  • bheap (Binary Heap)
  • cdllist (Circular Double-Linked List)
  • dllist (Double-Linked List)
  • hash_table (A Hash Table)
  • llist (Linked List)
  • memory (Memory functions)
  • my_time (Timing functions)
  • polyestimate (A library for estimating logical error rates given a database of pre-simulated results)
  • random (A Mersenne Prime Twister random number generator library)
• The tools that make use of Autotune. Exist as advanced examples that provide a useful function beyond demonstrating what Autotune can do.
  • polyestimate (A tool for estimating logical error rates given a database of pre-simulated results)
• Examples of the use of the Autotune library This contains the following examples:
  • ex1 (The use of Autotune to implement the Surface Code on a solid-state quantum computer)
  • ex2 (The use of Autotune to implement the Topological Cluster State with qubit loss)
• Processing scripts for generating graphs based on the output of Autotune

Building Autotune

• You can install/compile all of Autotune using:

  make install;

You can compile libautotune on its own:

make libautotune;

You can compile blossomv on its own:

make blossomv;

You can compile the examples on their own (though require libautotune and blossomv to be compiled first)

make ex;

You can compile just the processing pipeline:

make process;

You can compile libautotune and the examples ex at the same time (helpful if modifying libautotune and examples simultaneously through development):

make autotune;

You can compile all targets at once:

make all;

Processing Autotune

For more information on processing the output of `Autotune` into a
summarised format or graph please read the associated `README.md`.

See: process/README.md

Polyestimate Tool

See: tools/polyestimate/README.md

Austin G. Fowler. 
"Polyestimate: instantaneous open source surface code analysis"
Awaiting Publication (2013)
Note: arXiv:1307.0689, http://topqec.com.au/autotune.html

Topological Cluster State

Adam C. Whiteside, Austin G. Fowler 
"Practical Topological Cluster State Quantum Computing Requires Loss Below 1%"
Awaiting Publication (2014)
Note: arXiv:1409.4880, http://topqec.com.au/autotune.html

More Information

See: MANUAL

Contact

Austin Fowler (afowler@topqec.com.au)
Adam Whiteside (awhiteside@topqec.com.au)

Website

Topological Quantum Error Correction
http://www.topqec.com.au

License

The MIT License (MIT)

Copyright (c) 2013 Austin G. Fowler, Adam C. Whiteside, Angus L. McInnes, Alimohammad Rabbani

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.