circuits

Client API for circuits in Nexus.

qnexus.client.circuits.cost(
circuit_ref: CircuitRef,
n_shots: int,
backend_config: Annotated[AerConfig | AerStateConfig | AerUnitaryConfig | BraketConfig | QuantinuumConfig | IBMQConfig | IBMQEmulatorConfig | ProjectQConfig | QulacsConfig, FieldInfo(annotation=NoneType, required=True, discriminator='type')],
syntax_checker: str | None = None,
) → float | None

Calculate the cost (in HQC) of running a circuit for n_shots number of shots on a specific Quantinuum device.

qnexus.client.circuits.get(
*,
id: UUID | str | None = None,
name_like: str | None = None,
creator_email: list[str] | None = None,
project: ProjectRef | None = None,
properties: OrderedDict[str, bool | int | float | str] | None = None,
created_before: datetime | None = None,
created_after: datetime | None = datetime.datetime(2023, 1, 1, 0, 0),
modified_before: datetime | None = None,
modified_after: datetime | None = None,
sort_filters: list[SortFilterEnum] | None = None,
page_number: int | None = None,
page_size: int | None = None,
) → CircuitRef

Get a single circuit using filters. Throws an exception if the filters do not match exactly one object.

qnexus.client.circuits.get_all(
name_like: str | None = None,
creator_email: list[str] | None = None,
project: ProjectRef | None = None,
properties: OrderedDict[str, bool | int | float | str] | None = None,
created_before: datetime | None = None,
created_after: datetime | None = datetime.datetime(2023, 1, 1, 0, 0),
modified_before: datetime | None = None,
modified_after: datetime | None = None,
sort_filters: list[SortFilterEnum] | None = None,
page_number: int | None = None,
page_size: int | None = None,
) → NexusIterator[CircuitRef]

Get a NexusIterator over circuits with optional filters.

qnexus.client.circuits.update(
ref: CircuitRef,
name: str | None = None,
description: str | None = None,
properties: OrderedDict[str, bool | int | float | str] | None = None,
) → CircuitRef

Update the annotations on a CircuitRef.

qnexus.client.circuits.upload(
circuit: Circuit,
project: ProjectRef | None = None,
name: str | None = None,
description: str | None = None,
properties: OrderedDict[str, bool | int | float | str] | None = None,
) → CircuitRef

Upload a pytket Circuit to Nexus.

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

Proxy object to a Circuit in Nexus.

df() → DataFrame

Present in a pandas DataFrame.

download_circuit() → Circuit

Get a copy of the circuit as a pytket Circuit object.