ionpulse_sequence_generator 2.4.1

No project description provided

Ionpulse Sequence Generator

This package provides a convenient API to create pulse sequences for the ionpulse application running on M-ACTION or QUENCH. It generates a dictionary which can be translated into JSON and sent to ionpulse as a string, generating a sequence of operations.

The sequence generator is meant to be used as a dependency of pycrystal, but can be used standalone.

To connect to to Ionpulse, you can use e.g. tiqi-zedboard for this.

Contributing

Contributions to the sequence generator are always welcome!

To contribute, please create a virtual environment to run the tests and formatting from:

uv sync

Then install the pre-commit hook for formatting your code using Ruff:

uv run pre-commit install

For VSCode you can also install the Ruff formatting extension.

As this package integrates with pycrystal, ionpulse and the ionpulse-sequence-visualizer, integration testing with these projects is important before contributions can be merged.

Integration tests with ionpulse-sequence-visualizer are currently performed automatically with a cross project pipeline.

For pycrystal and ionpulse integration tests have to be performed manually.

Installation

For standalone use we recommend installing with poetry:

    uv add ionpulse_sequence_generator @ git+ssh://[e-mail]:tiqi-projects/ionpulse_sequence_generator

For installation with pip use

    pip install [-e] git+ssh://[e-mail]:tiqi-projects/ionpulse_sequence_generator

with the -e flag to install in editable mode.