references¶

class qnexus.models.references.DataframableList( iterable: Iterable[T], )[source]¶

Bases: list[T]

A Python list that implements the Dataframable protocol.

df() → DataFrame[source]¶: Present in a pandas DataFrame.

class qnexus.circuits.CircuitRef( *, id: UUID, annotations: Annotations, project: ProjectRef, type: Literal['CircuitRef'] = 'CircuitRef', )[source]¶

Proxy object to a Circuit in Nexus.

df() → DataFrame[source]¶: Present in a pandas DataFrame.

download_circuit( scope: ScopeFilterEnum = ScopeFilterEnum.USER, ) → Circuit[source]¶: Get a copy of the circuit as a pytket Circuit object.

class qnexus.jobs.CompileJobRef( *, id: UUID, annotations: Annotations, job_type: JobType = JobType.COMPILE, last_status: JobStatusEnum, last_message: str, last_status_detail: JobStatus | None = None, project: ProjectRef, system: SystemRef | None = None, backend_config_store: Annotated[AerConfig | AerStateConfig | AerUnitaryConfig | BraketConfig | QuantinuumConfig | IBMQConfig | IBMQEmulatorConfig | QulacsConfig | SeleneConfig | SelenePlusConfig | HeliosConfig, FieldInfo(annotation=NoneType, required=True, discriminator='type')] | None = None, type: Literal['CompileJobRef'] = 'CompileJobRef', )[source]¶

Proxy object to a CompileJob in Nexus.

df() → DataFrame¶: Present in a pandas DataFrame.

class qnexus.models.references.CompilationResultRef( *, id: UUID, annotations: Annotations, project: ProjectRef, last_status_detail: JobStatus | None = None, job_item_id: UUID | None = None, job_item_integer_id: int | None = None, type: Literal['CompilationResultRef'] = 'CompilationResultRef', )[source]¶

Proxy object to the results of a circuit compilation in Nexus.

df() → DataFrame[source]¶: Present in a pandas DataFrame.

get_input() → CircuitRef[source]¶: Get the CircuitRef of the original circuit.

get_output() → CircuitRef[source]¶: Get the CircuitRef of the compiled circuit.

get_passes() → DataframableList[CompilationPassRef][source]¶: Get information on the compilation passes and the output circuits (if available).

class qnexus.models.references.CompilationPassRef( *, id: UUID, pass_name: str, input_circuit: CircuitRef, output_circuit: CircuitRef, type: Literal['CompilationPassRef'] = 'CompilationPassRef', )[source]¶

Proxy object to a compilation pass that was applied on a circuit in Nexus.

df() → DataFrame[source]¶: Present in a pandas DataFrame.

get_input() → CircuitRef[source]¶: Get the CircuitRef of the original circuit.

get_output() → CircuitRef[source]¶: Get the CircuitRef of the compiled circuit.

class qnexus.models.references.ExecuteJobRef( *, id: UUID, annotations: Annotations, job_type: JobType = JobType.EXECUTE, last_status: JobStatusEnum, last_message: str, last_status_detail: JobStatus | None = None, project: ProjectRef, system: SystemRef | None = None, backend_config_store: Annotated[AerConfig | AerStateConfig | AerUnitaryConfig | BraketConfig | QuantinuumConfig | IBMQConfig | IBMQEmulatorConfig | QulacsConfig | SeleneConfig | SelenePlusConfig | HeliosConfig, FieldInfo(annotation=NoneType, required=True, discriminator='type')] | None = None, type: Literal['ExecuteJobRef'] = 'ExecuteJobRef', )[source]¶

Proxy object to an ExecuteJob in Nexus.

df() → DataFrame¶: Present in a pandas DataFrame.

class qnexus.models.references.ExecutionResultRef( *, id: UUID, annotations: Annotations, project: ProjectRef, result_type: ResultType = ResultType.PYTKET, cost: float | None = None, last_status_detail: JobStatus | None = None, job_item_id: UUID | None = None, job_item_integer_id: int | None = None, type: Literal['ExecutionResultRef'] = 'ExecutionResultRef', )[source]¶

Proxy object to the results of a circuit execution through Nexus.

df() → DataFrame[source]¶: Present in a pandas DataFrame.

download_backend_info() → BackendInfo[source]¶: Get a copy of the pytket BackendInfo.

download_result( version: ResultVersions = ResultVersions.DEFAULT, ) → QsysResult | BackendResult | QIRResult[source]¶: Get a copy of the result of the program execution.

