Metadata-Version: 2.1
Name: qualtran
Version: 0.3.0
Summary: Software for fault-tolerant quantum algorithms research.
Author: Google Quantum AI
Author-email: mpharrigan@google.com
License: Apache 2
License-File: LICENSE
Requires-Dist: attrs
Requires-Dist: cachetools >=5.3
Requires-Dist: networkx
Requires-Dist: numpy
Requires-Dist: sympy
Requires-Dist: cirq-core ==1.4.0.dev20240412172235
Requires-Dist: fxpmath
Requires-Dist: nbconvert
Requires-Dist: nbformat
Requires-Dist: pydot
Requires-Dist: ipython
Requires-Dist: matplotlib
Requires-Dist: ipywidgets
Requires-Dist: plotly
Requires-Dist: dash
Requires-Dist: quimb
Requires-Dist: qsharp
Requires-Dist: qsharp-widgets
Requires-Dist: protobuf

# Qᴜᴀʟᴛʀᴀɴ

Qᴜᴀʟᴛʀᴀɴ (quantum algorithms translator) is a set of abstractions for representing quantum 
programs and a library of quantum algorithms expressed in that language to support quantum 
algorithms research.

**Note:** Qualtran is an experimental preview release. We provide no backwards compatibility 
guarantees. Some algorithms or library functionality may be incomplete or contain inaccuracies. 
Open issues or contact the authors with bug reports or feedback.

Subscribe to [qualtran-announce@googlegroups.com](https://groups.google.com/g/qualtran-announce)
to receive the latest news and updates!

## Documentation

Documentation is available at https://qualtran.readthedocs.io/

## Installation

Qualtran is being actively developed. We recommend installing from source:

For a local editable copy:

    git clone https://github.com/quantumlib/Qualtran.git
    cd Qualtran/
    pip install -e .

You can also install the latest tagged release using `pip`:

    pip install qualtran

You can also install the latest state of the main branch:

    pip install git+https://github.com/quantumlib/Qualtran

## Physical Resource Estimation GUI
Qualtran provides a GUI for estimating the physical resources (qubits, magic states, runtime, ..etc) needed to run a quantum algorithm. The GUI can be run locally by running:
    
    cd $QUALTRAN_HOME
    python -m qualtran.surface_code.ui
