compile

qnexus.compile(

programs: CircuitRef | list[CircuitRef],

backend_config: Annotated[AerConfig | AerStateConfig | AerUnitaryConfig | BraketConfig | QuantinuumConfig | IBMQConfig | IBMQEmulatorConfig | ProjectQConfig | QulacsConfig | SeleneQuestConfig | SeleneStimConfig | SeleneLeanConfig | SeleneCoinFlipConfig | SeleneClassicalReplayConfig, FieldInfo(annotation=NoneType, required=True, discriminator='type')],

name: str,

description: str = '',

project: ProjectRef | None = None,

properties: OrderedDict[str, bool | int | float | str] | None = None,

optimisation_level: int = 2,

credential_name: str | None = None,

user_group: str | None = None,

hypertket_config: HyperTketConfig | None = None,

timeout: float | None = 300.0,

) → DataframableList[CircuitRef]

Utility method to run a compile job on a program or programs and return a DataframableList of the compiled programs.

qnexus.start_compile_job(

programs: CircuitRef | list[CircuitRef],

backend_config: Annotated[AerConfig | AerStateConfig | AerUnitaryConfig | BraketConfig | QuantinuumConfig | IBMQConfig | IBMQEmulatorConfig | ProjectQConfig | QulacsConfig | SeleneQuestConfig | SeleneStimConfig | SeleneLeanConfig | SeleneCoinFlipConfig | SeleneClassicalReplayConfig, FieldInfo(annotation=NoneType, required=True, discriminator='type')],

name: str,

description: str = '',

project: ProjectRef | None = None,

properties: OrderedDict[str, bool | int | float | str] | None = None,

optimisation_level: int = 2,

credential_name: str | None = None,

user_group: str | None = None,

hypertket_config: HyperTketConfig | None = None,

skip_intermediate_circuits: bool = True,

) → CompileJobRef

Submit a compile job to be run in Nexus.

class qnexus.jobs.CompileJobRef(

*,

id: UUID,

annotations: Annotations,

job_type: JobType = JobType.COMPILE,

last_status: StatusEnum,

last_message: str,

project: ProjectRef,

backend_config_store: Annotated[AerConfig | AerStateConfig | AerUnitaryConfig | BraketConfig | QuantinuumConfig | IBMQConfig | IBMQEmulatorConfig | ProjectQConfig | QulacsConfig | SeleneQuestConfig | SeleneStimConfig | SeleneLeanConfig | SeleneCoinFlipConfig | SeleneClassicalReplayConfig, FieldInfo(annotation=NoneType, required=True, discriminator='type')] | None = None,

type: Literal['CompileJobRef'] = 'CompileJobRef',

)

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,

type: Literal['CompilationResultRef'] = 'CompilationResultRef',

)

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

df() → DataFrame

Present in a pandas DataFrame.

get_input() → CircuitRef

Get the CircuitRef of the original circuit.

get_output() → CircuitRef

Get the CircuitRef of the compiled circuit.

get_passes() → DataframableList[CompilationPassRef]

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',

)

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

df() → DataFrame

Present in a pandas DataFrame.

get_input() → CircuitRef

Get the CircuitRef of the original circuit.

get_output() → CircuitRef

Get the CircuitRef of the compiled circuit.

class quantinuum_schemas.models.hypertket_config.HyperTketConfig(

*,

rewrite_search_config: RewriteSearchConfig = RewriteSearchConfig(enable_rewrite_search=True),

qubit_reuse_config: QubitReuseConfig | None = None,

)

Configuration for HyperTKET compilation.