Issue 41 cimulator buid

.github/workflows/pypi-test-publish.yml

@@ -11,7 +11,8 @@ jobs:
     runs-on: ${{matrix.os}}
     strategy:
       matrix:
-        os: [ubuntu-22.04, macos-11, windows-2022]
+        #os: [ubuntu-22.04, macos-11, windows-2022]
+        os: [ubuntu-22.04]
         python: ["cp311"]
 
     steps:

.github/workflows/qokit-package.yml

@@ -21,20 +21,6 @@ jobs:
 
     steps:
     - uses: actions/checkout@v3
-###### Alex: to be used in future version once permissions issue is resolved
-#     - name: black
-#       uses: lgeiger/black-action@master
-#       with:
-#           args: .      
-#     - name: Apply black formatting if reviewdog found formatting errors
-#       if: "${{ failure() }}"
-#       run: |
-#          black .
-#     - name: Commit black formatting results
-#       if: "${{ failure() }}"
-#       uses: stefanzweifel/git-auto-commit-action@v4
-#       with:
-#          commit_message: ":art: Format Python code with psf/black push"
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v3
       with:

.github/workflows/qokit-python-only.yml

@@ -20,20 +20,6 @@ jobs:
 
     steps:
     - uses: actions/checkout@v3
-###### Alex: to be used in future version once permissions issue is resolved
-#     - name: black
-#       uses: lgeiger/black-action@master
-#       with:
-#           args: .      
-#     - name: Apply black formatting if reviewdog found formatting errors
-#       if: "${{ failure() }}"
-#       run: |
-#          black .
-#     - name: Commit black formatting results
-#       if: "${{ failure() }}"
-#       uses: stefanzweifel/git-auto-commit-action@v4
-#       with:
-#          commit_message: ":art: Format Python code with psf/black push"
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v3
       with:
@@ -47,7 +33,8 @@ jobs:
           black --check .
     - name: pip install   
       run: |
-        QOKIT_PYTHON_ONLY=1 pip install .
+        export QOKIT_PYTHON_ONLY=True
+        pip install .
     - name: Run tests and coverage
       run: |
          pytest --cov=qokit -rs tests --cov-fail-under=70

setup.py

@@ -9,40 +9,22 @@
 import sys
 
 
-environment_variable_name = "QOKIT_NO_C_ENV"
-QOKIT_PYTHON_ONLY = False
-QOKIT_NO_C_ENV = False  # used for tests only
-
-environment_variable_value = os.environ.get(environment_variable_name, None)
-
-if environment_variable_value is not None:
-    QOKIT_NO_C_ENV = True
-
 path = "./qokit/fur/c/csim/src/"
 
-sources = [os.path.join(path, "diagonal.c"), os.path.join(path, "fur.c"), os.path.join(path, "qaoa_fur.c")]
+python_only = os.environ.get("QOKIT_PYTHON_ONLY")
 
+sources = [os.path.join(path, "diagonal.c"), os.path.join(path, "fur.c"), os.path.join(path, "qaoa_fur.c")]
 extensions = []
-if not QOKIT_PYTHON_ONLY:
+if python_only is None:
     extensions.append(
         Extension("simulator", sources=sources, include_dirs=[os.path.join(path, "")], extra_compile_args=["/d2FH4-"] if sys.platform == "win32" else [])
     )
 
 
-class SimulatorBuild(build_ext):
-    def run(self):
-        try:
-            if not QOKIT_PYTHON_ONLY:
-                if QOKIT_NO_C_ENV:
-                    raise Exception("No C/C++ enviroment setup")
-                subprocess.call(["make", "-C", path])
-            super().run
-        except Exception as e:
-            print("No C/C++ enviroment setup to compile the C simulator. Installing Python Simulator")
-
-
-with open("README.md", "r") as f:
-    long_description = f.read()
+def cbuild():
+    if python_only is None:
+        subprocess.call(["make", "-C", path])
 
 
-setup(ext_modules=extensions, cmdclass={"build_ext": SimulatorBuild} if sys.platform == "win32" else {}),
+cbuild()
+setup(ext_modules=extensions)

tests/test_simulators_builds.py

@@ -0,0 +1,35 @@
+###############################################################################
+# // SPDX-License-Identifier: Apache-2.0
+# // Copyright : JP Morgan Chase & Co
+###############################################################################
+import pytest
+import os
+import numpy as np
+from qokit import get_qaoa_labs_objective
+from qokit.fur import get_available_simulator_names
+
+# when fail tests only runs in Github actions. Change to true to run locally
+IN_GITHUB_ACTIONS = os.getenv("GITHUB_ACTIONS") == "fales"
+
+
+@pytest.mark.skipif(IN_GITHUB_ACTIONS, reason="Test runs only in Github Actions.")
+def test_simulator_c_bild():
+    assert "c" in get_available_simulator_names("x")
+    assert "c" in get_available_simulator_names("xyring")
+    assert "c" in get_available_simulator_names("xycomplete")
+
+
+@pytest.mark.skipif(IN_GITHUB_ACTIONS, reason="Test runs only in Github Actions.")
+def test_simulator_python_build():
+    assert "python" in get_available_simulator_names("x")
+    assert "python" in get_available_simulator_names("xyring")
+    assert "python" in get_available_simulator_names("xycomplete")
+
+
+@pytest.mark.skipif(IN_GITHUB_ACTIONS, reason="Test runs only in Github Actions.")
+@pytest.mark.timeout(15)
+def test_simulator_timing_test():
+    theta = np.random.uniform(0, 1, 280)
+    f = get_qaoa_labs_objective(20, 140)
+    f(theta)
+    pass