default_rotating_frame

default_rotating_frame(model, electron_spin_name='e', electron_spin_state='1', nuclear_spin_state='avg')

Set the rotating frame frequencies for all spins in the model.

The rotating frame frequency of the electron spin is set to its qubit splitting, either:

• averaged over all nuclear spin configurations (if nuclear_spin_state == 'avg'), or

• conditioned on the nuclear spin qubit(s) state(s) ('0' or '1').

The rotating frame frequencies of all nuclear spins are set to their respective qubit splittings, assuming the electron spin is in the qubit state '0' or '1', and:

• averaged over all other nuclear spins (if nuclear_spin_state == 'avg'), or

• conditioned on the nuclear qubit state '0' or '1' for the remaining nuclear spins.

Parameters:

• model (Model) – The model to which the rotating frame frequencies are assigned.

• electron_spin_name (str) – The name of the electron spin in the model.

• electron_spin_state (str) – '0' or '1', specifying the electron qubit state to condition on.

• nuclear_spin_state (str) – '0', '1', or 'avg' — how to treat nuclear spin states when conditioning.

Return type:

Model

Returns:

The updated model with the assigned rotating frame frequencies.

Raises:

SimphonyError – If electron_spin_state or nuclear_spin_state is invalid.