Issue 41 cimulator buid

.github/workflows/qokit-package.yml

@@ -13,33 +13,39 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, macos-latest, windows-latest]
+        os: [ubuntu-latest, macos-latest]
         python-version: ["3.9", "3.10", "3.11"]
 
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v3
       with:
-        python-version: ${{ matrix.python-version }}
+          python-version: ${{ matrix.python-version }}
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip
-        pip install pipreqs black addheader pytest-cov pip-licenses
+          python -m pip install --upgrade pip
+          pip install pipreqs black addheader pytest-cov pip-licenses
+    - name: Install GCC (macOS only)
+      if: runner.os == 'macOS'
+      run: |
+          brew install gcc
+          export PATH=$PATH:/opt/homebrew/
     - name: black check
       run:  |
           black --check .
     - name: pip install   
       run: |
           pip install .  
+          # make -C qokit/fur/c/csim/src/
     - name: Run tests 
       run: |
-         pytest --cov=qokit --cov-fail-under=75 -rs tests 
+          pytest --cov=qokit --cov-fail-under=75 -rs tests 
     - name: License check
       run: |
-        pip-licenses --format=markdown --order=license
+          pip-licenses --format=markdown --order=license
 
     - name: SPDX check
       run: |
-       addheader -t header.txt .
-       grep -L -f header.txt */*.py
+          addheader -t header.txt .
+          grep -L -f header.txt */*.py

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

@@ -31,7 +31,7 @@ jobs:
           black --check .
     - name: pip install 
       run: |
-        export QOKIT_PYTHON_ONLY=True 
+        export QOKIT_PYTHON_ONLY=true 
         pip install .
     - name: Run tests and coverage
       run: |

README.md

@@ -32,7 +32,7 @@ Some optional parts of the package require additional dependencies.
 
 Please note that the GPU dependency is specified for CUDA 12x. For other versions of CUDA, please follow cupy installation instructions.
 
-If compilation fails, try installing just the Python version using `QOKIT_PYTHON_ONLY=1 pip install -e .`.
+If compilation fails, try installing just the Python version using `QOKIT_PYTHON_ONLY=true pip install -e .`.
 
 Installation can be verified by running tests using `pytest`.
 

pyproject.toml

@@ -19,6 +19,7 @@ classifiers=[
 version = "0.2.0"
 requires-python = ">=3.9.0"
 dependencies = [
+	'types-pkg-resources==0.1.3',
     'networkx>=3.0.0',
     'importlib-resources>=5.2.2',
     'numba>=0.56.4,<1',

qokit/fur/c/csim/lib.py

@@ -10,7 +10,7 @@
 
 try:
     lib = ctypes.cdll.LoadLibrary(str(libpath))
-except OSError as e:
+except (OSError, FileNotFoundError) as e:
     raise ImportError("You must compile the C simulator before running the code. Please follow the instructions in README.md") from e
 
 

setup.py

@@ -9,40 +9,28 @@
 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") == "true"
 
+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 not PYTHON_ONLY:
     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")
+def cbuild():
+    if not PYTHON_ONLY:
+        subprocess.call(["make", "-C", path])
 
 
-with open("README.md", "r") as f:
-    long_description = f.read()
+class SimulatorBuild(build_ext):
+    def run(self):
+        cbuild()
+        super().run
 
 
+cbuild()
 setup(ext_modules=extensions, cmdclass={"build_ext": SimulatorBuild} if sys.platform == "win32" else {}),

tests/test_simulator_build.py

@@ -0,0 +1,25 @@
+###############################################################################
+# // 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
+
+# Set up QOKIT_PYTHON_ONLY in your local enviroment for Python only
+PYTHON_ONLY = os.environ.get("QOKIT_PYTHON_ONLY")
+
+
+@pytest.mark.skipif(not PYTHON_ONLY, reason="Fast c/c++ simulator should be installed")
+def test_simulator_lack_of_c_build():
+    assert "c" not in get_available_simulator_names("x")
+    assert "c" not in get_available_simulator_names("xyring")
+    assert "c" not in get_available_simulator_names("xycomplete")
+
+
+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")