Welcome to QMAP’s documentation!

QMAP is a tool for quantum circuit compilation developed as part of the Munich Quantum Toolkit (MQT) by the Chair for Design Automation at the Technical University of Munich. It builds upon MQT Core, which forms the backbone of the MQT.

We recommend you to start with the installation instructions or by reading our overview paper [1]. Then proceed to the mapping page or the synthesis/optimization page and read the reference documentation. If you are interested in the theory behind QMAP, have a look at the publications in the publication list.

We appreciate any feedback and contributions to the project. If you want to contribute, you can find more information in the Contribution guide. If you are having trouble with the installation or the usage of QMAP, please let us know at our Support page or by reaching out to us at quantum.cda@xcit.tum.de.

---

User Guide

• Installation
  • A Detailed Walk Through
  • Building from Source for Performance
• Quantum Circuit Mapping
  • Exact Mapping
  • Heuristic Mapping
• Synthesis of Clifford Circuits
  • Clifford Circuits
  • Using QMAP for Optimal Synthesis
• Publications

Developers

• Contributing
  • Types of Contributions
  • 🎉 Get Started
  • Core Guidelines
  • Pull Request Workflow
• Development Guide
  • Initial Setup
  • Working on the core C++ library
  • Working on the Python module
  • Working on the Documentation
• Support

API Reference

• Library
  • Quantum Circuit Compilation
    • compile()
    • Compile Setting Enumerations
      • Method
      • Heuristic
      • LookaheadHeuristic
      • Layering
      • InitialLayout
      • Encoding
      • CommanderGrouping
      • SwapReduction
  • Architecture
    • Constructing an Architecture
      • From a Qiskit Backend
      • From a Coupling Map
      • From a File
    • Full API of the Architecture class
      • Architecture
        • Architecture.Properties
          • Architecture.Properties.__init__()
          • Architecture.Properties.get_calibration_date()
          • Architecture.Properties.get_frequency()
          • Architecture.Properties.get_readout_error()
          • Architecture.Properties.get_single_qubit_error()
          • Architecture.Properties.get_t1()
          • Architecture.Properties.get_t2()
          • Architecture.Properties.get_two_qubit_error()
          • Architecture.Properties.json()
          • Architecture.Properties.name
          • Architecture.Properties.num_qubits
          • Architecture.Properties.set_calibration_date()
          • Architecture.Properties.set_frequency()
          • Architecture.Properties.set_readout_error()
          • Architecture.Properties.set_single_qubit_error()
          • Architecture.Properties.set_t1()
          • Architecture.Properties.set_t2()
          • Architecture.Properties.set_two_qubit_error()
        • Architecture.__init__()
        • Architecture.coupling_map
        • Architecture.load_coupling_map()
        • Architecture.load_properties()
        • Architecture.name
        • Architecture.num_qubits
        • Architecture.properties
      • Arch
        • Arch.name
  • Results
    • MappingResults
      • MappingResults.mapped_circuit
      • MappingResults.time
      • MappingResults.timeout
      • MappingResults.input
      • MappingResults.output
      • MappingResults.wcnf
      • MappingResults.heuristic_benchmark
      • MappingResults.layer_heuristic_benchmark
      • MappingResults.json()
      • MappingResults.csv()
  • Optimal Subarchitectures
    • SubarchitectureOrder
      • SubarchitectureOrder.covering()
      • SubarchitectureOrder.draw_subarchitecture()
      • SubarchitectureOrder.draw_subarchitectures()
      • SubarchitectureOrder.from_backend()
      • SubarchitectureOrder.from_backend_v2()
      • SubarchitectureOrder.from_coupling_map()
      • SubarchitectureOrder.from_library()
      • SubarchitectureOrder.from_qmap_architecture()
      • SubarchitectureOrder.from_retworkx_graph()
      • SubarchitectureOrder.from_string()
      • SubarchitectureOrder.optimal_candidates()
      • SubarchitectureOrder.store_library()
    • subarchitectures.precomputed_backends
    • subarchitectures.ibm_guadalupe_subarchitectures()
    • subarchitectures.rigetti_16_subarchitectures()
  • Quantum Circuit Synthesis
    • synthesize_clifford()
    • optimize_clifford()
    • Synthesis Configuration
      • TargetMetric
      • Verbosity
      • SynthesisConfiguration
        • SynthesisConfiguration.dump_intermediate_results
        • SynthesisConfiguration.gate_limit_factor
        • SynthesisConfiguration.heuristic
        • SynthesisConfiguration.initial_timestep_limit
        • SynthesisConfiguration.intermediate_results_path
        • SynthesisConfiguration.json()
        • SynthesisConfiguration.linear_search
        • SynthesisConfiguration.minimal_timesteps
        • SynthesisConfiguration.minimize_gates_after_depth_optimization
        • SynthesisConfiguration.minimize_gates_after_two_qubit_gate_optimization
        • SynthesisConfiguration.n_threads_heuristic
        • SynthesisConfiguration.solver_parameters
        • SynthesisConfiguration.split_size
        • SynthesisConfiguration.target_metric
        • SynthesisConfiguration.try_higher_gate_limit_for_two_qubit_gate_optimization
        • SynthesisConfiguration.use_maxsat
        • SynthesisConfiguration.use_symmetry_breaking
        • SynthesisConfiguration.verbosity
  • Synthesis Results
    • SynthesisResults
      • SynthesisResults.circuit
      • SynthesisResults.depth
      • SynthesisResults.gates
      • SynthesisResults.runtime
      • SynthesisResults.sat()
      • SynthesisResults.single_qubit_gates
      • SynthesisResults.solver_calls
      • SynthesisResults.tableau
      • SynthesisResults.two_qubit_gates
      • SynthesisResults.unsat()
  • Visualization
    • Search graph visualization
      • SearchVisualizer
        • SearchVisualizer.__init__()
        • SearchVisualizer.close()
        • SearchVisualizer.visualize_search_graph()