Skip to content

Commit 4053218

Browse files
thisacthisac
authored
Initial commit
0 parents  commit 4053218

24 files changed

Lines changed: 2234 additions & 0 deletions

‎.circleci/config.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
version: 2.1
2+
3+
orbs:
4+
dwave: dwave/orb-examples@2
5+
6+
workflows:
7+
version: 2.1
8+
tests:
9+
jobs:
10+
- dwave/test-linux
11+
- dwave/test-osx
12+
- dwave/test-win

‎.devcontainer/devcontainer.json‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
2+
// README at: https://github.com/devcontainers/templates/tree/main/src/debian
3+
{
4+
"name": "Ocean Development Environment",
5+
6+
// python 3.11 on debian, with latest Ocean and optional packages
7+
// source repo: https://github.com/dwavesystems/ocean-dev-docker
8+
"image": "docker.io/dwavesys/ocean-dev:latest",
9+
10+
// install repo pip requirements (only if present) on content update
11+
"updateContentCommand": "[ ! -r requirements.txt ] || pip install -r requirements.txt",
12+
13+
// forward/expose container services (relevant only when run locally)
14+
"forwardPorts": [
15+
// dwave-inspector web app
16+
18000, 18001, 18002, 18003, 18004,
17+
// OAuth connect redirect URIs
18+
36000, 36001, 36002, 36003, 36004
19+
],
20+
21+
"portsAttributes": {
22+
"18000-18004": {
23+
"label": "D-Wave Problem Inspector",
24+
"requireLocalPort": true
25+
},
26+
"36000-36004": {
27+
"label": "OAuth 2.0 authorization code redirect URI",
28+
"requireLocalPort": true
29+
}
30+
},
31+
32+
// Configure tool-specific properties.
33+
"customizations": {
34+
// Configure properties specific to VS Code.
35+
"vscode": {
36+
// Set *default* container specific settings.json values on container create.
37+
"settings": {
38+
"workbench": {
39+
"editorAssociations": {
40+
"*.md": "vscode.markdown.preview.editor"
41+
},
42+
"startupEditor": "readme"
43+
}
44+
},
45+
"extensions": [
46+
"ms-python.python",
47+
"ms-toolsai.jupyter"
48+
]
49+
}
50+
}
51+
}

‎.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
*.DS_Store
2+
__pycache__
3+
cache
4+
assets/__generated_theme.css

