hugr-persistent 0.2.0

Persistent IR structure for Quantinuum's HUGR
Documentation

hugr-persistent

build_status crates msrv codecov

The Hierarchical Unified Graph Representation (HUGR, pronounced hugger) is the common representation of quantum circuits and operations in the Quantinuum ecosystem.

It provides a high-fidelity representation of operations, that facilitates compilation and encodes runnable programs.

The HUGR specification is here.

Overview

This crate provides a persistent data structure for HUGR mutations; mutations to the data are stored persistently as a set of Commits along with the dependencies between them.

As a result of persistency, the entire mutation history of a HUGR can be traversed and references to previous versions of the data remain valid even as the HUGR graph is "mutated" by applying patches: the patches are in effect added to the history as new commits.

Usage

Add the dependency to your project:

cargo add hugr-persistent

Please read the API documentation here.

Recent Changes

See CHANGELOG for a list of changes. The minimum supported rust version will only change on major releases.

Development

See DEVELOPMENT.md for instructions on setting up the development environment.

License

This project is licensed under Apache License, Version 2.0 (LICENSE or http://www.apache.org/licenses/LICENSE-2.0).