├── tests ├── __init__.py └── test_demo_name.py ├── requirements.txt ├── dwave_logo.png ├── .circleci └── config.yml ├── .github └── ISSUE_TEMPLATE │ └── contribute.md ├── demo_name.py ├── .devcontainer └── devcontainer.json ├── CONTRIBUTING.md ├── README.md └── LICENSE /tests/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | dwave-ocean-sdk>=3.0.0 2 | -------------------------------------------------------------------------------- /dwave_logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dwave-examples/template/HEAD/dwave_logo.png -------------------------------------------------------------------------------- /.circleci/config.yml: -------------------------------------------------------------------------------- 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 13 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/contribute.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Contribute 3 | about: Let us know you have an example you'd like to contribute. 4 | 5 | --- 6 | 7 | **Link to your repo** 8 | 9 | Include a link to the repo you want to contribute to dwave-examples. 10 | 11 | **Environment** 12 | - Operating system: [e.g., macOS 10.15] 13 | - Python version: [e.g., 3.9.0] 14 | 15 | **Additional information** 16 | 17 | Add any information that is not included in your example's README. 18 | 19 | Before submitting, we encourage you to take a look at our contribution 20 | guidelines: https://github.com/dwave-examples/template/blob/master/CONTRIBUTING.md. 21 | -------------------------------------------------------------------------------- /demo_name.py: -------------------------------------------------------------------------------- 1 | # Copyright [yyyy] [name of copyright owner] 2 | # 3 | # Licensed under the Apache License, Version 2.0 (the "License"); 4 | # you may not use this file except in compliance with the License. 5 | # You may obtain a copy of the License at 6 | # 7 | # http://www.apache.org/licenses/LICENSE-2.0 8 | # 9 | # Unless required by applicable law or agreed to in writing, software 10 | # distributed under the License is distributed on an "AS IS" BASIS, 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | # See the License for the specific language governing permissions and 13 | # limitations under the License. 14 | 15 | """ 16 | Things to do: 17 | - Please name this file .py 18 | - Fill in [yyyy] and [name of copyright owner] in the copyright (top line) 19 | - Add demo code below 20 | - Format code so that it conforms with PEP 8 21 | """ 22 | -------------------------------------------------------------------------------- /tests/test_demo_name.py: -------------------------------------------------------------------------------- 1 | # Copyright [yyyy] [name of copyright owner] 2 | # 3 | # Licensed under the Apache License, Version 2.0 (the "License"); 4 | # you may not use this file except in compliance with the License. 5 | # You may obtain a copy of the License at 6 | # 7 | # http://www.apache.org/licenses/LICENSE-2.0 8 | # 9 | # Unless required by applicable law or agreed to in writing, software 10 | # distributed under the License is distributed on an "AS IS" BASIS, 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | # See the License for the specific language governing permissions and 13 | # limitations under the License. 14 | 15 | """ 16 | Things to do: 17 | - Please name this file `test_.py` 18 | - Fill in [yyyy] and [name of copyright owner] in the copyright (top line) 19 | - Add unit tests for your demo 20 | - Add a smoke test (i.e. does the demo actually run?) 21 | - Format code so that it conforms with PEP 8 22 | """ 23 | -------------------------------------------------------------------------------- /.devcontainer/devcontainer.json: -------------------------------------------------------------------------------- 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 | } 52 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contribution Guidelines 2 | 3 | Thanks for your interest in contributing to dwave-examples! Before getting 4 | started, we encourage you to take a look at this document for some guidelines. 5 | 6 | ## What We're Looking For 7 | 8 | While we have a preference for application oriented examples, we welcome all 9 | examples that demonstrate use of Ocean tools. 10 | 11 | To see our categorized collection of examples, create a free acount on 12 | [Leap](https://cloud.dwavesys.com/leap/signup/) and take a look 13 | [here](https://cloud.dwavesys.com/leap/examples/). You can also find our existing 14 | examples by going through the repositories in 15 | [dwave-examples](https://github.com/dwave-examples). 16 | 17 | ## Steps for Contributing 18 | 19 | 1. Follow GitHub's instructions to [create 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 (or one of our existing examples) as a 21 | starting point from which to implement your example. 22 | 23 | 2. [Open an issue on the dwave-examples/template repository](https://github.com/dwave-examples/template/issues/new/choose) 24 | with a link to your example. 25 | 26 | 3. To add your example, D-Wave will fork your repository. We may make a pull 27 | request if we would like your approval for certain code changes. 28 | 29 | ## Guidelines 30 | 31 | ### Files 32 | 33 | Please make sure that your example includes the following: 34 | 35 | * `README.md`: 36 | * We prefer `.md` over `.rst`. 37 | * See this repository's [README](README.md). 38 | 39 | * `requirements.txt`: 40 | * `dwave-ocean-sdk` should be unpinned and lower bounded. 41 | 42 | * `LICENSE`: 43 | * Examples should comply with the Apache 2.0 License. Please make sure that: 44 | * All source and test files include a license header (as shown in 45 | [`demo_name.py`](demo_name.py)) 46 | * The [`LICENSE`](LICENSE) file is included in your root directory. 47 | 48 | * Tests that are discoverable through `python -m unittest discover`. 49 | 50 | Our examples are tested using CircleCI. For a list of operating systems and 51 | Python versions we currently test our examples with, please take a look at our 52 | documentation 53 | [here](https://docs.ocean.dwavesys.com/en/stable/overview/install.html). 54 | 55 | Feel free to copy the [`.circleci/`](.circleci/) directory into your example's root directory. 56 | Once approved, we will make sure that your example is set up on our CircleCI 57 | account. 58 | 59 | To ensure your example runs in [GitHub Codespaces](https://docs.github.com/en/codespaces/overview), 60 | copy the [`.devcontainer/`](.devcontainer/) directory into your example's root directory. 61 | 62 | ### Code 63 | 64 | We use the [PEP 8](https://www.python.org/dev/peps/pep-0008/) style guide as a baseline. 65 | 66 | If your example is lengthy, we encourage modularity for ease of testing. 67 | 68 | ### Documentation 69 | 70 | We use the [Google docstrings convention](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings). 71 | 72 | Take a look at our [How to Contribute](https://docs.ocean.dwavesys.com/en/latest/contributing.html#documentation-and-comments) 73 | guide for more details. 74 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | **Interested in contributing a code example?** 2 | 3 | Please take a look at our [contribution guidelines](CONTRIBUTING.md) before 4 | getting started. Thanks! 5 | 6 | 9 | 10 | # 11 | 12 | Describe your example and specify what it is demonstrating. Consider the 13 | following questions: 14 | 15 | * Is it pedagogical or a usable application? 16 | * Does it belong to a particular domain such as material simulation or logistics? 17 | * What level of Ocean proficiency does it target (beginner, advanced, pro)? 18 | 19 | A clear description allows us to properly categorize your example. 20 | 21 | Images are encouraged. If your example produces a visualization, consider 22 | displaying it here. 23 | 24 | ![D-Wave Logo](dwave_logo.png) 25 | 26 | ## Usage 27 | 28 | A simple command that runs your program. For example, 29 | 30 | ```bash 31 | python .py 32 | ``` 33 | 34 | ### Inputs 35 | If your example requires user input, make sure to specify the input format and any input limitations. 36 | ### Outputs 37 | An example program output. 38 | 39 | ## Problem Description 40 | 41 | Objectives to be optimized: the goals the process attempts to accomplish by minimizing or maximizing certain aspects of the problem to the extent possible; for example, a production-line optimization might attempt to minimize the time to produce all of the products. 42 | 43 | Constraints: aspects of the problem and/or process, with limited or no flexibility, that must be satisfied for solutions to be considered feasible; for example, a production-line optimization might have a limitation that Machine A can only bend 10 parts per hour. 44 | 45 | ## Model Overview 46 | The clearer your model is presented here, the more useful it will be to others. For a strong example of this section, see [here](https://github.com/dwave-examples/3d-bin-packing#model-overview). 47 | 48 | ### Parameters 49 | List and define the parameters used in your model. 50 | 51 | ### Variables 52 | List and define (including type: e.g., "binary" or "integer") the variables solved for in your model. 53 | 54 | ### Expressions 55 | List and define any combinations of variables used for easier representations of the models. 56 | 57 | ### Objective 58 | Mathematical formulation of the objective described in the previous section using the listed parameters, variables, etc. 59 | 60 | ### Constrains 61 | Mathematical formulation of the constraints described in the previous section using the listed parameters, variables, etc. 62 | 63 | ## Code Overview 64 | 65 | A general overview of how the code works. 66 | 67 | We prefer descriptions in bite-sized bullet points: 68 | 69 | * Here's an example bullet point 70 | 71 | ## Code Specifics 72 | 73 | Notable parts of the code implementation. 74 | 75 | This is the place to: 76 | 77 | * Highlight a part of the code implementation 78 | * Talk about unusual or potentially difficult parts of the code 79 | * Explain a code decision 80 | * Explain how parameters were tuned 81 | 82 | Note: there is no need to repeat everything that is already well-documented in 83 | the code. 84 | 85 | ## References 86 | 87 | A. Person, "Title of Amazing Information", [short link 88 | name](https://example.com/) 89 | 90 | ## License 91 | 92 | Released under the Apache License 2.0. See [LICENSE](LICENSE) file. 93 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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. 202 | --------------------------------------------------------------------------------