Skip to content

Commit 291a48e

Browse files
qctrlrobotqctrlrobot
authoredJul 30, 2024
Initial commit
0 parents  commit 291a48e

8 files changed

+462
-0
lines changed
 

‎.editorconfig

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# EditorConfig
2+
# https://editorconfig.org
3+
4+
root = true
5+
6+
[*]
7+
charset = utf-8
8+
end_of_line = lf
9+
indent_size = 2
10+
indent_style = space
11+
insert_final_newline = true
12+
trim_trailing_whitespace = true
13+
14+
[*.md]
15+
trim_trailing_whitespace = false
16+
17+
[*.py]
18+
indent_size = 4
19+
20+
[Makefile]
21+
indent_size = 1
22+
indent_style = tab

‎.github/README.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Q-CTRL Template
2+
3+
A good description is clear, short, and to the point. Describe the purpose of the project and what it does. Your README should contain only the necessary information for **developers** to get started **contributing** to your project.
4+
5+
## Installation
6+
7+
Describe how to install the project locally then **DELETE THIS LINE**. For example:
8+
9+
```shell
10+
git clone git@github.com:qctrl/[REPOSITORY].git
11+
cd [REPOSITORY]
12+
install...
13+
```
14+
15+
## Usage
16+
17+
Describe how to use the project after installation then **DELETE THIS LINE**. For example:
18+
19+
```shell
20+
run...
21+
```
22+
23+
## Contributing
24+
25+
See [Contributing](https://code.q-ctrl.com/contributing).
26+
27+
## Credits
28+
29+
Replace `[REPOSITORY]` in the URL below with the name of the repository then **DELETE THIS LINE**.
30+
31+
See [Contributors](https://github.com/qctrl/[REPOSITORY]/graphs/contributors).
32+
33+
## License
34+
35+
- If **Unlicensed:**
36+
- Delete this entire [License](#license) section.
37+
- **DELETE THIS LIST**.
38+
39+
See [LICENSE](https://github.com/qctrl/[REPOSITORY]/blob/master/LICENSE).

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.DS_Store

‎CODEOWNERS

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
##### This file is managed automatically. To update visit: https://github.com/qctrl/repositories-manager. #####
2+
* @qctrl/infrastructure
3+
4+
.dockerignore @qctrl/infrastructure
5+
.github/*.y*ml @qctrl/infrastructure
6+
.github/workflows @qctrl/infrastructure
7+
docker* @qctrl/infrastructure
8+
Docker* @qctrl/infrastructure
9+
10+
.github/dependabot.y*ml @qctrl/engineering

‎LICENSE

+174
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,174 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.

‎README.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Q-CTRL Template
2+
3+
A good description is clear, short, and to the point. Describe the purpose of the project and what it does. Your README should contain only the necessary information for **customers** to get started **using** your project.
4+
5+
## Version
6+
7+
This project follows the [Semantic Versioning](https://semver.org/) standard.

‎package.json

+88
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
# How to use this file
2+
# - Copy this file to the root of your repository
3+
# - Update the values as per the instructions in the comments (let's pretend JSON supports comments)
4+
# - Remove all comments
5+
# - Add any other fields required for your package
6+
#
7+
# More information
8+
# - https://code.q-ctrl.com/packaging#javascript
9+
# - https://docs.npmjs.com/configuring-npm/package-json
10+
11+
{
12+
# name: The "Install" name as defined in https://code.q-ctrl.com/naming-conventions/#packages
13+
"name": "@qctrl/template",
14+
15+
# version: The "Version" as defined in https://code.q-ctrl.com/releases#version
16+
"version": "1.2.3",
17+
18+
# description: The "Package" name as defined in https://code.q-ctrl.com/naming-conventions/#packages
19+
"description": "Q-CTRL Template",
20+
21+
# keywords: Add to this list as appropriate.
22+
"keywords": [
23+
"black opal",
24+
"boulder opal",
25+
"fire opal",
26+
"nisq",
27+
"open controls",
28+
"q control",
29+
"q ctrl",
30+
"q-control",
31+
"q-ctrl",
32+
"qcontrol",
33+
"qctrl",
34+
"quantum",
35+
"quantum algorithms",
36+
"quantum circuits",
37+
"quantum coding",
38+
"quantum coding software",
39+
"quantum computing",
40+
"quantum control",
41+
"quantum control software",
42+
"quantum control theory",
43+
"quantum engineering",
44+
"quantum error correction",
45+
"quantum firmware",
46+
"quantum fundamentals",
47+
"quantum sensing",
48+
"qubit",
49+
"qudit"
50+
],
51+
52+
# homepage: DO NOT EDIT
53+
"homepage": "https://q-ctrl.com",
54+
55+
# bugs: DO NOT EDIT
56+
"bugs": {
57+
"url" : "https://q-ctrl.com/contact",
58+
"email" : "support@q-ctrl.com"
59+
},
60+
61+
# license: The license as defined in https://code.q-ctrl.com/licensing
62+
# Commercial = "SEE LICENSE IN LICENSE"
63+
# Open source = "Apache-2.0"
64+
# Unlicensed = "UNLICENSED"
65+
"license": "Apache-2.0",
66+
67+
# author: DO NOT EDIT
68+
"author": {
69+
"name": "Q-CTRL",
70+
"email": "support@q-ctrl.com",
71+
"url": "https://q-ctrl.com"
72+
},
73+
74+
# main: DO NOT EDIT
75+
"main": "index.js",
76+
77+
# repository: A link to the public GitHub repository. Omit if the repository is private
78+
"repository": {
79+
"type": "git",
80+
"url": "git+https://github.com/qctrl/template.git"
81+
}
82+
83+
# engines: The minimum engine versions. Add to this list as appropriate.
84+
"engines": {
85+
"node": ">=18",
86+
"pnpm": ">=8.6.12"
87+
},
88+
}

‎pyproject.toml

+121
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
# How to use this file
2+
# - Copy this file to the root of your repository
3+
# - Update the values as per the instructions in the comments
4+
# - Remove all comments
5+
#
6+
# More information
7+
# - https://code.q-ctrl.com/packaging#python
8+
# - https://python-poetry.org/docs/pyproject/
9+
10+
[tool.poetry]
11+
12+
# name: The "Install" name as defined in https://code.q-ctrl.com/naming-conventions/#packages
13+
name = "qctrl-template"
14+
15+
# version: The "Version" as defined in https://code.q-ctrl.com/releases#version
16+
version = "1.2.3"
17+
18+
# description: The "Package" name as defined in https://code.q-ctrl.com/naming-conventions/#packages
19+
description = "Q-CTRL Template"
20+
21+
# license: The license as defined in https://code.q-ctrl.com/licensing
22+
# Commercial = "https://q-ctrl.com/terms"
23+
# Open source = "Apache-2.0"
24+
# Unlicensed = ""
25+
license = "Apache-2.0"
26+
27+
# authors: DO NOT EDIT
28+
authors = ["Q-CTRL <support@q-ctrl.com>"]
29+
30+
# maintainers: DO NOT EDIT
31+
maintainers = ["Q-CTRL <support@q-ctrl.com>"]
32+
33+
# readme: DO NOT EDIT - the README.md file as defined in https://github.com/qctrl/template/blob/master/README.md
34+
readme = "README.md"
35+
36+
# homepage: DO NOT EDIT
37+
homepage = "https://q-ctrl.com"
38+
39+
# repository: A link to the public GitHub repository. Remove it if the repository is private.
40+
repository = "https://github.com/qctrl/template"
41+
42+
# documentation: A link to the "User documentation" as defined in https://code.q-ctrl.com/documentation#user-documentation
43+
# Remove it if not needed.
44+
documentation = ""
45+
46+
# keywords: DO NOT EDIT
47+
keywords = [
48+
"black opal",
49+
"boulder opal",
50+
"fire opal",
51+
"nisq",
52+
"open controls",
53+
"q control",
54+
"q ctrl",
55+
"q-control",
56+
"q-ctrl",
57+
"qcontrol",
58+
"qctrl",
59+
"quantum",
60+
"quantum algorithms",
61+
"quantum circuits",
62+
"quantum coding",
63+
"quantum coding software",
64+
"quantum computing",
65+
"quantum control",
66+
"quantum control software",
67+
"quantum control theory",
68+
"quantum engineering",
69+
"quantum error correction",
70+
"quantum firmware",
71+
"quantum fundamentals",
72+
"quantum sensing",
73+
"qubit",
74+
"qudit"
75+
]
76+
77+
# classifiers: Do not edit, unless the package only supports a subset of Python versions.
78+
# In that case, remove unsupported versions from the classifiers.
79+
classifiers = [
80+
"Development Status :: 5 - Production/Stable",
81+
"Environment :: Console",
82+
"Intended Audience :: Developers",
83+
"Intended Audience :: Education",
84+
"Intended Audience :: Science/Research",
85+
"Natural Language :: English",
86+
"Operating System :: OS Independent",
87+
"Programming Language :: Python :: 3.9",
88+
"Programming Language :: Python :: 3.10",
89+
"Programming Language :: Python :: 3.11",
90+
"Programming Language :: Python :: 3.12",
91+
"Topic :: Internet :: WWW/HTTP",
92+
"Topic :: Scientific/Engineering :: Physics",
93+
"Topic :: Scientific/Engineering :: Visualization",
94+
"Topic :: Software Development :: Embedded Systems",
95+
"Topic :: System :: Distributed Computing"
96+
]
97+
98+
# packages: The "Import" name as defined in https://code.q-ctrl.com/naming-conventions
99+
packages = [
100+
{ include = "qctrltemplate" },
101+
]
102+
103+
# urls: DO NOT EDIT
104+
[tool.poetry.urls]
105+
LinkedIn = "https://www.linkedin.com/company/q-ctrl/"
106+
Facebook = "https://www.facebook.com/qctrl"
107+
X = "https://x.com/qctrlHQ"
108+
YouTube = "https://www.youtube.com/qctrl"
109+
GitHub = "https://github.com/qctrl"
110+
111+
# Uncomment the following 2 blocks if the package requires access to the Internal PyPI.
112+
# # Use the internal PyPI as the main source: DO NOT EDIT
113+
# [[tool.poetry.source]]
114+
# name = "Q-CTRL PyPI"
115+
# url = "https://pypi.q-ctrl.com/simple"
116+
# priority = "primary"
117+
118+
# # Use the public PyPI as the supplemental source: DO NOT EDIT
119+
# [[tool.poetry.source]]
120+
# name = "PyPI"
121+
# priority = "supplemental"

0 commit comments

Comments
 (0)
Please sign in to comment.