1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
|
%global _empty_manifest_terminate_build 0
Name: python-amazon-braket-ocean-plugin
Version: 1.0.11
Release: 1
Summary: An open source framework for interacting with D-Wave's Ocean library through Amazon Braket
License: Apache License 2.0
URL: https://github.com/aws/amazon-braket-ocean-plugin-python
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/f8/c1/5f27030414b09cf9a7df75463de42f80e6e266ece1b188dea05ea9fd118b/amazon-braket-ocean-plugin-1.0.11.tar.gz
BuildArch: noarch
Requires: python3-amazon-braket-sdk
Requires: python3-boto3
Requires: python3-boltons
Requires: python3-colorama
Requires: python3-dimod
Requires: python3-dwave-cloud-client
Requires: python3-jsonref
Requires: python3-wheel
Requires: python3-black
Requires: python3-flake8
Requires: python3-isort
Requires: python3-pre-commit
Requires: python3-pylint
Requires: python3-pytest
Requires: python3-pytest-cov
Requires: python3-pytest-rerunfailures
Requires: python3-pytest-xdist
Requires: python3-sphinx
Requires: python3-sphinx-rtd-theme
Requires: python3-sphinxcontrib-apidoc
Requires: python3-tox
Requires: python3-dwave-ocean-sdk
%description
# Amazon Braket Ocean Plugin
[](https://pypi.python.org/pypi/amazon-braket-ocean-plugin)
[](https://pypi.python.org/pypi/amazon-braket-ocean-plugin)
[](https://github.com/aws/amazon-braket-ocean-plugin-python/actions?query=workflow%3A%22Python+package%22)
[](https://codecov.io/gh/aws/amazon-braket-ocean-plugin-python)
[](https://amazon-braket-ocean-plugin-python.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/psf/black)
The Amazon Braket Ocean Plugin is an open source library in Python that provides a framework that you can use to interact with Ocean tools on top of Amazon Braket.
## Prerequisites
Before you begin working with the Amazon Braket Ocean Plugin, make sure that you've installed or configured the following prerequisites.
### Python 3.7.2 or greater
Download and install Python 3.7.2 or greater from [Python.org](https://www.python.org/downloads/).
If you are using Windows, choose **Add Python to environment variables** before you begin the installation.
### Amazon Braket SDK
Make sure that your AWS account is onboarded to Amazon Braket, as per the instructions in the [README](https://github.com/aws/amazon-braket-sdk-python#prerequisites).
### Ocean tools
Download and install [Ocean tools](https://docs.ocean.dwavesys.com/en/latest/overview/install.html).
```bash
pip install dwave-ocean-sdk
```
## Install the Amazon Braket Ocean Plugin
The Amazon Braket Ocean Plugin can be installed with pip as follows:
```bash
pip install amazon-braket-ocean-plugin
```
You can also install from source by cloning this repository and running a pip install command in the root directory of the repository:
```bash
git clone https://github.com/aws/amazon-braket-ocean-plugin-python.git
cd amazon-braket-ocean-plugin-python
pip install .
```
You can check your currently installed version of `amazon-braket-ocean-plugin` with `pip show`:
```bash
pip show amazon-braket-ocean-plugin
```
or alternatively from within Python:
```
>>> from braket import ocean_plugin
>>> ocean_plugin.__version__
```
## Documentation
Detailed documentation, including the API reference, can be found on [Read the Docs](https://amazon-braket-ocean-plugin-python.readthedocs.io/en/latest/).
**To generate the API Reference HTML in your local environment**
First, you must have tox installed.
```bash
pip install tox
```
Then, you can run the following command with tox to generate the documentation:
```bash
tox -e docs
```
To view the generated documentation, open the following file in a browser:
`BRAKET_OCEAN_PLUGIN_ROOT/build/documentation/html/index.html`
## Usage
This package provides samplers which use Braket solvers. These samplers extend abstract base classes provided in Ocean's dimod and thus have the same interfaces as other samplers in Ocean.
`BraketSampler` is a structured sampler that uses Braket-formatted parameters and properties. For example, instead of `answer_mode`, which is used for D-Wave QPU samplers, Braket uses `resultFormat` instead.
[Linked](https://github.com/aws/amazon-braket-ocean-plugin-python/blob/main/examples/braket_sampler_min_vertex.py) is a sample example of solving the [minimum vertex cover](https://en.wikipedia.org/wiki/Vertex_cover) problem using `BraketSampler`.
`BraketDWaveSampler` is a structured sampler that uses D-Wave-formatted parameters and properties. It is interchangeable with D-Wave's `DWaveSampler`.
[Linked](https://github.com/aws/amazon-braket-ocean-plugin-python/blob/main/examples/braket_dwave_sampler_min_vertex.py) is the same example as above of solving the minimum vertex cover problem. Only the parameter inputs to the solver have been changed to be D-Wave formatted (e.g. `answer_mode` instead of `resultFormat`).
These usage examples can be found as python scripts in the `BRAKET_OCEAN_PLUGIN_ROOT/examples/` folder.
### Debugging Logs
Tasks sent to QPUs don't always complete right away. To view task status, you can enable debugging logs. An example of how to enable these logs is included in the repo: `BRAKET_OCEAN_PLUGIN_ROOT/examples/debug_*`. These examples enable task logging so that status updates are continuously printed to terminal after a quantum task is executed. The logs can also be configured to save to a file or output to another stream. You can use the debugging example to get information on the tasks you submit, such as the current status, so that you know when your task completes.
## Install Additional Packages for Testing
Make sure to install test dependencies first:
```bash
pip install -e "amazon-braket-ocean-plugin-python[test]"
```
### Unit Tests
To run the unit tests:
```bash
tox -e unit-tests
```
You can also pass in various pytest arguments to run selected tests:
```bash
tox -e unit-tests -- your-arguments
```
For more information, please see [pytest usage](https://docs.pytest.org/en/stable/usage.html).
To run linters and doc generators and unit tests:
```bash
tox
```
### Integration Tests
Set the `AWS_PROFILE`, as instructed in the amazon-braket-sdk-python [README](https://github.com/aws/amazon-braket-sdk-python/blob/main/README.md).
```bash
export AWS_PROFILE=YOUR_PROFILE_NAME
```
Running the integration tests will create an S3 bucket in the same account as the `AWS_PROFILE` with the following naming convention `amazon-braket-ocean-plugin-integ-tests-{account_id}`.
Run the tests:
```bash
tox -e integ-tests
```
As with unit tests, you can also pass in various pytest arguments:
```bash
tox -e integ-tests -- your-arguments
```
## License
This project is licensed under the Apache-2.0 License.
%package -n python3-amazon-braket-ocean-plugin
Summary: An open source framework for interacting with D-Wave's Ocean library through Amazon Braket
Provides: python-amazon-braket-ocean-plugin
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-amazon-braket-ocean-plugin
# Amazon Braket Ocean Plugin
[](https://pypi.python.org/pypi/amazon-braket-ocean-plugin)
[](https://pypi.python.org/pypi/amazon-braket-ocean-plugin)
[](https://github.com/aws/amazon-braket-ocean-plugin-python/actions?query=workflow%3A%22Python+package%22)
[](https://codecov.io/gh/aws/amazon-braket-ocean-plugin-python)
[](https://amazon-braket-ocean-plugin-python.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/psf/black)
The Amazon Braket Ocean Plugin is an open source library in Python that provides a framework that you can use to interact with Ocean tools on top of Amazon Braket.
## Prerequisites
Before you begin working with the Amazon Braket Ocean Plugin, make sure that you've installed or configured the following prerequisites.
### Python 3.7.2 or greater
Download and install Python 3.7.2 or greater from [Python.org](https://www.python.org/downloads/).
If you are using Windows, choose **Add Python to environment variables** before you begin the installation.
### Amazon Braket SDK
Make sure that your AWS account is onboarded to Amazon Braket, as per the instructions in the [README](https://github.com/aws/amazon-braket-sdk-python#prerequisites).
### Ocean tools
Download and install [Ocean tools](https://docs.ocean.dwavesys.com/en/latest/overview/install.html).
```bash
pip install dwave-ocean-sdk
```
## Install the Amazon Braket Ocean Plugin
The Amazon Braket Ocean Plugin can be installed with pip as follows:
```bash
pip install amazon-braket-ocean-plugin
```
You can also install from source by cloning this repository and running a pip install command in the root directory of the repository:
```bash
git clone https://github.com/aws/amazon-braket-ocean-plugin-python.git
cd amazon-braket-ocean-plugin-python
pip install .
```
You can check your currently installed version of `amazon-braket-ocean-plugin` with `pip show`:
```bash
pip show amazon-braket-ocean-plugin
```
or alternatively from within Python:
```
>>> from braket import ocean_plugin
>>> ocean_plugin.__version__
```
## Documentation
Detailed documentation, including the API reference, can be found on [Read the Docs](https://amazon-braket-ocean-plugin-python.readthedocs.io/en/latest/).
**To generate the API Reference HTML in your local environment**
First, you must have tox installed.
```bash
pip install tox
```
Then, you can run the following command with tox to generate the documentation:
```bash
tox -e docs
```
To view the generated documentation, open the following file in a browser:
`BRAKET_OCEAN_PLUGIN_ROOT/build/documentation/html/index.html`
## Usage
This package provides samplers which use Braket solvers. These samplers extend abstract base classes provided in Ocean's dimod and thus have the same interfaces as other samplers in Ocean.
`BraketSampler` is a structured sampler that uses Braket-formatted parameters and properties. For example, instead of `answer_mode`, which is used for D-Wave QPU samplers, Braket uses `resultFormat` instead.
[Linked](https://github.com/aws/amazon-braket-ocean-plugin-python/blob/main/examples/braket_sampler_min_vertex.py) is a sample example of solving the [minimum vertex cover](https://en.wikipedia.org/wiki/Vertex_cover) problem using `BraketSampler`.
`BraketDWaveSampler` is a structured sampler that uses D-Wave-formatted parameters and properties. It is interchangeable with D-Wave's `DWaveSampler`.
[Linked](https://github.com/aws/amazon-braket-ocean-plugin-python/blob/main/examples/braket_dwave_sampler_min_vertex.py) is the same example as above of solving the minimum vertex cover problem. Only the parameter inputs to the solver have been changed to be D-Wave formatted (e.g. `answer_mode` instead of `resultFormat`).
These usage examples can be found as python scripts in the `BRAKET_OCEAN_PLUGIN_ROOT/examples/` folder.
### Debugging Logs
Tasks sent to QPUs don't always complete right away. To view task status, you can enable debugging logs. An example of how to enable these logs is included in the repo: `BRAKET_OCEAN_PLUGIN_ROOT/examples/debug_*`. These examples enable task logging so that status updates are continuously printed to terminal after a quantum task is executed. The logs can also be configured to save to a file or output to another stream. You can use the debugging example to get information on the tasks you submit, such as the current status, so that you know when your task completes.
## Install Additional Packages for Testing
Make sure to install test dependencies first:
```bash
pip install -e "amazon-braket-ocean-plugin-python[test]"
```
### Unit Tests
To run the unit tests:
```bash
tox -e unit-tests
```
You can also pass in various pytest arguments to run selected tests:
```bash
tox -e unit-tests -- your-arguments
```
For more information, please see [pytest usage](https://docs.pytest.org/en/stable/usage.html).
To run linters and doc generators and unit tests:
```bash
tox
```
### Integration Tests
Set the `AWS_PROFILE`, as instructed in the amazon-braket-sdk-python [README](https://github.com/aws/amazon-braket-sdk-python/blob/main/README.md).
```bash
export AWS_PROFILE=YOUR_PROFILE_NAME
```
Running the integration tests will create an S3 bucket in the same account as the `AWS_PROFILE` with the following naming convention `amazon-braket-ocean-plugin-integ-tests-{account_id}`.
Run the tests:
```bash
tox -e integ-tests
```
As with unit tests, you can also pass in various pytest arguments:
```bash
tox -e integ-tests -- your-arguments
```
## License
This project is licensed under the Apache-2.0 License.
%package help
Summary: Development documents and examples for amazon-braket-ocean-plugin
Provides: python3-amazon-braket-ocean-plugin-doc
%description help
# Amazon Braket Ocean Plugin
[](https://pypi.python.org/pypi/amazon-braket-ocean-plugin)
[](https://pypi.python.org/pypi/amazon-braket-ocean-plugin)
[](https://github.com/aws/amazon-braket-ocean-plugin-python/actions?query=workflow%3A%22Python+package%22)
[](https://codecov.io/gh/aws/amazon-braket-ocean-plugin-python)
[](https://amazon-braket-ocean-plugin-python.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/psf/black)
The Amazon Braket Ocean Plugin is an open source library in Python that provides a framework that you can use to interact with Ocean tools on top of Amazon Braket.
## Prerequisites
Before you begin working with the Amazon Braket Ocean Plugin, make sure that you've installed or configured the following prerequisites.
### Python 3.7.2 or greater
Download and install Python 3.7.2 or greater from [Python.org](https://www.python.org/downloads/).
If you are using Windows, choose **Add Python to environment variables** before you begin the installation.
### Amazon Braket SDK
Make sure that your AWS account is onboarded to Amazon Braket, as per the instructions in the [README](https://github.com/aws/amazon-braket-sdk-python#prerequisites).
### Ocean tools
Download and install [Ocean tools](https://docs.ocean.dwavesys.com/en/latest/overview/install.html).
```bash
pip install dwave-ocean-sdk
```
## Install the Amazon Braket Ocean Plugin
The Amazon Braket Ocean Plugin can be installed with pip as follows:
```bash
pip install amazon-braket-ocean-plugin
```
You can also install from source by cloning this repository and running a pip install command in the root directory of the repository:
```bash
git clone https://github.com/aws/amazon-braket-ocean-plugin-python.git
cd amazon-braket-ocean-plugin-python
pip install .
```
You can check your currently installed version of `amazon-braket-ocean-plugin` with `pip show`:
```bash
pip show amazon-braket-ocean-plugin
```
or alternatively from within Python:
```
>>> from braket import ocean_plugin
>>> ocean_plugin.__version__
```
## Documentation
Detailed documentation, including the API reference, can be found on [Read the Docs](https://amazon-braket-ocean-plugin-python.readthedocs.io/en/latest/).
**To generate the API Reference HTML in your local environment**
First, you must have tox installed.
```bash
pip install tox
```
Then, you can run the following command with tox to generate the documentation:
```bash
tox -e docs
```
To view the generated documentation, open the following file in a browser:
`BRAKET_OCEAN_PLUGIN_ROOT/build/documentation/html/index.html`
## Usage
This package provides samplers which use Braket solvers. These samplers extend abstract base classes provided in Ocean's dimod and thus have the same interfaces as other samplers in Ocean.
`BraketSampler` is a structured sampler that uses Braket-formatted parameters and properties. For example, instead of `answer_mode`, which is used for D-Wave QPU samplers, Braket uses `resultFormat` instead.
[Linked](https://github.com/aws/amazon-braket-ocean-plugin-python/blob/main/examples/braket_sampler_min_vertex.py) is a sample example of solving the [minimum vertex cover](https://en.wikipedia.org/wiki/Vertex_cover) problem using `BraketSampler`.
`BraketDWaveSampler` is a structured sampler that uses D-Wave-formatted parameters and properties. It is interchangeable with D-Wave's `DWaveSampler`.
[Linked](https://github.com/aws/amazon-braket-ocean-plugin-python/blob/main/examples/braket_dwave_sampler_min_vertex.py) is the same example as above of solving the minimum vertex cover problem. Only the parameter inputs to the solver have been changed to be D-Wave formatted (e.g. `answer_mode` instead of `resultFormat`).
These usage examples can be found as python scripts in the `BRAKET_OCEAN_PLUGIN_ROOT/examples/` folder.
### Debugging Logs
Tasks sent to QPUs don't always complete right away. To view task status, you can enable debugging logs. An example of how to enable these logs is included in the repo: `BRAKET_OCEAN_PLUGIN_ROOT/examples/debug_*`. These examples enable task logging so that status updates are continuously printed to terminal after a quantum task is executed. The logs can also be configured to save to a file or output to another stream. You can use the debugging example to get information on the tasks you submit, such as the current status, so that you know when your task completes.
## Install Additional Packages for Testing
Make sure to install test dependencies first:
```bash
pip install -e "amazon-braket-ocean-plugin-python[test]"
```
### Unit Tests
To run the unit tests:
```bash
tox -e unit-tests
```
You can also pass in various pytest arguments to run selected tests:
```bash
tox -e unit-tests -- your-arguments
```
For more information, please see [pytest usage](https://docs.pytest.org/en/stable/usage.html).
To run linters and doc generators and unit tests:
```bash
tox
```
### Integration Tests
Set the `AWS_PROFILE`, as instructed in the amazon-braket-sdk-python [README](https://github.com/aws/amazon-braket-sdk-python/blob/main/README.md).
```bash
export AWS_PROFILE=YOUR_PROFILE_NAME
```
Running the integration tests will create an S3 bucket in the same account as the `AWS_PROFILE` with the following naming convention `amazon-braket-ocean-plugin-integ-tests-{account_id}`.
Run the tests:
```bash
tox -e integ-tests
```
As with unit tests, you can also pass in various pytest arguments:
```bash
tox -e integ-tests -- your-arguments
```
## License
This project is licensed under the Apache-2.0 License.
%prep
%autosetup -n amazon-braket-ocean-plugin-1.0.11
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-amazon-braket-ocean-plugin -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Fri May 05 2023 Python_Bot <Python_Bot@openeuler.org> - 1.0.11-1
- Package Spec generated
|
