Installation¶

Installing with pip

    pip install spin-pulse

Installing the version directly from github

    git clone https://github.com/quobly-sw/SpinPulse.git
    cd spin-pulse
    pip install .

This installs the package and its dependencies.

Requirements

The core packages SpinPulse requires are:

python 3.11+
numpy
scipy
numba
tqdm
qiskit

Documentation toolchain

To build the API documentation locally:

    pip install .[docs]
    sphinx-build -b html docs/source docs/build/html

To update the notebooks visible in the documentation:

    export TQDM_DISABLE=1; for f in examples/*.py; do jupytext --to notebook --execute "$f" -o "docs/source/customapi/tutorials/$(basename "${f%.py}.ipynb")"; done

Verifying your installation

    from spin_pulse import HardwareSpecs, PulseSequence
    print("SpinPulse is correctly installed.")