qnexus

This document lists our Python API documentation for the qnexus package.

qnexus:

• qnexus
• auth
  • login()
  • login_with_credentials()
  • logout()
• configuring backends
  • HeliosConfig
  • HeliosEmulatorConfig
  • SimpleRuntime
  • HeliosRuntime
  • NoErrorModel
  • DepolarizingErrorModel
  • QSystemErrorModel
  • HeliosCustomErrorModel
  • StatevectorSimulator
  • StabilizerSimulator
  • MatrixProductStateSimulator
  • CoinflipSimulator
  • ClassicalReplaySimulator
  • SeleneConfig
  • SelenePlusConfig
  • QuantinuumConfig
  • AerConfig
  • AerStateConfig
  • AerUnitaryConfig
  • BraketConfig
  • IBMQConfig
  • IBMQEmulatorConfig
  • QulacsConfig
  • Language
    • Language.AUTO
    • Language.QASM
    • Language.QIR
• circuits
  • cost()
  • get()
  • get_all()
  • update()
  • upload()
  • CircuitRef
    • CircuitRef.df()
    • CircuitRef.download_circuit()
• compile
  • compile()
  • start_compile_job()
  • CompileJobRef
    • CompileJobRef.df()
  • CompilationResultRef
    • CompilationResultRef.df()
    • CompilationResultRef.get_input()
    • CompilationResultRef.get_output()
    • CompilationResultRef.get_passes()
  • CompilationPassRef
    • CompilationPassRef.df()
    • CompilationPassRef.get_input()
    • CompilationPassRef.get_output()
  • HyperTketConfig
• Context Management in qnexus
  • deactivate_project()
  • deactivate_properties()
  • deactivate_scope()
  • get_active_project()
  • get_active_properties()
  • get_active_scope()
  • merge_project_from_context()
  • merge_properties_from_context()
  • merge_scope_from_context()
  • set_active_project()
  • set_active_project_token()
  • set_active_scope()
  • set_active_scope_token()
  • update_active_properties()
  • update_active_properties_token()
  • using_project()
  • using_properties()
  • using_scope()
• credentials
  • get_all()
  • Credential
    • Credential.df()
  • CredentialIssuer
    • CredentialIssuer.QUANTINUUM
    • CredentialIssuer.QISKIT
    • CredentialIssuer.BRAKET
• devices
  • DeviceStateEnum
    • DeviceStateEnum.ONLINE
    • DeviceStateEnum.OFFLINE
    • DeviceStateEnum.MAINTENANCE
    • DeviceStateEnum.RESERVED_ONLINE
    • DeviceStateEnum.RESERVED_MAINTENANCE
    • DeviceStateEnum.RESERVED_OFFLINE
  • expectation_allows_nonhermitian()
  • get_all()
  • status()
  • supports_contextual_optimisation()
  • supports_counts()
  • supports_density_matrix()
  • supports_expectation()
  • supports_shots()
  • supports_state()
  • supports_unitary()
  • Device
    • Device.df()
• Exceptions
  • AuthenticationError
  • IncompatibleResultVersion
  • JobError
  • NoUniqueMatch
  • ResourceCreateFailed
  • ResourceDeleteFailed
  • ResourceFetchFailed
  • ResourceUpdateFailed
  • ZeroMatches
• execute
  • execute()
  • start_execute_job()
  • ExecuteJobRef
    • ExecuteJobRef.df()
  • ExecutionResultRef
    • ExecutionResultRef.df()
    • ExecutionResultRef.download_backend_info()
    • ExecutionResultRef.download_result()
    • ExecutionResultRef.get_input()
• filesystem
  • load()
  • save()
• gpu_decoder_configs
  • get()
  • get_all()
  • update()
  • upload()
  • GpuDecoderConfigRef
    • GpuDecoderConfigRef.df()
    • GpuDecoderConfigRef.download_gpu_decoder_config_contents()
• hugr
  • cost()
  • get()
  • get_all()
  • update()
  • upload()
  • HUGRRef
    • HUGRRef.df()
    • HUGRRef.download_hugr()
    • HUGRRef.download_hugr_bytes()
• hypertket
  • HyperTketConfig
  • QubitReuseConfig
  • DualStrat
  • BruteForceOrderConfig
  • ConstrainedOptOrderConfig
  • LocalGreedyOrderConfig
  • LocalGreedyFirstNodeSearchOrderConfig
  • DefaultOrderConfig
  • CustomOrderConfig
• jobs
  • RemoteRetryStrategy
    • RemoteRetryStrategy.FULL_RESTART
  • cancel()
  • cost()
  • delete()
  • get()
  • get_all()
  • listen_job_status()
  • results()
  • retry_submission()
  • status()
  • wait_for()
  • JobStatusEnum
    • JobStatusEnum.COMPLETED
    • JobStatusEnum.QUEUED
    • JobStatusEnum.SUBMITTED
    • JobStatusEnum.RUNNING
    • JobStatusEnum.CANCELLED
    • JobStatusEnum.ERROR
    • JobStatusEnum.CANCELLING
    • JobStatusEnum.RETRYING
    • JobStatusEnum.TERMINATED
    • JobStatusEnum.DEPLETED
  • JobRef
    • JobRef.df()
  • JobType
    • JobType.EXECUTE
    • JobType.COMPILE
  • IncompleteJobItemRef
    • IncompleteJobItemRef.df()
• models
  • Annotations
  • SortFilterEnum
    • SortFilterEnum.CREATED_ASC
    • SortFilterEnum.CREATED_DESC
    • SortFilterEnum.MODIFIED_ASC
    • SortFilterEnum.MODIFIED_DESC
    • SortFilterEnum.NAME_ASC
    • SortFilterEnum.NAME_DESC
  • ResultVersions
    • ResultVersions.DEFAULT
    • ResultVersions.RAW
  • QIRResult
• NexusIterator & DataframableList
  • NexusIterator
    • NexusIterator.count()
    • NexusIterator.df()
    • NexusIterator.list()
    • NexusIterator.summarize()
    • NexusIterator.try_unique_match()
  • DataframableList
    • DataframableList.df()
• projects
  • add_property()
  • create()
  • delete()
  • get()
  • get_all()
  • get_or_create()
  • get_properties()
  • summarize()
  • update()
  • ProjectRef
    • ProjectRef.df()
  • Property
    • Property.df()
• roles
  • assign_team()
  • assign_user()
  • assignments()
  • get()
  • get_all()
  • Role
    • Role.df()
  • RoleInfo
    • RoleInfo.df()
• qir
  • cost()
  • get()
  • get_all()
  • update()
  • upload()
  • QIRRef
    • QIRRef.df()
    • QIRRef.download_qir()
• quotas
  • check_quota()
  • get()
  • get_all()
  • Quota
    • Quota.df()
• teams
  • create()
  • get()
  • get_all()
  • TeamRef
    • TeamRef.df()
• users
  • get_self()
  • UserRef
    • UserRef.df()
• Qiskit Noise Models for backend configurations
  • AerNoiseModel
  • AerQuantumError
  • AerReadoutError
  • CrosstalkParams
  • QiskitBasicInstruction
  • QiskitKrausInstruction
  • QiskitPauliInstruction
• Additional Quantinuum Systems configuration
  • HeliosErrorParams
  • UserErrorParams
  • QuantinuumCompilerOptions
  • QuantinuumOptions
• wasm_modules
  • get()
  • get_all()
  • update()
  • upload()
  • WasmModuleRef
    • WasmModuleRef.df()
    • WasmModuleRef.download_wasm_contents()