# {py:mod}`qcheff.models.spin_chain.utils`

```{py:module} qcheff.models.spin_chain.utils
```

```{autodoc2-docstring} qcheff.models.spin_chain.utils
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`DegenerateSpinChain <qcheff.models.spin_chain.utils.DegenerateSpinChain>`
  - ```{autodoc2-docstring} qcheff.models.spin_chain.utils.DegenerateSpinChain
    :summary:
    ```
````

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`create_degen_chain <qcheff.models.spin_chain.utils.create_degen_chain>`
  - ```{autodoc2-docstring} qcheff.models.spin_chain.utils.create_degen_chain
    :summary:
    ```
* - {py:obj}`embed_operator <qcheff.models.spin_chain.utils.embed_operator>`
  - ```{autodoc2-docstring} qcheff.models.spin_chain.utils.embed_operator
    :summary:
    ```
* - {py:obj}`QuTiP_level_labels <qcheff.models.spin_chain.utils.QuTiP_level_labels>`
  - ```{autodoc2-docstring} qcheff.models.spin_chain.utils.QuTiP_level_labels
    :summary:
    ```
* - {py:obj}`QuTiP_drift_ham_degen_chain <qcheff.models.spin_chain.utils.QuTiP_drift_ham_degen_chain>`
  - ```{autodoc2-docstring} qcheff.models.spin_chain.utils.QuTiP_drift_ham_degen_chain
    :summary:
    ```
* - {py:obj}`QuTiP_chain_prodstate <qcheff.models.spin_chain.utils.QuTiP_chain_prodstate>`
  - ```{autodoc2-docstring} qcheff.models.spin_chain.utils.QuTiP_chain_prodstate
    :summary:
    ```
* - {py:obj}`QuTiP_chain_prodstate_index <qcheff.models.spin_chain.utils.QuTiP_chain_prodstate_index>`
  - ```{autodoc2-docstring} qcheff.models.spin_chain.utils.QuTiP_chain_prodstate_index
    :summary:
    ```
* - {py:obj}`QuTiP_total_ham_degen_chain <qcheff.models.spin_chain.utils.QuTiP_total_ham_degen_chain>`
  - ```{autodoc2-docstring} qcheff.models.spin_chain.utils.QuTiP_total_ham_degen_chain
    :summary:
    ```
* - {py:obj}`simulate_chain_dynamics <qcheff.models.spin_chain.utils.simulate_chain_dynamics>`
  - ```{autodoc2-docstring} qcheff.models.spin_chain.utils.simulate_chain_dynamics
    :summary:
    ```
* - {py:obj}`setup_magnus_chain_example <qcheff.models.spin_chain.utils.setup_magnus_chain_example>`
  - ```{autodoc2-docstring} qcheff.models.spin_chain.utils.setup_magnus_chain_example
    :summary:
    ```
* - {py:obj}`state_transfer_infidelity <qcheff.models.spin_chain.utils.state_transfer_infidelity>`
  - ```{autodoc2-docstring} qcheff.models.spin_chain.utils.state_transfer_infidelity
    :summary:
    ```
````

### API

`````{py:class} DegenerateSpinChain
:canonical: qcheff.models.spin_chain.utils.DegenerateSpinChain

```{autodoc2-docstring} qcheff.models.spin_chain.utils.DegenerateSpinChain
```

````{py:attribute} chain_size
:canonical: qcheff.models.spin_chain.utils.DegenerateSpinChain.chain_size
:type: int
:value: >
   None

```{autodoc2-docstring} qcheff.models.spin_chain.utils.DegenerateSpinChain.chain_size
```

````

````{py:attribute} nearest_couping
:canonical: qcheff.models.spin_chain.utils.DegenerateSpinChain.nearest_couping
:type: float
:value: >
   None

```{autodoc2-docstring} qcheff.models.spin_chain.utils.DegenerateSpinChain.nearest_couping
```

````

````{py:attribute} next_nearest_couping
:canonical: qcheff.models.spin_chain.utils.DegenerateSpinChain.next_nearest_couping
:type: float
:value: >
   None

```{autodoc2-docstring} qcheff.models.spin_chain.utils.DegenerateSpinChain.next_nearest_couping
```

````

`````

````{py:function} create_degen_chain(N: int = 3, J: float = 0.05, g: float = 0.005)
:canonical: qcheff.models.spin_chain.utils.create_degen_chain

```{autodoc2-docstring} qcheff.models.spin_chain.utils.create_degen_chain
```
````

````{py:function} embed_operator(op: qutip.Qobj, pos: int, ntrunc: int, nsystems: int)
:canonical: qcheff.models.spin_chain.utils.embed_operator

```{autodoc2-docstring} qcheff.models.spin_chain.utils.embed_operator
```
````

````{py:function} QuTiP_level_labels(chain: qcheff.models.spin_chain.utils.DegenerateSpinChain)
:canonical: qcheff.models.spin_chain.utils.QuTiP_level_labels

```{autodoc2-docstring} qcheff.models.spin_chain.utils.QuTiP_level_labels
```
````

````{py:function} QuTiP_drift_ham_degen_chain(chain: qcheff.models.spin_chain.utils.DegenerateSpinChain)
:canonical: qcheff.models.spin_chain.utils.QuTiP_drift_ham_degen_chain

```{autodoc2-docstring} qcheff.models.spin_chain.utils.QuTiP_drift_ham_degen_chain
```
````

````{py:function} QuTiP_chain_prodstate(chain_size: int, state_label: tuple[int, ...])
:canonical: qcheff.models.spin_chain.utils.QuTiP_chain_prodstate

```{autodoc2-docstring} qcheff.models.spin_chain.utils.QuTiP_chain_prodstate
```
````

````{py:function} QuTiP_chain_prodstate_index(chain_size: int, state_index: int)
:canonical: qcheff.models.spin_chain.utils.QuTiP_chain_prodstate_index

```{autodoc2-docstring} qcheff.models.spin_chain.utils.QuTiP_chain_prodstate_index
```
````

````{py:function} QuTiP_total_ham_degen_chain(chain: qcheff.models.spin_chain.utils.DegenerateSpinChain, tlist: numpy.ndarray, xdrive: numpy.ndarray, ydrive: numpy.ndarray)
:canonical: qcheff.models.spin_chain.utils.QuTiP_total_ham_degen_chain

```{autodoc2-docstring} qcheff.models.spin_chain.utils.QuTiP_total_ham_degen_chain
```
````

````{py:function} simulate_chain_dynamics(chain: qcheff.models.spin_chain.utils.DegenerateSpinChain, tlist: numpy.ndarray, Hsim: qutip.Qobj | qutip.QobjEvo, psi0: qutip.Qobj, plot=None)
:canonical: qcheff.models.spin_chain.utils.simulate_chain_dynamics

```{autodoc2-docstring} qcheff.models.spin_chain.utils.simulate_chain_dynamics
```
````

````{py:function} setup_magnus_chain_example(pulse_coeffs: collections.abc.Sequence[float], **kwargs)
:canonical: qcheff.models.spin_chain.utils.setup_magnus_chain_example

```{autodoc2-docstring} qcheff.models.spin_chain.utils.setup_magnus_chain_example
```
````

````{py:function} state_transfer_infidelity(**kwargs)
:canonical: qcheff.models.spin_chain.utils.state_transfer_infidelity

```{autodoc2-docstring} qcheff.models.spin_chain.utils.state_transfer_infidelity
```
````