Windows support

.github/workflows/ci.yml

@@ -49,9 +49,10 @@ jobs:
     - name: Run notebooks
       run: jupyter execute ${{ matrix.notebook }}.ipynb --kernel_name=python3
   tests:
-    runs-on: ubuntu-latest
+    runs-on: ${{matrix.os}}
     strategy:
       matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
         python-version: [3.7, 3.8, 3.9, '3.10']
       fail-fast: false
     name: Run tests

.github/workflows/deploy.yml

@@ -2,22 +2,63 @@ name: deploy
 on:
   release:
     types: [published]
+  workflow_dispatch: {}
 
 jobs:
+  build-wheels:
+    name: Make ${{ matrix.os }} wheels
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: ["macos-latest", "ubuntu-latest", "windows-latest"]
+      fail-fast: false
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: "Build wheels"
+        uses: pypa/cibuildwheel@v2.8.1
+        env:
+          CIBW_MANYLINUX_X86_64_IMAGE: manylinux2014
+          CIBW_BUILD: cp37-* cp38-* cp39-* cp310-*
+          CIBW_SKIP: "*musllinux*"
+          CIBW_ARCHS: native
+          CIBW_BUILD_FRONTEND: build
+          CIBW_TEST_COMMAND: "python TESTS/unitTests.py"
+
+      - name: "Upload wheel as artifact"
+        uses: actions/upload-artifact@v4
+        with:
+          name: artifact-${{ matrix.os }}-wheel
+          path: "./**/*.whl"
+
+  build-sdist:
+    name: Make source distribution
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+
+    - run: pipx run build --sdist
+
+    - uses: actions/upload-artifact@v4
+      with:
+        name: artifact-source-dist
+        path: "./**/dist/*.tar.gz"
+
   deploy:
+    needs: [build_wheels, build-sdist]
     runs-on: ubuntu-latest
+    if: github.event_name == 'release' && github.event.action == 'published'
     steps:
       - uses: actions/checkout@v3
-      - name: Set up Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: '3.x'
-      - name: Install dependencies
+      - name: Download all artifacts
+        uses: actions/download-artifact@v4
+      - name: Copy artifacts to dist/ folder
         run: |
-          python -m pip install --upgrade pip
-          pip install build
-      - name: Build package
-        run: python -m build --outdir dist/ --sdist
+          find . -name 'artifact-*' -exec unzip '{}' \;
+          mkdir -p dist/
+          find . -name '*.tar.gz' -exec mv '{}' dist/ \;
+          find . -name '*.whl' -exec mv '{}' dist/ \;
       - name: Publish package to test pypi
         uses: pypa/gh-action-pypi-publish@release/v1
         with:

.gitignore

@@ -5,6 +5,10 @@ __pycache__/
 
 # C extensions
 *.so
+# Windows
+*.exp
+*.obj
+*.lib
 
 # Distribution / packaging
 .Python

CITATION.cff

@@ -15,6 +15,8 @@ authors:
   given-names: Zahra
 - family-names: Parthasarathy
   given-names: Nikhil
+- family-names: Ward
+  given-names: Brian
 orcid: https://orcid.org/0000-0000-0000-0000
 title: "Pyrtools: tools for multi-scale image processing"
 version: v1.0.2

README.md

