File: setup.py

package info (click to toggle)
bitshuffle 0.3.5-3.1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 612 kB
  • sloc: ansic: 3,477; python: 836; makefile: 15; sh: 2
file content (323 lines) | stat: -rw-r--r-- 11,586 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
from __future__ import absolute_import, division, print_function
# I didn't import unicode_literals. They break setuptools or Cython in python
# 2.7, but python 3 seems to be happy with them.

import glob
import os
from os import path
from setuptools import setup, Extension
from setuptools.command.build_ext import build_ext as build_ext_
from setuptools.command.develop import develop as develop_
from setuptools.command.install import install as install_
import shutil
import subprocess
import sys


VERSION_MAJOR = 0
VERSION_MINOR = 3
VERSION_POINT = 5

# Only unset in the 'release' branch and in tags.
VERSION_DEV = 0

VERSION = "%d.%d.%d" % (VERSION_MAJOR, VERSION_MINOR, VERSION_POINT)
if VERSION_DEV:
    VERSION = VERSION + ".dev%d" % VERSION_DEV


COMPILE_FLAGS = ['-O3', '-ffast-math', '-std=c99']
# Cython breaks strict aliasing rules.
COMPILE_FLAGS += ['-fno-strict-aliasing']
COMPILE_FLAGS += ['-fPIC']
COMPILE_FLAGS_MSVC = ['/Ox', '/fp:fast']

MACROS = [
    ('BSHUF_VERSION_MAJOR', VERSION_MAJOR),
    ('BSHUF_VERSION_MINOR', VERSION_MINOR),
    ('BSHUF_VERSION_POINT', VERSION_POINT),
]


H5PLUGINS_DEFAULT = '/usr/local/hdf5/lib/plugin'

# OSX's clang compliler does not support OpenMP.
if sys.platform == 'darwin':
    OMP_DEFAULT = False
else:
    OMP_DEFAULT = True

FALLBACK_CONFIG = {
    'include_dirs': [],
    'library_dirs': [],
    'libraries': [],
    'extra_compile_args': [],
    'extra_link_args': [],
}

if 'HDF5_DIR' in os.environ:
    FALLBACK_CONFIG['include_dirs'] += [os.environ['HDF5_DIR'] + '/include']  # macports
    FALLBACK_CONFIG['library_dirs'] += [os.environ['HDF5_DIR'] + '/lib']      # macports
elif sys.platform == 'darwin':
    # putting here both macports and homebrew paths will generate
    # "ld: warning: dir not found" at the linking phase
    FALLBACK_CONFIG['include_dirs'] += ['/opt/local/include']  # macports
    FALLBACK_CONFIG['library_dirs'] += ['/opt/local/lib']      # macports
    FALLBACK_CONFIG['include_dirs'] += ['/usr/local/include']  # homebrew
    FALLBACK_CONFIG['library_dirs'] += ['/usr/local/lib']      # homebrew
elif sys.platform.startswith('freebsd'):
    FALLBACK_CONFIG['include_dirs'] += ['/usr/local/include']  # homebrew
    FALLBACK_CONFIG['library_dirs'] += ['/usr/local/lib']      # homebrew

FALLBACK_CONFIG['include_dirs'] = [d for d in FALLBACK_CONFIG['include_dirs']
                                   if path.isdir(d)]
FALLBACK_CONFIG['library_dirs'] = [d for d in FALLBACK_CONFIG['library_dirs']
                                   if path.isdir(d)]

FALLBACK_CONFIG['extra_compile_args'] = ['-DH5_BUILT_AS_DYNAMIC_LIB']


def pkgconfig(*packages, **kw):
    config = kw.setdefault('config', {})
    optional_args = kw.setdefault('optional', '')
    flag_map = {'include_dirs': ['--cflags-only-I', 2],
                'library_dirs': ['--libs-only-L', 2],
                'libraries': ['--libs-only-l', 2],
                'extra_compile_args': ['--cflags-only-other', 0],
                'extra_link_args': ['--libs-only-other', 0],
                }
    for package in packages:
        try:
            subprocess.check_output(["pkg-config", package])
        except (subprocess.CalledProcessError, OSError):
            print("Can't find %s with pkg-config fallback to "
                  "static config" % package)
            for distutils_key in flag_map:
                config.setdefault(distutils_key, []).extend(
                    FALLBACK_CONFIG[distutils_key])
            config['libraries'].append(package)
        else:
            for distutils_key, (pkg_option, n) in flag_map.items():
                items = subprocess.check_output(
                    ['pkg-config', optional_args, pkg_option, package]
                ).decode('utf8').split()
                opt = config.setdefault(distutils_key, [])
                opt.extend([i[n:] for i in items])
    return config


