Skip to content

Commit

Permalink
feat(rust)!: rename crate to hugr (#914)
Browse files Browse the repository at this point in the history
BREAKING CHANGE: crate renamed from `quantinuum-hugr` to `hugr`
  • Loading branch information
aborgna-q authored Apr 3, 2024
1 parent 9fe65db commit 0565fee
Show file tree
Hide file tree
Showing 99 changed files with 17 additions and 19 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci-rs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ jobs:
with:
filters: |
rust:
- 'quantinuum-hugr/**'
- 'hugr/**'
- 'Cargo.toml'
- 'specification/schema/**'
Expand Down
4 changes: 2 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ lto = "thin"

[workspace]
resolver = "2"
members = ["quantinuum-hugr"]
default-members = ["quantinuum-hugr"]
members = ["hugr"]
default-members = ["hugr"]

[workspace.package]
rust-version = "1.75"
Expand Down
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
quantinuum-hugr
hugr
===============

[![build_status][]](https://github.com/CQCL/hugr/actions)
[![crates][]](https://crates.io/crates/quantinuum-hugr)
[![crates][]](https://crates.io/crates/hugr)
[![msrv][]](https://github.com/CQCL/hugr)
[![codecov][]](https://codecov.io/gh/CQCL/hugr)

Expand All @@ -20,11 +20,9 @@ The HUGR specification is [here](https://github.com/CQCL/hugr/blob/main/specific
Add the dependency to your project:

```bash
cargo add quantinuum-hugr
cargo add hugr
```

The library crate is called `hugr`.

Please read the [API documentation here][].

## Experimental Features
Expand All @@ -47,10 +45,10 @@ See [DEVELOPMENT.md](https://github.com/CQCL/hugr/blob/main/DEVELOPMENT.md) for

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/quantinuum-hugr/
[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/quantinuum-hugr
[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/CHANGELOG.md
2 changes: 1 addition & 1 deletion quantinuum-hugr/Cargo.toml → hugr/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[package]
name = "quantinuum-hugr"
name = "hugr"
version = "0.2.0"
edition = { workspace = true }
rust-version = { workspace = true }
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
source: quantinuum-hugr/src/hugr/views/tests.rs
source: hugr/src/hugr/views/tests.rs
expression: h.dot_string()
---
digraph {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
source: quantinuum-hugr/src/hugr/views/tests.rs
source: hugr/views/tests.rs
expression: h.dot_string()
---
digraph {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
source: quantinuum-hugr/src/hugr/views/tests.rs
source: hugr/src/hugr/views/tests.rs
expression: h.dot_string()
---
digraph {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
source: quantinuum-hugr/src/hugr/views/tests.rs
source: hugr/src/hugr/views/tests.rs
expression: h.mermaid_string()
---
graph LR
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
source: quantinuum-hugr/src/hugr/views/tests.rs
source: hugr/src/hugr/views/tests.rs
expression: h.mermaid_string()
---
graph LR
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion release-plz.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ changelog_config = "cliff.toml" # use a custom git-cliff configuration
changelog_update = false

[[package]]
name = "quantinuum-hugr"
name = "hugr"
# enable the changelog for this package
changelog_update = true
# set the path of the changelog to the root of the repository
Expand Down
4 changes: 2 additions & 2 deletions specification/hugr.md
Original file line number Diff line number Diff line change
Expand Up @@ -1601,9 +1601,9 @@ list than those children, and `Input` nodes should appear before their matching

## Architecture

The HUGR is implemented as a Rust crate named `quantinuum-hugr`. This
The HUGR is implemented as a Rust crate named `hugr`. This
crate is intended to be a common dependency for all projects, and is published
at the [crates.io registry](https://crates.io/crates/quantinuum-hugr).
at the [crates.io registry](https://crates.io/crates/hugr).

The HUGR is represented internally using structures from the `portgraph`
crate. A base PortGraph is composed with hierarchy (as an alternate
Expand Down

0 comments on commit 0565fee

Please sign in to comment.