@@ -41,15 +41,7 @@ repo](https://github.com/LabForComputationalVision/pyrtools)
 
 # Installation
 
-It's recommended you install from pip: `pip install pyrtools`. The pip
-install has been tested on Linux and on OSX. Windows is NOT supported
-because of issues with the C compiler (`gcc` isn't necessarily
-installed); if you have experience with C compilation on Windows,
-please open a pull request. It's possible that the way to fix this is
-to use Cython, ensuring that Cython is installed before attempting to
-run the pip command, and then adding: `from Cython.Build import
-cythonize` and wrapping the `ext_modules` in the `setup` call with
-`cythonize`, but I'm not sure.
+It's recommended you install from pip: `pip install pyrtools`.
 
 If you wish to install from the main branch, it's still recommended
 to use pip, just run `pip install .` (or `pip install -e .` if you

docs/installation.rst

@@ -3,13 +3,8 @@
 Installation
 ************
 
-There are two ways to install pyrtools: via the `pip` package
-management system, or directly from source. Note that we only support
-Linux and macOS; we've had issues compiling the C code on Windows. If
-you know how to fix this, please open up a Pull Request
-(:ref:`dev-guide`). Note that we require `gcc` version >= 6 in order
-for the C code to compile, because of `this
-issue<https://stackoverflow.com/questions/46504700/gcc-compiler-not-recognizing-fno-plt-option>`_
+There are two ways to install pyrtools: via the ``pip`` package management
+system, or directly from source.
 
 Recommended
 ===========
@@ -25,11 +20,19 @@ Obtain the latest version of pyrtools::
 
     git clone https://github.com/LabForComputationalVision/pyrtools
 
+(If you have already cloned the repo, you can update it with ``git pull``.)
+
 Finally, the package is installed by running::
 
     cd pyrtools
-    python setup.py -e .
+    pip install -e .
 
 This will install an editable version of the package, so changes made
 to the files within the pyrtools directory will be reflected in the
 version of pyrtools you use.
+
+When installing from source on Linux or Mac, we require ``gcc`` version >= 6 in
+order for the C code to compile, because of `this issue
+<https://stackoverflow.com/questions/46504700/gcc-compiler-not-recognizing-fno-plt-option>`_
+
+When installing from source on Windows, Microsoft Visual C++ 14.0 or greater is required, which can be obtained with `Microsoft C++ Build Tools <https://visualstudio.microsoft.com/visual-cpp-build-tools/`_.

pyrtools/pyramids/c/convolve.h

@@ -13,6 +13,7 @@
 
 #include <stdio.h>
 #include <stdlib.h> 
+#include "meta.h"
 
 #define ABS(x)	  (((x)>=0) ? (x) : (-(x)))
 #define ROOT2 1.4142135623730951
@@ -34,22 +35,22 @@ typedef struct
 typedef double image_type;
 
 fptr edge_function(char *edges);
-int internal_reduce(image_type *image, int x_idim, int y_idim, 
-		    image_type *filt, image_type *temp, int x_fdim, int y_fdim,
-		    int x_start, int x_step, int x_stop, 
-		    int y_start, int y_step, int y_stop,
-		    image_type *result, char *edges);
-int internal_expand(image_type *image, 
-		    image_type *filt, image_type *temp, int x_fdim, int y_fdim,
-		    int x_start, int x_step, int x_stop, 
-		    int y_start, int y_step, int y_stop,
-		    image_type *result, int x_rdim, int y_rdim, char *edges);
-int internal_wrap_reduce(image_type *image, int x_idim, int y_idim, 
-			 image_type *filt, int x_fdim, int y_fdim,
-			 int x_start, int x_step, int x_stop, 
-			 int y_start, int y_step, int y_stop,
-			 image_type *result);
-int internal_wrap_expand(image_type *image, image_type *filt, int x_fdim, int y_fdim,
-			 int x_start, int x_step, int x_stop, 
-			 int y_start, int y_step, int y_stop,
-			 image_type *result, int x_rdim, int y_rdim);
+PYRTOOLS_EXPORT int internal_reduce(image_type *image, int x_idim, int y_idim,
+									image_type *filt, image_type *temp, int x_fdim, int y_fdim,
+									int x_start, int x_step, int x_stop,
+									int y_start, int y_step, int y_stop,
+									image_type *result, char *edges);
+PYRTOOLS_EXPORT int internal_expand(image_type *image,
+									image_type *filt, image_type *temp, int x_fdim, int y_fdim,
+									int x_start, int x_step, int x_stop,
+									int y_start, int y_step, int y_stop,
+									image_type *result, int x_rdim, int y_rdim, char *edges);
+PYRTOOLS_EXPORT int internal_wrap_reduce(image_type *image, int x_idim, int y_idim,
+										 image_type *filt, int x_fdim, int y_fdim,
+										 int x_start, int x_step, int x_stop,
+										 int y_start, int y_step, int y_stop,
+										 image_type *result);
+PYRTOOLS_EXPORT int internal_wrap_expand(image_type *image, image_type *filt, int x_fdim, int y_fdim,
+										 int x_start, int x_step, int x_stop,
+										 int y_start, int y_step, int y_stop,
+										 image_type *result, int x_rdim, int y_rdim);

pyrtools/pyramids/c/internal_pointOp.c

@@ -1,5 +1,7 @@
 #include <stdio.h>
 #include <math.h>
+#include "internal_pointOp.h"
+
 /* Use linear interpolation on a lookup table.
    Taken from OBVIUS.  EPS, Spring, 1987.
  */

pyrtools/pyramids/c/internal_pointOp.h

@@ -1,3 +1,5 @@
-void internal_pointop(double *im, double *res, int size, double *lut, 
-		      int lutsize, double origin, double increment, 
-		      int warnings);
+#include "meta.h"
+
+PYRTOOLS_EXPORT void internal_pointop(double *im, double *res, int size, double *lut,
+									  int lutsize, double origin, double increment,
+									  int warnings);

pyrtools/pyramids/c/meta.h

@@ -0,0 +1,8 @@
+#pragma once
+
+// this macro controls symbol visibility in the shared library
+#if defined _WIN32 || defined __MINGW32__
+#define PYRTOOLS_EXPORT __declspec(dllexport)
+#else
+#define PYRTOOLS_EXPORT
+#endif

pyrtools/pyramids/c/py.c

@@ -0,0 +1,8 @@
+
+// This is required to allow the use of the python setuptools Extension
+// class on Windows. Alternatives would be building ourselves or using
+// a tool such as Meson which doesn't assume you're using the Python
+// C API directly.
+void* PyInit_wrapConv(void) {
+    return 0;
+}

pyrtools/pyramids/c/wrapper.py

@@ -9,7 +9,9 @@
 
 # the wrapConv.so file can have some system information after it from the compiler, so we just find
 # whatever it is called
-libpath = glob.glob(os.path.join(os.path.dirname(os.path.realpath(__file__)), 'wrapConv*.so'))
+lib_folder = os.path.dirname(os.path.realpath(__file__))
+libpath = glob.glob(os.path.join(lib_folder, 'wrapConv*.so')) + \
+    glob.glob(os.path.join(lib_folder, 'wrapConv.*.pyd'))
 # print(libpath)
 
 # load the c library

setup.py

@@ -1,5 +1,6 @@
 #! /usr/bin/env python
 
+from wheel.bdist_wheel import bdist_wheel
 from setuptools import setup, Extension
 import importlib
 import os
@@ -11,6 +12,17 @@
 pyrtools_version_spec.loader.exec_module(pyrtools_version_module)
 VERSION = pyrtools_version_module.version
 
+# Adapted from the cibuildwheel example https://github.com/joerick/python-ctypes-package-sample
+# it marks the wheel as not specific to the Python API version.
+class WheelABINone(bdist_wheel):
+    def finalize_options(self):
+        bdist_wheel.finalize_options(self)
+        self.root_is_pure = False
+
+    def get_tag(self):
+        _, _, plat = bdist_wheel.get_tag(self)
+        return "py3", "none", plat
+
 
 setup(
     name='pyrtools',
@@ -31,12 +43,15 @@
                       'tqdm>=4.29',
                       'requests>=2.21'],
     ext_modules=[Extension('pyrtools.pyramids.c.wrapConv',
-                           sources=['pyrtools/pyramids/c/convolve.c',
+                           sources=['pyrtools/pyramids/c/py.c',
+                                    'pyrtools/pyramids/c/convolve.c',
                                     'pyrtools/pyramids/c/edges.c',
                                     'pyrtools/pyramids/c/wrap.c',
                                     'pyrtools/pyramids/c/internal_pointOp.c'],
-                           depends=['pyrtools/pyramids/c/convolve.h',
+                           depends=['pyrtools/pyramids/c/meta.h',
+                                    'pyrtools/pyramids/c/convolve.h',
                                     'pyrtools/pyramids/c/internal_pointOp.h'],
                            extra_compile_args=['-fPIC', '-shared'])],
+    cmdclass={"bdist_wheel": WheelABINone},
     tests='TESTS',
     )