ext_bshuf = Extension(
    "bitshuffle.ext",
    sources=["bitshuffle/ext.pyx", "src/bitshuffle.c",
             "src/bitshuffle_core.c", "src/iochain.c",
             "lz4/lz4.c"],
    include_dirs=["src/", "lz4/"],
    depends=["src/bitshuffle.h", "src/bitshuffle_core.h",
             "src/iochain.h", "lz4/lz4.h"],
    libraries=[],
    define_macros=MACROS,
)

h5filter = Extension(
    "bitshuffle.h5",
    sources=["bitshuffle/h5.pyx", "src/bshuf_h5filter.c",
             "src/bitshuffle.c", "src/bitshuffle_core.c",
             "src/iochain.c", "lz4/lz4.c"],
    depends=["src/bitshuffle.h", "src/bitshuffle_core.h",
             "src/iochain.h", "src/bshuf_h5filter.h",
             "lz4/lz4.h"],
    define_macros=MACROS,
    **pkgconfig("hdf5", config=dict(
        include_dirs=["src/", "lz4/"]))
)

filter_plugin = Extension(
    "bitshuffle.plugin.libh5bshuf",
    sources=["src/bshuf_h5plugin.c", "src/bshuf_h5filter.c",
             "src/bitshuffle.c", "src/bitshuffle_core.c",
             "src/iochain.c", "lz4/lz4.c"],
    depends=["src/bitshuffle.h", "src/bitshuffle_core.h",
             "src/iochain.h", 'src/bshuf_h5filter.h',
             "lz4/lz4.h"],
    define_macros=MACROS,
    **pkgconfig("hdf5", config=dict(
        include_dirs=["src/", "lz4/"]))
)

lzf_plugin = Extension(
    "bitshuffle.plugin.libh5LZF",
    sources=["src/lzf_h5plugin.c", "lzf/lzf_filter.c",
             "lzf/lzf/lzf_c.c", "lzf/lzf/lzf_d.c"],
    depends=["lzf/lzf_filter.h", "lzf/lzf/lzf.h",
             "lzf/lzf/lzfP.h"],
    **pkgconfig("hdf5", config=dict(
        include_dirs=["lzf/", "lzf/lzf/"]))
)


EXTENSIONS = [ext_bshuf, h5filter]
# Check for plugin hdf5 plugin support (hdf5 >= 1.8.11)
HDF5_PLUGIN_SUPPORT = False
CPATHS = os.environ['CPATH'].split(':') if 'CPATH' in os.environ else []
for p in ["/usr/include"] + pkgconfig("hdf5")["include_dirs"] + CPATHS:
    if os.path.exists(os.path.join(p, "H5PLextern.h")):
        HDF5_PLUGIN_SUPPORT = True

if HDF5_PLUGIN_SUPPORT:
    EXTENSIONS.extend([filter_plugin, lzf_plugin])


class develop(develop_):
    def run(self):
        # Dummy directory for copying build plugins.
        if not path.isdir('bitshuffle/plugin'):
            os.mkdir('bitshuffle/plugin')
        develop_.run(self)


# Custom installation to include installing dynamic filters.
class install(install_):
    user_options = install_.user_options + [
        ('h5plugin', None,
         'Install HDF5 filter plugins for use outside of python.'),
        ('h5plugin-dir=', None,
         'Where to install filter plugins. Default %s.' % H5PLUGINS_DEFAULT),
    ]

    def initialize_options(self):
        install_.initialize_options(self)
        self.h5plugin = False
        self.h5plugin_dir = H5PLUGINS_DEFAULT

    def finalize_options(self):
        install_.finalize_options(self)
        if self.h5plugin not in ('0', '1', True, False):
            raise ValueError("Invalid h5plugin argument. Mut be '0' or '1'.")
        self.h5plugin = int(self.h5plugin)
        self.h5plugin_dir = path.abspath(self.h5plugin_dir)

    def run(self):
        install_.run(self)
        if self.h5plugin:
            if not HDF5_PLUGIN_SUPPORT:
                print("HDF5 < 1.8.11, not installing filter plugins.")
                return
            plugin_build = path.join(self.build_lib, "bitshuffle", "plugin")
            try:
                os.makedirs(self.h5plugin_dir)
            except OSError as e:
                if e.args[0] == 17:
                    # Directory already exists, this is fine.
                    pass
                else:
                    raise
            plugin_libs = glob.glob(path.join(plugin_build, "*"))
            for plugin_lib in plugin_libs:
                plugin_name = path.split(plugin_lib)[1]
                shutil.copy2(plugin_lib,
                             path.join(self.h5plugin_dir, plugin_name))
            print("Installed HDF5 filter plugins to %s" % self.h5plugin_dir)