get_input() → CircuitRef | HUGRRef | QIRRef[source]¶: Get the Program Ref of the input program.

class qnexus.jobs.JobRef( *, id: UUID, annotations: Annotations, job_type: JobType, last_status: JobStatusEnum, last_message: str, last_status_detail: JobStatus | None = None, project: ProjectRef, system: SystemRef | None = None, backend_config_store: Annotated[AerConfig | AerStateConfig | AerUnitaryConfig | BraketConfig | QuantinuumConfig | IBMQConfig | IBMQEmulatorConfig | QulacsConfig | SeleneConfig | SelenePlusConfig | HeliosConfig, FieldInfo(annotation=NoneType, required=True, discriminator='type')] | None = None, type: Literal['JobRef', 'CompileJobRef', 'ExecuteJobRef'] = 'JobRef', )[source]¶

Proxy object to a Job in Nexus.

df() → DataFrame[source]¶: Present in a pandas DataFrame.

class qnexus.models.references.IncompleteJobItemRef( *, id: UUID = UUID('00000000-0000-0000-0000-000000000000'), annotations: Annotations, job_item_id: UUID | None = None, job_item_integer_id: int | None = None, program_type: ProgramType = ProgramType.CIRCUIT, program_id: UUID | None = None, project: ProjectRef, job_type: JobType, last_status: JobStatusEnum, last_message: str, last_status_detail: JobStatus | None = None, type: Literal['IncompleteJobItemRef'] = 'IncompleteJobItemRef', )[source]¶

Proxy object to a Job Item in Nexus that is not complete.

df() → DataFrame[source]¶: Present in a pandas DataFrame.

class qnexus.projects.ProjectRef( *, id: UUID, annotations: Annotations, contents_modified: datetime, archived: bool = False, type: Literal['ProjectRef'] = 'ProjectRef', )[source]¶

Proxy object to a Project in Nexus.

df() → DataFrame[source]¶: Present in a pandas DataFrame.

class qnexus.teams.TeamRef( *, id: UUID, name: str, description: str | None, type: Literal['TeamRef'] = 'TeamRef', )[source]¶

Proxy object to a Team in Nexus.

df() → DataFrame[source]¶: Present in a pandas DataFrame.

class qnexus.users.UserRef( *, id: UUID, display_name: str | None, type: Literal['UserRef'] = 'UserRef', )[source]¶

Proxy object to a User in Nexus.

df() → DataFrame[source]¶: Present in a pandas DataFrame.

class qnexus.wasm_modules.WasmModuleRef( *, id: UUID, annotations: Annotations, project: ProjectRef, type: Literal['WasmModuleRef'] = 'WasmModuleRef', )[source]¶

Proxy object to a WasmModule in Nexus.

df() → DataFrame[source]¶: Present in a pandas DataFrame.

download_wasm_contents() → WasmModuleHandler[source]¶: Get the contents of the original uploaded WASM.

class qnexus.qir.QIRRef( *, id: UUID, annotations: Annotations, project: ProjectRef, type: Literal['QIRRef'] = 'QIRRef', )[source]¶

Proxy object to a QIR program in Nexus.

df() → DataFrame[source]¶: Present in a pandas DataFrame.

download_qir() → bytes[source]¶: Get the QIR program.

class qnexus.hugr.HUGRRef( *, id: UUID, annotations: Annotations, project: ProjectRef, type: Literal['HUGRRef'] = 'HUGRRef', )[source]¶

Proxy object to a HUGR in Nexus.

df() → DataFrame[source]¶: Present in a pandas DataFrame.

download_hugr() → Package[source]¶: Get the HUGR Package of the original uploaded HUGR.

download_hugr_bytes() → bytes[source]¶: Get the HUGR bytes of the original uploaded HUGR.

class qnexus.gpu_decoder_configs.GpuDecoderConfigRef( *, id: UUID, annotations: Annotations, project: ProjectRef, type: Literal['GpuDecoderConfigRef'] = 'GpuDecoderConfigRef', )[source]¶

Proxy object to a GpuDecoderConfig in Nexus.

df() → DataFrame[source]¶: Present in a pandas DataFrame.

download_gpu_decoder_config_contents() → str[source]¶: Get the contents of the original uploaded gpu decoder config.

class qnexus.models.references.SystemRef( *, id: UUID, name: str, provider_name: str, type: Literal['SystemRef'] = 'SystemRef', )[source]¶

Proxy object to a System in Nexus.

df() → DataFrame[source]¶: Present in a pandas DataFrame.