Fix, test program-valued GetInfo queries
[pyopencl.git] / setup.py
1 #!/usr/bin/env python
2 # -*- coding: utf-8 -*-
3
4 from __future__ import absolute_import, print_function
5
6 __copyright__ = """
7 Copyright (C) 2009-15 Andreas Kloeckner
8 Copyright (C) 2013 Marko Bencun
9 Copyright (C) 2013 Marko Bencun
10 """
11
12 __license__ = """
13 Permission is hereby granted, free of charge, to any person obtaining a copy
14 of this software and associated documentation files (the "Software"), to deal
15 in the Software without restriction, including without limitation the rights
16 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
17 copies of the Software, and to permit persons to whom the Software is
18 furnished to do so, subject to the following conditions:
19
20 The above copyright notice and this permission notice shall be included in
21 all copies or substantial portions of the Software.
22
23 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
26 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
28 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
29 THE SOFTWARE.
30 """
31
32
33 import sys
34
35
36 def get_config_schema():
37     from aksetup_helper import ConfigSchema, Option, \
38             IncludeDir, LibraryDir, Libraries, \
39             Switch, StringListOption
40
41     if 'darwin' in sys.platform:
42         import platform
43         osx_ver, _, _ = platform.mac_ver()
44         osx_ver = '.'.join(osx_ver.split('.')[:2])
45
46         sysroot_paths = [
47                 "/Applications/Xcode.app/Contents/Developer/Platforms/"
48                 "MacOSX.platform/Developer/SDKs/MacOSX%s.sdk" % osx_ver,
49                 "/Developer/SDKs/MacOSX%s.sdk" % osx_ver
50                 ]
51
52         default_libs = []
53         default_cxxflags = ['-arch', 'i386', '-arch', 'x86_64']
54
55         from os.path import isdir
56         for srp in sysroot_paths:
57             if isdir(srp):
58                 default_cxxflags.extend(['-isysroot', srp])
59                 break
60
61         default_ldflags = default_cxxflags[:] + ["-Wl,-framework,OpenCL"]
62
63     else:
64         default_libs = ["OpenCL"]
65         default_cxxflags = []
66         default_ldflags = []
67
68     return ConfigSchema([
69         Switch("CL_TRACE", False, "Enable OpenCL API tracing"),
70         Switch("CL_ENABLE_GL", False, "Enable OpenCL<->OpenGL interoperability"),
71         Switch("CL_ENABLE_DEVICE_FISSION", True,
72             "Enable device fission extension, if present"),
73         Option("CL_PRETEND_VERSION", None,
74             "Dotted CL version (e.g. 1.2) which you'd like to use."),
75
76         IncludeDir("CL", []),
77         LibraryDir("CL", []),
78         Libraries("CL", default_libs),
79
80         StringListOption("CXXFLAGS", default_cxxflags,
81             help="Any extra C++ compiler options to include"),
82         StringListOption("LDFLAGS", default_ldflags,
83             help="Any extra linker options to include"),
84         ])
85
86
87 def main():
88     from setuptools import find_packages
89     from aksetup_helper import (hack_distutils, get_config, setup,
90             check_git_submodules)
91     check_git_submodules()
92
93     hack_distutils()
94     conf = get_config(get_config_schema(),
95             warn_about_no_config=False)
96
97     extra_defines = {}
98
99     extra_defines["PYGPU_PACKAGE"] = "pyopencl"
100     extra_defines["PYGPU_PYOPENCL"] = "1"
101
102     if conf["CL_TRACE"]:
103         extra_defines["PYOPENCL_TRACE"] = 1
104
105     if conf["CL_ENABLE_GL"]:
106         extra_defines["HAVE_GL"] = 1
107
108     if conf["CL_ENABLE_DEVICE_FISSION"]:
109         extra_defines["PYOPENCL_USE_DEVICE_FISSION"] = 1
110     if conf["CL_PRETEND_VERSION"]:
111         try:
112             major, minor = [int(x) for x in conf["CL_PRETEND_VERSION"].split(".")]
113             extra_defines["PYOPENCL_PRETEND_CL_VERSION"] = \
114                     0x1000*major + 0x10 * minor
115         except:
116             print("CL_PRETEND_VERSION must be of the form M.N, "
117                     "with two integers M and N")
118             raise
119
120     conf["EXTRA_DEFINES"] = extra_defines
121
122     ver_dic = {}
123     version_file = open("pyopencl/version.py")
124     try:
125         version_file_contents = version_file.read()
126     finally:
127         version_file.close()
128
129     exec(compile(version_file_contents, "pyopencl/version.py", 'exec'), ver_dic)
130
131     separator = "-"*75
132
133     try:
134         import mako  # noqa
135     except ImportError:
136         print(separator)
137         print("Mako is not installed.")
138         print(separator)
139         print("That is not a problem, as most of PyOpenCL will be just fine ")
140         print("without it.Some higher-level parts of pyopencl (such as ")
141         print("pyopencl.reduction) will not function without the templating engine ")
142         print("Mako [1] being installed. If you would like this functionality to ")
143         print("work, you might want to install Mako after you finish ")
144         print("installing PyOpenCL.")
145         print("")
146         print("[1] http://www.makotemplates.org/")
147         print(separator)
148         print("Hit Ctrl-C now if you'd like to think about the situation.")
149         print(separator)
150
151         from aksetup_helper import count_down_delay
152         count_down_delay(delay=5)
153
154     # {{{ write cffi build script
155
156     with open("cffi_build.py.in", "rt") as f:
157         build_script_template = f.read()
158
159     format_args = {}
160     for k, v in conf.items():
161         format_args[k] = repr(v)
162
163     build_script = build_script_template.format(**format_args)
164
165     with open("cffi_build.py", "wt") as f:
166         f.write(build_script)
167
168     # }}}
169
170     setup(name="pyopencl",
171             # metadata
172             version=ver_dic["VERSION_TEXT"],
173             description="Python wrapper for OpenCL",
174             long_description=open("README.rst", "rt").read(),
175             author="Andreas Kloeckner",
176             author_email="inform@tiker.net",
177             license="MIT",
178             url="http://mathema.tician.de/software/pyopencl",
179             classifiers=[
180                 'Environment :: Console',
181                 'Development Status :: 5 - Production/Stable',
182                 'Intended Audience :: Developers',
183                 'Intended Audience :: Other Audience',
184                 'Intended Audience :: Science/Research',
185                 'License :: OSI Approved :: MIT License',
186                 'Natural Language :: English',
187                 'Programming Language :: C++',
188                 'Programming Language :: Python',
189                 'Programming Language :: Python :: 2',
190                 'Programming Language :: Python :: 2.6',
191                 'Programming Language :: Python :: 2.7',
192                 'Programming Language :: Python :: 3',
193                 'Programming Language :: Python :: 3.2',
194                 'Programming Language :: Python :: 3.3',
195                 'Topic :: Scientific/Engineering',
196                 'Topic :: Scientific/Engineering :: Mathematics',
197                 'Topic :: Scientific/Engineering :: Physics',
198                 ],
199
200             # build info
201             packages=find_packages(),
202
203             setup_requires=[
204                 "numpy",
205                 "cffi>=1.1.0",
206                 ],
207
208             install_requires=[
209                 "numpy",
210                 "pytools>=2015.1.2",
211                 "pytest>=2",
212                 "decorator>=3.2.0",
213                 "cffi>=1.1.0",
214                 "appdirs>=1.4.0",
215                 "six>=1.9.0",
216                 # "Mako>=0.3.6",
217                 ],
218
219             cffi_modules=["cffi_build.py:ffi"],
220
221             include_package_data=True,
222             package_data={
223                     "pyopencl": ["cl/*.cl", "cl/*.h"]
224                     },
225
226             zip_safe=False)
227
228
229 if __name__ == '__main__':
230     main()