# Command line or site.cfg specification of OpenMP.
class build_ext(build_ext_):
    user_options = build_ext_.user_options + [
        ('omp=', None, "Whether to compile with OpenMP threading. Default"
         " on current system is %s." % str(OMP_DEFAULT))
    ]
    boolean_options = build_ext_.boolean_options + ['omp']

    def initialize_options(self):
        build_ext_.initialize_options(self)
        self.omp = OMP_DEFAULT

    def finalize_options(self):
        # For some reason this gets run twice. Careful to print messages and
        # add arguments only one time.
        build_ext_.finalize_options(self)

        if self.omp not in ('0', '1', True, False):
            raise ValueError("Invalid omp argument. Mut be '0' or '1'.")
        self.omp = int(self.omp)

        import numpy as np
        ext_bshuf.include_dirs.append(np.get_include())

        # Required only by old version of setuptools < 18.0
        from Cython.Build import cythonize
        self.extensions = cythonize(self.extensions)
        for ext in self.extensions:
            ext._needs_stub = False

    def build_extensions(self):
        c = self.compiler.compiler_type

        if self.omp not in ('0', '1', True, False):
            raise ValueError("Invalid omp argument. Mut be '0' or '1'.")
        self.omp = int(self.omp)

        if self.omp:
            if not hasattr(self, "_printed_omp_message"):
                self._printed_omp_message = True
                print("\n#################################")
                print("# Compiling with OpenMP support #")
                print("#################################\n")
            # More portable to pass -fopenmp to linker.
            # self.libraries += ['gomp']
            if self.compiler.compiler_type == 'msvc':
                openmpflag = '/openmp'
                compileflags = COMPILE_FLAGS_MSVC
            else:
                openmpflag = '-fopenmp'
                compileflags = COMPILE_FLAGS
            for e in self.extensions:
                e.extra_compile_args = list(set(e.extra_compile_args).union(compileflags))
                if openmpflag not in e.extra_compile_args:
                    e.extra_compile_args += [openmpflag]
                if openmpflag not in e.extra_link_args:
                    e.extra_link_args += [openmpflag]

        build_ext_.build_extensions(self)


# Don't install numpy/cython/hdf5 if not needed
for cmd in ["sdist", "clean",
            "--help", "--help-commands", "--version"]:
    if cmd in sys.argv:
        setup_requires = []
        break
else:
    setup_requires = ["Cython>=0.19", "numpy>=1.6.1"]

with open('requirements.txt') as f:
    requires = f.read().splitlines()
    requires = [r.split()[0] for r in requires]

with open('README.rst') as r:
    long_description = r.read()

# TODO hdf5 support should be an "extra". Figure out how to set this up.
setup(
    name='bitshuffle',
    version=VERSION,

    packages=['bitshuffle', 'bitshuffle.tests'],
    scripts=[],
    ext_modules=EXTENSIONS,
    cmdclass={'build_ext': build_ext, 'install': install, 'develop': develop},
    setup_requires=setup_requires,
    install_requires=requires,
    # extras_require={'H5':  ["h5py"]},
    package_data={'': ['data/*']},

    # metadata for upload to PyPI
    author="Kiyoshi Wesley Masui",
    author_email="kiyo@physics.ubc.ca",
    description="Bitshuffle filter for improving typed data compression.",
    long_description=long_description,
    license="MIT",
    url="https://github.com/kiyo-masui/bitshuffle",
    download_url=("https://github.com/kiyo-masui/bitshuffle/tarball/%s"
                  % VERSION),
    keywords=['compression', 'hdf5', 'numpy'],
)