Skip to content

Commit 3e4d3f4

Browse files
doc: starting job/device compatibility matrix
+ starting to fix doctest in ci
1 parent 98813c7 commit 3e4d3f4

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

mpqp/execution/devices.py

+7
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@
99
- :class:`ATOSDevice`,
1010
- :class:`AWSDevice`,
1111
- :class:`GOOGLEDevice`.
12+
13+
Not all combinations of :class:`AvailableDevice` and
14+
:class:`JobType<mpqp.execution.job.JobType>` are possible, for each device
15+
listed bellow, ``S`` means if supports the ``SAMPLE`` job type, ``SV`` the
16+
``STATE_VECTOR`` one and ``O`` the ``OBSERVABLE`` one.
1217
"""
1318

1419
from abc import abstractmethod
@@ -52,7 +57,9 @@ class IBMDevice(AvailableDevice):
5257
PULSE_SIMULATOR = "pulse_simulator"
5358

5459
AER_SIMULATOR = "aer_simulator"
60+
"""``S``"""
5561
AER_SIMULATOR_STATEVECTOR = "aer_simulator_statevector"
62+
"""``SV``"""
5663
AER_SIMULATOR_DENSITY_MATRIX = "aer_simulator_density_matrix"
5764
AER_SIMULATOR_STABILIZER = "aer_simulator_stabilizer"
5865
AER_SIMULATOR_MATRIX_PRODUCT_STATE = "aer_simulator_matrix_product_state"

tests/test_doc.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,8 @@ def __exit__(
6868

6969

7070
def test_documentation():
71+
print(os.getcwd())
72+
7173
test_globals = globals().copy()
7274
test_globals.update(locals())
7375

@@ -100,5 +102,3 @@ def test_documentation():
100102
assert runner.run(test).failed == 0
101103
else:
102104
assert runner.run(test).failed == 0
103-
104-

0 commit comments

Comments
 (0)