https://github.com/cqcl/hugr

Hierarchical Unified Graph Representation for quantum and classical programs
https://github.com/cqcl/hugr

compiler intermediate-representation quantinuum quantum-computing

Last synced: 9 days ago
JSON representation

Hierarchical Unified Graph Representation for quantum and classical programs

• Host: GitHub
• URL: https://github.com/cqcl/hugr
• Owner: CQCL
• License: apache-2.0
• Created: 2023-03-16T10:37:28.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-11T23:58:23.000Z (about 1 month ago)
• Last Synced: 2024-11-12T09:05:10.688Z (about 1 month ago)
• Topics: compiler, intermediate-representation, quantinuum, quantum-computing
• Language: Rust
• Homepage: https://crates.io/crates/hugr
• Size: 6.05 MB
• Stars: 24
• Watchers: 9
• Forks: 6
• Open Issues: 141
• Metadata Files:
  • Readme: README.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
![](/hugr/assets/hugr_logo.svg)

hugr

===============

[![build_status][]](https://github.com/CQCL/hugr/actions)

[![crates][]](https://crates.io/crates/hugr)

[![msrv][]](https://github.com/CQCL/hugr)

[![codecov][]](https://codecov.io/gh/CQCL/hugr)

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](https://github.com/CQCL/hugr/blob/main/specification/hugr.md).

## Usage

Add the dependency to your project:

```bash

cargo add hugr

```

Please read the [API documentation here][].

## Experimental Features

- `extension_inference`:

  Experimental feature which allows automatic inference of which extra extensions

  are required at runtime by a HUGR when validating it.

  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](https://github.com/CQCL/hugr/blob/main/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).

  [API documentation here]: https://docs.rs/hugr/

  [build_status]: https://github.com/CQCL/hugr/actions/workflows/ci-rs.yml/badge.svg?branch=main

  [msrv]: https://img.shields.io/badge/rust-1.75.0%2B-blue.svg

  [crates]: https://img.shields.io/crates/v/hugr

  [codecov]: https://img.shields.io/codecov/c/gh/CQCL/hugr?logo=codecov

  [LICENSE]: https://github.com/CQCL/hugr/blob/main/LICENCE

  [CHANGELOG]: https://github.com/CQCL/hugr/blob/main/hugr/CHANGELOG.md