uniqc package

Subpackages

• uniqc.algorithms package
  • Subpackages
    • uniqc.algorithms.core package
      • Subpackages
      • Module contents
    • uniqc.algorithms.workflows package
      • Submodules
      • Module contents
  • Module contents
• uniqc.backend_adapter package
  • Subpackages
    • uniqc.backend_adapter.task package
      • Subpackages
      • Submodules
      • Module contents
  • Submodules
    • uniqc.backend_adapter.backend module
      • DummyBackend
      • IBMBackend
      • OriginQBackend
      • QuafuBackend
      • QuantumBackend
      • QuarkBackend
      • clear_backend_cache()
      • get_backend()
      • list_backends()
      • list_backends_by_platform()
      • register_backend()
      • unregister_backend()
    • uniqc.backend_adapter.backend_cache module
      • Cache file layout
      • Cache TTL
      • cache_info()
      • get_cached_backends()
      • invalidate()
      • invalidate_all()
      • is_stale()
      • update_cache()
    • uniqc.backend_adapter.backend_info module
      • BackendInfo
      • Platform
      • QubitTopology
      • parse_backend_id()
    • uniqc.backend_adapter.backend_registry module
      • BackendAuditIssue
      • FetchResult
      • audit_backend_info()
      • audit_backends()
      • fetch_all_backends()
      • fetch_all_backends_with_status()
      • fetch_platform_backends()
      • find_backend()
    • uniqc.backend_adapter.circuit_adapter module
      • CircuitAdapter
      • IBMCircuitAdapter
      • OriginQCircuitAdapter
      • QuafuCircuitAdapter
      • QuarkCircuitAdapter
    • uniqc.backend_adapter.config module
    • uniqc.backend_adapter.database_migration module
      • Schema version history
      • Future migrations (planned)
    • uniqc.backend_adapter.dummy_backend module
      • DummyBackendSpec
      • dummy_adapter_kwargs()
      • list_dummy_backend_infos()
      • resolve_dummy_backend()
      • virtual_grid_topology()
      • virtual_line_topology()
    • uniqc.backend_adapter.network_utils module
      • check_proxy_connectivity()
      • detect_system_proxy()
      • get_ibm_proxy_from_config()
      • test_ibm_connectivity()
    • uniqc.backend_adapter.preflight module
      • Backend identifier grammar
      • BackendPreflightError
      • BackendTarget
      • ensure_backend_ready()
      • has_provider_credentials()
      • parse_backend_target()
    • uniqc.backend_adapter.region_selector module
      • ChainSearchResult
      • RegionSearchResult
      • RegionSelector
    • uniqc.backend_adapter.task_manager module
      • TaskManager
      • clear_cache()
      • clear_completed_tasks()
      • dry_run_batch()
      • dry_run_task()
      • get_platform_task_ids()
      • get_result()
      • get_task()
      • list_tasks()
      • poll_result()
      • query_task()
      • save_task()
      • submit_batch()
      • submit_task()
      • wait_for_result()
  • Module contents
• uniqc.calibration package
  • Subpackages
    • uniqc.calibration.readout package
      • Submodules
      • Module contents
    • uniqc.calibration.xeb package
      • Submodules
      • Module contents
  • Submodules
    • uniqc.calibration.results module
      • CalibrationResult
      • ReadoutCalibrationResult
      • XEBResult
      • ensure_cache_dir()
      • find_cached_results()
      • load_calibration_result()
      • save_calibration_result()
  • Module contents
• uniqc.circuit_builder package
  • Submodules
    • uniqc.circuit_builder.matrix module
      • get_matrix()
    • uniqc.circuit_builder.named_circuit module
      • NamedCircuit
      • circuit_def()
    • uniqc.circuit_builder.normalize module
      • AnyQuantumCircuit
      • NormalizedCircuit
      • normalize_circuit_input()
      • normalize_to_circuit()
      • resolve_output_format()
    • uniqc.circuit_builder.opcode module
      • make_header_originir()
      • make_header_qasm()
      • make_measure_originir()
      • make_measure_qasm()
      • opcode_to_line_originir()
      • opcode_to_line_qasm()
    • uniqc.circuit_builder.originir_spec module
      • generate_sub_error_channel_originir()
      • generate_sub_gateset_originir()
    • uniqc.circuit_builder.parameter module
      • Parameter
      • Parameters
    • uniqc.circuit_builder.qasm_spec module
      • generate_sub_gateset_qasm()
    • uniqc.circuit_builder.qcircuit module
      • Circuit
      • CircuitControlContext
      • CircuitDagContext
    • uniqc.circuit_builder.qubit module
      • QReg
      • QRegSlice
      • Qubit
    • uniqc.circuit_builder.random_originir module
      • build_full_measurements()
      • build_originir_error_channel()
      • build_originir_gate()
      • random_originir()
    • uniqc.circuit_builder.random_qasm module
      • build_full_measurements()
      • build_measurements()
      • build_qasm_from_opcodes()
      • build_qasm_gate()
      • random_qasm()
    • uniqc.circuit_builder.translate_qasm2_oir module
      • collect_qasm2_custom_gates()
      • decompose_mcu_qasm_text()
      • decompose_mcx_qasm_text()
      • direct_mapping_qasm2_to_oir()
      • get_QASM2_from_opcode()
      • get_opcode_from_QASM2()
  • Module contents
