Skip to content

CQCL/hugr

Repository files navigation

hugr

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.

Usage

Add the dependency to your project:

cargo add hugr

Please read the API documentation here.

Experimental Features

  • extension_inference: Experimental feature which allows automatic inference of extension usages and requirements in a HUGR and validation that extensions are correctly specified. Not enabled by default.
  • declarative: Experimental support for declaring extensions in YAML files, support is limited.

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).