Skip to content

Commit 475abc1

Browse files
authored
License updates (#360)
Signed-off-by: Ben Howe <[email protected]>
1 parent 815d933 commit 475abc1

File tree

18 files changed

+159
-16
lines changed

18 files changed

+159
-16
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,9 @@ apps/
9898
# vim files
9999
*.tmp
100100

101+
# Wheel files
102+
*.whl
103+
101104
# Temporary build files for metapackages
102105
libs/*/python/metapackages/LICENSE
103106
libs/*/python/metapackages/NOTICE

README.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,37 @@
11
# Welcome to the CUDA-QX repository
22

3-
This repository contains a set of libraries that build on
4-
NVIDIA CUDA-Q. These libraries enable the rapid development of hybrid quantum-classical
5-
application code leveraging state-of-the-art CPUs, GPUs, and QPUs.
3+
This repository contains a set of libraries that build on
4+
NVIDIA CUDA-Q. These libraries enable the rapid development of hybrid quantum-classical
5+
application code leveraging state-of-the-art CPUs, GPUs, and QPUs.
66

77
## Getting Started
8-
To learn more about how to work with the CUDA-QX libraries, please take a look at the
9-
[CUDA-QX Documentation][cudaqx_docs]. The page contains detailed
10-
[installation instructions][official_install] for officially released packages.
8+
9+
To learn more about how to work with the CUDA-QX libraries, please take a look at the
10+
[CUDA-QX Documentation][cudaqx_docs]. The page contains detailed
11+
[installation instructions][official_install] for officially released packages.
1112

1213
[cudaqx_docs]: https://nvidia.github.io/cudaqx
1314
[official_install]: https://nvidia.github.io/cudaqx/quickstart/installation.html
1415

1516
## Contributing
1617

1718
There are many ways in which you can get involved with CUDA-QX. If you are
18-
interested in developing quantum applications with the CUDA-QX libraries,
19-
this repository is a great place to get started! For more information about
20-
contributing to the CUDA-QX platform, please take a look at
19+
interested in developing quantum applications with the CUDA-QX libraries,
20+
this repository is a great place to get started! For more information about
21+
contributing to the CUDA-QX platform, please take a look at
2122
[Contributing.md](./Contributing.md).
2223

2324
## License
2425

2526
The code in this repository is licensed under [Apache License 2.0](./LICENSE).
2627

28+
When distributed via PyPI, GHCR, or NGC, the binaries generated from this source
29+
code are also distributed under the Apache License 2.0; however, the
30+
`libcudaq-qec-nv-qldpc-decoder.so` library is closed source and is subject to
31+
the [NVIDIA Software License Agreement][github_qec_license]
32+
33+
[github_qec_license]: https://github.com/NVIDIA/cudaqx/blob/main/libs/qec/LICENSE
34+
2735
Contributing a pull request to this repository requires accepting the
2836
Contributor License Agreement (CLA) declaring that you have the right to, and
2937
actually do, grant us the rights to use your contribution. A CLA-bot will

libs/qec/CITATION.cff

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../CITATION.cff

libs/qec/LICENSE

Lines changed: 95 additions & 0 deletions
Large diffs are not rendered by default.

libs/qec/NOTICE

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../NOTICE

libs/qec/README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,12 @@ not require a GPU to use, but some components are GPU-accelerated.
1717
- Real-time decoding capabilities for quantum feedback
1818
- Integration with CUDA-Q quantum program execution
1919

20-
Note: if you would like to use our Tensor Network Decoder, you will need
21-
additional dependencies installed. You can install them with
22-
`pip install cudaq-qec[tensor-network-decoder]`.
20+
## Optional Dependencies
21+
22+
Some decoders require additional dependencies to operate. You can install them with
23+
24+
- `pip install cudaq-qec[tensor-network-decoder]` for the Tensor Network Decoder
25+
- `pip install cudaq-qec[trt-decoder]` for the TensorRT Decoder
2326

2427
## Getting Started
2528

@@ -28,8 +31,12 @@ For detailed documentation, tutorials, and API reference, visit the
2831

2932
## License
3033

31-
CUDA-Q QEC is an open source project. The source code is available on
34+
Most components of CUDA-Q QEC are open source. The source code is available on
3235
[GitHub][github_link] and licensed under [Apache License
3336
2.0](https://github.com/NVIDIA/cudaqx/blob/main/LICENSE).
3437

38+
The `libcudaq-qec-nv-qldpc-decoder.so` library (distributed with CUDA-Q QEC) is
39+
closed source and is subject to the [NVIDIA Software License Agreement][github_qec_license]
40+
3541
[github_link]: https://github.com/NVIDIA/cudaqx/tree/main/libs/qec
42+
[github_qec_license]: https://github.com/NVIDIA/cudaqx/blob/main/libs/qec/LICENSE

libs/qec/pyproject.toml.cu12

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ authors = [{name = "NVIDIA Corporation & Affiliates"}]
1010
maintainers = [{name = "NVIDIA Corporation & Affiliates"}]
1111
requires-python = ">=3.11"
1212
readme = "README.md"
13+
license = "LicenseRef-NVIDIA-Proprietary"
1314
dependencies = [
1415
'cuda-quantum-cu12 >= 0.13',
1516
]
@@ -41,6 +42,7 @@ cmake.version = ">=3.28"
4142
cmake.build-type = "Release"
4243
install.components = ["qec-python", "qec-lib", "qec-lib-plugins"]
4344
wheel.packages = []
45+
wheel.license-files = [ "LICENSE", "NOTICE", "CITATION.cff" ]
4446
logging.level = "DEBUG"
4547
ninja.version = ">=1.10"
4648

libs/qec/pyproject.toml.cu13

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ authors = [{name = "NVIDIA Corporation & Affiliates"}]
1010
maintainers = [{name = "NVIDIA Corporation & Affiliates"}]
1111
requires-python = ">=3.11"
1212
readme = "README.md"
13+
license = "LicenseRef-NVIDIA-Proprietary"
1314
dependencies = [
1415
'cuda-quantum-cu13 >= 0.13',
1516
]
@@ -41,6 +42,7 @@ cmake.version = ">=3.28"
4142
cmake.build-type = "Release"
4243
install.components = ["qec-python", "qec-lib", "qec-lib-plugins"]
4344
wheel.packages = []
45+
wheel.license-files = [ "LICENSE", "NOTICE", "CITATION.cff" ]
4446
logging.level = "DEBUG"
4547
ninja.version = ">=1.10"
4648

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,5 @@
11
include pyproject.toml.cu12
22
include pyproject.toml.cu13
3+
include LICENSE
4+
include NOTICE
5+
include CITATION.cff

libs/qec/python/metapackages/pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ description = "Accelerated libraries for Quantum Error Correction built on CUDA-
1414
authors = [{name = "NVIDIA Corporation & Affiliates"}]
1515
maintainers = [{name = "NVIDIA Corporation & Affiliates"}]
1616
readme = "README.md"
17+
license = "LicenseRef-NVIDIA-Proprietary"
1718
requires-python = ">=3.11"
1819
license-files = [ "LICENSE", "NOTICE", "CITATION.cff" ]
1920
classifiers = [

0 commit comments

Comments
 (0)