added gh workflow

Author: NicoRenaud

.github/workflows/ci.yml

@@ -14,3 +14,28 @@ jobs:
       - name: Install dependencies
         run: |
           pip install -e .
+      - name: Test 
+        run: coverage run -m pytest tests
+
+      - name: Combine all coverage results
+        run: coverage combine
+
+      - name: Generate coverage report
+        run: coverage report
+
+      - name: Coveralls Services
+        run: coveralls --service=github
+        env:
+          GITHUB_TOKEN: ${{ secrets.github_token }}
+          COVERALLS_FLAG_NAME: python-${{ matrix.version }}
+          COVERALLS_PARALLEL: true
+
+  finish:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Coveralls Finished
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.github_token }}
+          parallel-finished: true

hadamard_random_forest/sample.py

@@ -71,7 +71,7 @@ def get_samples(
     elif isinstance(sampler, Sampler):
         results = sampler.run([(qc, parameters) for qc in circuits]).result()[0].data.meas.get_counts()
     else:
-        raise ValueError("Sampler must be of type qiskit_aer.primitives.Sampler or qiskit_ibm_runtime.SamplerV2")
+        raise ValueError("Sampler must be of type qiskit_aer.primitives.Sampler or qiskit_ibm_runtime.SamplerV2.")
 
     samples: List[np.ndarray] = []
     for res in results:

setup.py

@@ -33,6 +33,11 @@
         'qiskit-experiments>=0.10.0',
         'mthree==3.0.0',
     ],
+    extras_require={
+        'dev': [
+            'pytest','pytest-runner', 'coverage', 'coveralls'
+        ],
+    },
     python_requires='>=3.8, <4',
     classifiers=[
         'Programming Language :: Python :: 3',

tests/__init__.py

@@ -0,0 +1,22 @@
+import unittest
+import numpy as np
+from hadamard_random_forest.random_forest import (generate_random_forest)
+
+
+class TestRandomForest(unittest.TestCase):
+
+    def test_generate_random_forest(self):
+        """
+        Test that generate_random_forest returns a valid result.
+        """
+        num_qubits = 3
+        num_trees = 5
+        samples = [np.random.rand(2**num_qubits) for _ in range(num_qubits+1)]
+        result = generate_random_forest(num_qubits, num_trees, samples, save_tree=False)
+        self.assertIsInstance(result, np.ndarray)
+        self.assertEqual(result.shape, (2**num_qubits,))
+
+
+if __name__ == '__main__':
+    unittest.main()
+

tests/test_random_forest.py

@@ -0,0 +1,42 @@
+import unittest
+import numpy as np
+from qiskit.circuit.random import random_circuit
+from qiskit_aer.primitives import Sampler as Aer_Sampler
+from qiskit.circuit.library import real_amplitudes
+from hadamard_random_forest.sample import (
+    get_statevector,
+    get_circuits,
+    get_samples
+)
+
+class TestSample(unittest.TestCase):
+
+    def test_get_circuits(self):
+        num_qubits = 3
+        base_circuit = random_circuit(num_qubits,3, measure=False)
+        circuits = get_circuits(num_qubits, base_circuit)
+        self.assertEqual(len(circuits), 4)
+        self.assertEqual(circuits[0].num_qubits, 3)
+        self.assertEqual(circuits[1].num_qubits, 3)
+
+    def test_get_samples(self):
+        num_qubits = 3
+        sampler = Aer_Sampler()
+        base_circuit = real_amplitudes(num_qubits)
+        parameters = np.random.rand(12)
+        circuits = get_circuits(num_qubits, base_circuit)
+        _ = get_samples(num_qubits, sampler, circuits, parameters)  
+
+    def test_get_statevector(self):
+        """
+        Test that get_statevector returns a valid statevector.
+        """
+        num_qubits = 3
+        num_trees = 5
+        samples = [np.random.rand(2**num_qubits) for _ in range(num_qubits+1)]
+        statevector = get_statevector(num_qubits, num_trees, samples, save_tree=False)
+        self.assertIsInstance(statevector, np.ndarray)
+        self.assertEqual(statevector.shape, (2**num_qubits,))
+
+if __name__ == '__main__':
+    unittest.main()