Packaging milestone

1. installation script copies backends/include/* into dpctl/
2. Use MANIFEST.in to include dpctl/include and dpctl/libDPPL*Inteface.* into
   installation layout
3. Added dpctl.get_include() function to provide location of includes
   needed to build extension linked to dpCtl
4. Provide dpctl/__init__.pxd allowing to do `cimport dptcl` to access
   relevant entities like dpctl.SyclQueue, etc.

Author: oleksandr-pavlyk

MANIFEST.in

@@ -1 +1,5 @@
 include versioneer.py
+recursive-include dpctl/include *.h *.hpp
+include dpctl/*.pxd
+include dpctl/*DPPL*Interface.*
+global-exclude *.cpp

conda-recipe/bld.bat

@@ -25,6 +25,8 @@ ninja install
 IF %ERRORLEVEL% NEQ 0 exit 1
 
 cd ..
+mkdir dpctl\include
+xcopy backends\include dpctl\include /E /Y
 
 REM required by dpglue
 set "DPPL_OPENCL_INTERFACE_LIBDIR=%LIBRARY_PREFIX%/lib"

conda-recipe/build.sh

@@ -32,6 +32,8 @@ cmake                                                       \
 make -j 4 && make install
 
 cd ..
+mkdir -p dpctl/include
+cp -r backends/include/* dpctl/include
 
 # required by dpctl.opencl_core
 export DPPL_OPENCL_INTERFACE_LIBDIR=${PREFIX}
@@ -46,7 +48,6 @@ export DPPL_SYCL_INTERFACE_INCLDIR=${PREFIX}/include
 # FIXME: How to pass this using setup.py? This flags is needed when
 # dpcpp compiles the generated cpp file.
 export CFLAGS="-fPIC -O3 ${CFLAGS}"
-export LDFLAGS="-L OpenCL_LIBDIR ${LDFLAGS}"
+export LDFLAGS="-L ${OpenCL_LIBDIR} ${LDFLAGS}"
 ${PYTHON} setup.py clean --all
-${PYTHON} setup.py build
-${PYTHON} setup.py install
+${PYTHON} setup.py build install

dpctl/__init__.pxd

@@ -0,0 +1,30 @@
+##===------------- sycl_core.pxd - dpctl module --------*- Cython -*-------===##
+##
+##                      Data Parallel Control (dpCtl)
+##
+## Copyright 2020 Intel Corporation
+##
+## Licensed under the Apache License, Version 2.0 (the "License");
+## you may not use this file except in compliance with the License.
+## You may obtain a copy of the License at
+##
+##    http://www.apache.org/licenses/LICENSE-2.0
+##
+## Unless required by applicable law or agreed to in writing, software
+## distributed under the License is distributed on an "AS IS" BASIS,
+## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+## See the License for the specific language governing permissions and
+## limitations under the License.
+##
+##===----------------------------------------------------------------------===##
+##
+## \file
+## This file declares the extension types and functions for the Cython API
+## implemented in sycl_core.pyx.
+##
+##===----------------------------------------------------------------------===##
+
+# distutils: language = c++
+# cython: language_level=3
+
+from dpctl._sycl_core cimport *

dpctl/__init__.py

@@ -49,5 +49,15 @@
 from ._sycl_core import *
 from ._version import get_versions
 
+def get_include():
+    """
+    Return the directory that contains the dpCtl *.h header files.
+
+    Extension modules that need to be compiled against dpCtl should use
+    this function to locate the appropriate include directory.
+    """
+    import os.path
+    return os.path.join(__file__, 'include')
+
 __version__ = get_versions()['version']
 del get_versions

scripts/build_for_develop.sh

@@ -28,17 +28,19 @@ make V=1 -n -j 4 && make install
 popd
 cp install/lib/*.so dpctl/
 
-export DPPL_OPENCL_INTERFACE_LIBDIR=${INSTALL_PREFIX}/lib
-export DPPL_OPENCL_INTERFACE_INCLDIR=${INSTALL_PREFIX}/include
+mkdir -p dpctl/include
+cp -r backends/include/* dpctl/include
+
+export DPPL_OPENCL_INTERFACE_LIBDIR=dpctl
+export DPPL_OPENCL_INTERFACE_INCLDIR=dpctl/include
 export OpenCL_LIBDIR=/usr/lib/x86_64-linux-gnu/
-export DPPL_SYCL_INTERFACE_LIBDIR=${INSTALL_PREFIX}/lib
-export DPPL_SYCL_INTERFACE_INCLDIR=${INSTALL_PREFIX}/include
+export DPPL_SYCL_INTERFACE_LIBDIR=dpctl
+export DPPL_SYCL_INTERFACE_INCLDIR=dpctl/include
 
 export CC=clang
 export CXX=dpcpp
 # FIXME: How to pass this using setup.py? The fPIC flag is needed when
 # dpcpp compiles the Cython generated cpp file.
 export CFLAGS=-fPIC
 python setup.py clean --all
-python setup.py build_ext --inplace
-python setup.py develop
+python setup.py build develop

setup.py

@@ -22,6 +22,7 @@
 ### This file builds the dpctl and dpctl.ocldrv extension modules.
 ##===----------------------------------------------------------------------===##
 import os
+import os.path
 import sys
 import versioneer
 
@@ -30,7 +31,6 @@
 
 import numpy as np
 
-
 requirements = [
     'cffi>=1.0.0',
     'cython',
@@ -100,22 +100,25 @@ def extensions():
         librarys = [dppl_sycl_interface_lib]
 
     if IS_LIN or IS_MAC:
-        runtime_library_dirs = [os.path.abspath('dpctl')]
+        runtime_library_dirs = ["$ORIGIN"]
     elif IS_WIN:
         runtime_library_dirs = []
 
     extension_args = {
         "depends": [dppl_sycl_interface_include,],
         "include_dirs": [np.get_include(), dppl_sycl_interface_include],
         "extra_compile_args": eca + get_other_cxxflags(),
-        "extra_link_args": ela, "libraries": libs, "library_dirs": librarys,
-        "runtime_library_dirs": runtime_library_dirs, "language": 'c++',
+        "extra_link_args": ela,
+        "libraries": libs,
+        "library_dirs": librarys,
+        "runtime_library_dirs": runtime_library_dirs,
+        "language": 'c++',
     }
 
     extensions = [
-        Extension('dpctl._sycl_core', [os.path.abspath('dpctl/sycl_core.pyx'),],
+        Extension('dpctl._sycl_core', [os.path.join('dpctl', 'sycl_core.pyx'),],
             **extension_args),
-        Extension('dpctl._memory', [os.path.abspath('dpctl/_memory.pyx'),],
+        Extension('dpctl._memory', [os.path.join('dpctl', '_memory.pyx'),],
             **extension_args),
     ]
 
@@ -130,7 +133,8 @@ def extensions():
     license="Apache 2.0",
     author="Intel Corporation",
     url='https://github.com/IntelPython/dpCtl',
-    packages=find_packages(include=["dpctl", "dpctl.*"]),
+    packages=find_packages(include=["*"]),
+    include_package_data=True,
     ext_modules = extensions(),
     setup_requires=requirements,
     cffi_modules=[
@@ -142,5 +146,6 @@ def extensions():
         "Development Status :: 3 - Alpha",
         'Programming Language :: Python :: 3.6',
         'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
     ]
 )