Update QFR to fix RZ sign bug (#32)

- Pull in fix for cda-tum/dd_package#25
- Additional wheels for Python 3.10 and musllinux
- Source install of via pip or setup.py uses available cores and native optimizations

Author: hillmich

.github/workflows/bindings.yml

@@ -11,13 +11,15 @@ on:
 
 env:
   CIBW_MANYLINUX_X86_64_IMAGE: manylinux2014
-  CIBW_BUILD: cp3?-*
+  CIBW_BUILD: cp3*
+  CIBW_ENVIRONMENT: "DEPLOY=ON"
+  CIBW_ENVIRONMENT_MACOS: "MACOSX_DEPLOYMENT_TARGET=10.15 DEPLOY=ON"
   CIBW_ARCHS_MACOS: "x86_64"
-  CIBW_SKIP: "*-win32 *-manylinux_i686"
-  CIBW_BUILD_VERBOSITY: 0
+  CIBW_TEST_SKIP: "*_arm64 *-musllinux_x86_64 cp310-*"
+  CIBW_SKIP: "*-win32 *-musllinux_i686 *-manylinux_i686"
+  CIBW_BUILD_VERBOSITY: 3
   CIBW_TEST_REQUIRES: qiskit-terra
   CIBW_TEST_COMMAND: "python -c \"from jkq import ddsim\""
-  CIBW_BEFORE_BUILD: "pip install cmake"
   CIBW_BEFORE_BUILD_MACOS: "brew install libomp"
 
 jobs:
@@ -31,7 +33,7 @@ jobs:
       - uses: actions/setup-python@v2
         name: Install Python
         with:
-          python-version: '3.8'
+          python-version: '3.9'
       - name: Install package
         run: |
           pip install -U pip setuptools wheel cmake
@@ -52,7 +54,7 @@ jobs:
       - uses: actions/setup-python@v2
         name: Install Python
         with:
-          python-version: '3.8'
+          python-version: '3.9'
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip setuptools wheel
@@ -72,7 +74,7 @@ jobs:
     needs: [ test_bindings, build_sdist ]
     runs-on: ${{ matrix.os }}
     strategy:
-      fail-fast: true
+      fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
     steps:
@@ -81,7 +83,7 @@ jobs:
           submodules: recursive
       - uses: ilammy/msvc-dev-cmd@v1
       - name: Build wheels
-        uses: pypa/cibuildwheel@v2.1.1
+        uses: pypa/cibuildwheel@v2.2.2
       - uses: actions/upload-artifact@v2
         with:
           path: ./wheelhouse/*.whl

CMakeLists.txt

@@ -1,8 +1,8 @@
-cmake_minimum_required(VERSION 3.14...3.19)
+cmake_minimum_required(VERSION 3.14...3.21)
 
 project(ddsim
         LANGUAGES CXX
-        VERSION 1.9.0
+        VERSION 1.9.1
         DESCRIPTION "DDSIM - A JKQ quantum simulator based on decision diagrams"
         )
 
@@ -11,6 +11,11 @@ option(COVERAGE "Configure for coverage report generation")
 option(BINDINGS "Configure for building Python bindings")
 option(DEPLOY "Configure for deployment")
 
+if (DEFINED ENV{DEPLOY})
+    set(DEPLOY $ENV{DEPLOY} CACHE BOOL "Use deployment configuration from environment" FORCE)
+    message(STATUS "Setting deployment configuration to '${DEPLOY}' from environment")
+endif ()
+
 set(default_build_type "Release")
 if (NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
     message(STATUS "Setting build type to '${default_build_type}' as none was specified.")

README.md

@@ -67,13 +67,18 @@ The simulator is based on the references listed below and can either be used as
 
 ## Using the Python Bindings / Backend for Qiskit
 
-The backend for Qiskit is available via [PyPi](https://pypi.org/project/jkq.ddsim/) as wheel for Linux, Windows and MacOS. 
-Install with the following command. (We strongly recommend using a [virtual environment](https://docs.python.org/3/tutorial/venv.html).)
+The backend for Qiskit is available via [PyPi](https://pypi.org/project/jkq.ddsim/) as wheel for Linux, Windows and MacOS.
+In order to make the library as easy to use as possible (without compilation), we provide pre-built wheels for most common platforms (64-bit Linux, MacOS, Windows). (We strongly recommend using a [virtual environment](https://docs.python.org/3/tutorial/venv.html).)
 
 ```console
 (venv) $ pip install jkq.ddsim
 ```
 
+However, in order to get the best performance out of DDSIM, it is recommended to build it locally from the source distribution via
+```bash
+pip install --no-binary jkq.ddsim
+```
+
 The following code gives an example on the usage:
 
 ```python3

extern/qfr

@@ -33,8 +33,7 @@ def build_extension(self, ext):
 
         cmake_args = ['-DCMAKE_LIBRARY_OUTPUT_DIRECTORY=' + extdir,
                       '-DPYTHON_EXECUTABLE=' + sys.executable,
-                      '-DBINDINGS=ON',
-                      '-DDEPLOY=ON']
+                      '-DBINDINGS=ON']
 
         cfg = 'Debug' if self.debug else 'Release'
         build_args = ['--config', cfg]
@@ -47,7 +46,10 @@ def build_extension(self, ext):
             build_args += ['--', '/m']
         else:
             cmake_args += ['-DCMAKE_BUILD_TYPE=' + cfg]
-            build_args += ['--', '-j2']
+            cpus = os.cpu_count()
+            if cpus is None:
+                cpus = 2
+            build_args += ['--', f'-j{cpus}']
 
         env = os.environ.copy()
         env['CXXFLAGS'] = '{} -DVERSION_INFO=\\"{}\\"'.format(env.get('CXXFLAGS', ''),
@@ -64,7 +66,7 @@ def build_extension(self, ext):
 
 setup(
     name='jkq.ddsim',
-    version='1.9.0',
+    version='1.9.1',
     author='Stefan Hillmich',
     author_email='stefan.hillmich@jku.at',
     description='JKQ DDSIM - A quantum simulator based on decision diagrams written in C++',