‎CONTRIBUTING.md‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
# Contribution Guidelines
2+
3+
Thank you for your interest in contributing to [dwave-examples](https://github.com/dwave-examples)!
4+
Before getting started, we encourage you to take a look at the following guidelines.
5+
6+
## What We're Looking For
7+
8+
While we have a preference for application-oriented examples, we welcome all examples that
9+
demonstrate use of Ocean™ SDK tools.
10+
11+
To see examples of what we are looking for, you can view our existing demos by either creating a
12+
free account on the [Leap™ Quantum Cloud Service](https://cloud.dwavesys.com/leap/signup/)
13+
and browsing our categorized [library of examples](https://cloud.dwavesys.com/leap/examples/) or by
14+
reading through the demo code repositories in [dwave-examples](https://github.com/dwave-examples).
15+
16+
## Steps for Contributing
17+
18+
1. Follow GitHub's instructions for
19+
[creating a repository from a template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template).
20+
Alternatively, clone this repository as a starting point from which to implement your example.
21+
22+
2. Implement your example by following these instructions:
23+
24+
1. It is preferable for you to write all Python and CSS code in either new files or files that
25+
contain `demo` in the name. Below is a list of `demo` files and their functionality:
26+
27+
* [demo_callbacks.py](demo_callbacks.py) contains all the
28+
[Dash callback functions](https://dash.plotly.com/basic-callbacks) required to run the
29+
Dash app. Updates to existing callbacks and new callbacks should be made in this file.
30+
* [demo_interface.py](demo_interface.py) contains all the Dash HTML components that
31+
generate the user interface (UI) for the app, including settings like sliders,
32+
checkboxes, and text inputs, as well as buttons and tables. If a Dash HTML component
33+
needs to be dynamically added to the UI by a Dash callback in `demo_callbacks.py`, it
34+
is encouraged to add a function generating this component to `demo_interface.py` and
35+
call this function from `demo_callbacks.py`.
36+
* [demo_configs.py](demo_configs.py) contains all configurations and settings for the
37+
demo and is intended as a quick way to customize the demo for a specific audience or
38+
use case. Add variables to this file that users may want to change; for example, titles
39+
and default settings values but not evergreen labels or internal variables.
40+
* [demo.css](assets/demo.css) contains all custom CSS styling for the demo; any new CSS rules
41+
should be added here or in a new file in the `/assets/` directory. Dash reads all
42+
files in `/assets/` in alphabetical order so, out of the provided CSS files, `demo.css`
43+
runs last and can overwrite previous styling rules.
44+
* [__demo_variables.css](assets/__demo_variables.css) contains all CSS variables.
45+
It is encouraged to edit or add more CSS variables here.
46+
* [demo_enums.py](src/demo_enums.py) contains [Enum](https://docs.python.org/3/library/enum.html)
47+
classes for any settings or variables that are being used frequently to avoid string
48+
comparisons or other fragile code practices.
49+
50+
2. All new files should be added to one of the following directories:
51+
* `/assets/` is a Dash-specific directory that must not contain subdirectories and must
52+
not be renamed. Dash always reads files in this directory in alphabetical order and
53+
therefore you do not need to explicitly import files from this directory. Avoid altering
54+
CSS files with the word `demo` in the filename.
55+
* `/src/` should contain all functional code for the demo including solver implementations,
56+
class definitions, etc. You can add subdirectories as needed.
57+
* `/static/` should contain all new static files such as images. You can add subdirectories
58+
as needed.
59+
* `/tests/` should contain tests for all code found in `/src/`. All tests should be
60+
discoverable through `python -m unittest discover`.
61+
62+
3. Follow the [README template](README.md) to create a README that describes your example and
63+
outlines how it works.
64+
65+
3. Once your example has been implemented,
66+
[open an issue](https://github.com/dwave-examples/template-dash/issues/new/choose) in the
67+
[dwave-examples/template-dash](https://github.com/dwave-examples/template-dash) repository
68+
with a link to your example.
69+
70+
When adding a contributed example, D-Wave forks your repository and may make a pull
71+
request to get your approval for certain code changes.
72+
73+
## Final Checklist
74+
75+
- [ ] **PEP 8**: All code follows the [PEP 8](https://www.python.org/dev/peps/pep-0008/) style guide.
76+
If you are unsure, install and run [black](https://pypi.org/project/black/) to ensure correct formatting.
77+
78+
- [ ] **Docstrings**: All functions contain docstrings describing what the function does and any
79+
arguments or return values. For more information, see the
80+
[Google docstrings convention](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings).
81+
82+
- [ ] **README**: The demo contains an updated `README.md` file that follows the
83+
[README template](README.md) and is written in Markdown.
84+
85+
- [ ] **Requirements**: All requirements for running the demo have been listed in `requirements.txt`
86+
and are either pinned to a version supported by the latest Ocean SDK release or lower bounded.
87+
`dwave-ocean-sdk` is unpinned and lower bounded.
88+
89+
- [ ] **LICENSE**: The demo complies with the Apache 2.0 License and the [`LICENSE`](LICENSE) file
90+
is included in the root directory. All files include a license header.
91+
92+
- [ ] **Tests**: All code included in the `/src/` directory has associated tests that are located in
93+
`/tests/` and discoverable through `python -m unittest discover`.
94+
95+
- [ ] **Codespaces**: The [`.devcontainer/`](.devcontainer/) directory is included in the demo's
96+
root directory to ensure the demo runs in
97+
[GitHub Codespaces](https://docs.github.com/en/codespaces/overview).
98+
99+
- [ ] **CircleCI**: The demo contains the [`.circleci/`](.circleci/) directory to support running
100+
tests in CI. Once approved, we will make sure that your example is set up on our CircleCI account.
101+
102+
> [!NOTE]\
103+
> Our examples are tested using CircleCI. For a list of operating systems and
104+
Python versions we currently test our examples with, please take a look at [our
105+
documentation](https://docs.ocean.dwavesys.com/en/stable/overview/install.html).
106+
For more information, visit [orb-examples](https://circleci.com/developer/orbs/orb/dwave/orb-examples).
107+
108+
---
109+
110+
For more information about contributing, take a look at our
111+
[How to Contribute](https://docs.ocean.dwavesys.com/en/latest/contributing.html#documentation-and-comments)
112+
guide.

‎LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
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.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

0 commit comments

Comments
 (0)