• uniqc.compile package
  • Subpackages
    • uniqc.compile.originir package
      • Submodules
      • Module contents
    • uniqc.compile.qasm package
      • Submodules
      • Module contents
  • Submodules
    • uniqc.compile.compiler module
      • CompilationResult
      • TranspilerConfig
      • compile()
      • compile_full()
      • compile_with_config()
    • uniqc.compile.converter module
      • convert_oir_to_qasm()
      • convert_qasm_to_oir()
    • uniqc.compile.decompose module
      • decompose_for_qasm2()
      • decompose_opcode_for_qasm2()
    • uniqc.compile.draw module
    • uniqc.compile.policy module
      • PLATFORM_BASIS_GATES
      • PLATFORM_SUBMIT_LANGUAGE
      • compile_for_backend()
      • resolve_basis_gates()
      • resolve_submit_language()
    • uniqc.compile.qiskit_transpiler module
      • transpile_originir()
      • transpile_qasm()
    • uniqc.compile.timeline module
    • uniqc.compile.validation module
      • Two public entry points
      • CompatibilityReport
      • VIRTUAL_Z_GATES
      • compatibility_report()
      • compute_gate_depth()
      • is_compatible()
  • Module contents
• uniqc.gateway package
  • Subpackages
    • uniqc.gateway.api package
      • Submodules
      • Module contents
    • uniqc.gateway.db package
      • Submodules
      • Module contents
  • Submodules
    • uniqc.gateway.cli module
      • restart()
      • start()
      • status()
      • stop()
    • uniqc.gateway.config module
      • load_gateway_config()
      • save_gateway_config()
    • uniqc.gateway.server module
      • create_app()
    • uniqc.gateway.ws module
      • Event
      • EventBroadcaster
  • Module contents
• uniqc.qem package
  • Submodules
    • uniqc.qem.m3 module
      • M3Mitigator
    • uniqc.qem.readout_em module
      • ReadoutEM
    • uniqc.qem.zne module
      • ZNE
  • Module contents
• uniqc.simulator package
  • Submodules
    • uniqc.simulator.base_simulator module
      • BaseNoisySimulator
      • BaseSimulator
    • uniqc.simulator.error_model module
      • AmplitudeDamping
      • BitFlip
      • Depolarizing
      • ErrorLoader
      • ErrorLoader_GateSpecificError
      • ErrorLoader_GateTypeError
      • ErrorLoader_GenericError
      • ErrorModel
      • Kraus1Q
      • PauliError1Q
      • PauliError2Q
      • PhaseFlip
      • TwoQubitDepolarizing
    • uniqc.simulator.get_backend module
      • create_simulator()
      • get_backend()
      • get_simulator()
    • uniqc.simulator.mps_simulator module
      • When to use this simulator
      • When NOT to use this simulator
      • Public API
      • MPSConfig
      • MPSSimulator
    • uniqc.simulator.opcode_simulator module
      • OpcodeSimulator
      • backend_alias()
    • uniqc.simulator.qutip_sim_impl module
      • DensityOperatorSimulatorQutip
    • uniqc.simulator.simulator module
      • NoisySimulator
      • Simulator
    • uniqc.simulator.torchquantum_simulator module
      • TorchQuantumSimulator
  • Module contents
• uniqc.torch_adapter package
  • Submodules
    • uniqc.torch_adapter.batch_executor module
      • batch_execute()
      • batch_execute_with_params()
    • uniqc.torch_adapter.gradient module
      • compute_all_gradients()
      • parameter_shift_gradient()
    • uniqc.torch_adapter.quantum_layer module
      • QuantumLayer
      • nn
    • uniqc.torch_adapter.tq_quantum_layer module
      • TorchQuantumLayer
      • nn
  • Module contents
• uniqc.utils package
  • Submodules
    • uniqc.utils.expectation module
      • calculate_exp_X()
      • calculate_exp_Y()
      • calculate_expectation()
      • calculate_multi_basis_expectation()
    • uniqc.utils.result_adapter module
      • QASMResultAdapter
      • kv2list()
      • list2kv()
      • normalize_result()
      • shots2prob()
  • Module contents
• uniqc.visualization package
  • Submodules
    • uniqc.visualization.circuit module
      • draw()
      • draw_html()
    • uniqc.visualization.result module
      • plot_distribution()
      • plot_histogram()
    • uniqc.visualization.timeline module
      • TimelineGate
      • TimelineSchedule
      • circuit_to_html()
      • create_time_line_table()
      • format_result()
      • plot_time_line()
      • plot_time_line_html()
      • schedule_circuit()
  • Module contents
    • draw()
    • draw_html()

Submodules

• uniqc.config module
  • create_default_config()
  • get_active_profile()
  • get_always_ai_hints()
  • get_ibm_config()
  • get_originq_config()
  • get_platform_config()
  • get_quafu_config()
  • get_quark_config()
  • has_platform_credentials()
  • load_config()
  • load_dummy_config()
  • load_ibm_config()
  • load_originq_config()
  • load_quafu_config()
  • load_quark_config()
  • save_config()
  • set_active_profile()
  • set_always_ai_hints()
  • update_platform_config()
  • validate_config()
• uniqc.exceptions module
  • AuthenticationError
  • BackendError
  • BackendNotAvailableError
  • BackendNotFoundError
  • BackendOptionsError
  • CircuitError
  • CircuitTranslationError
  • CompilationFailedError
  • ConfigError
  • ConfigValidationError
  • InsufficientCreditsError
  • MissingDependencyError
  • NetworkError
  • NotMatrixableError
  • NotSupportedGateError
  • PlatformNotFoundError
  • ProfileNotFoundError
  • QuotaExceededError
  • RegisterDefinitionError
  • RegisterNotFoundError
  • RegisterOutOfRangeError
  • StaleCalibrationError
  • TaskFailedError
  • TaskNotFoundError
  • TaskTimeoutError
  • TimelineDurationError
  • TopologyError
  • UnifiedQuantumError
  • UnsupportedGateError

Module contents

UnifiedQuantum public API.

The common user path is intentionally flat: frequently used classes and functions can be imported directly from uniqc.