setup.py 21.1 KB
Newer Older
1
#!/usr/bin/env python3
2

3
# Copyright 2011-2017 Kwant authors.
4
#
Christoph Groth's avatar
Christoph Groth committed
5
6
# This file is part of Kwant.  It is subject to the license terms in the file
# LICENSE.rst found in the top-level directory of this distribution and at
7
# http://kwant-project.org/license.  A list of Kwant authors can be found in
Christoph Groth's avatar
Christoph Groth committed
8
# the file AUTHORS.rst at the top-level directory of this distribution and at
9
10
# http://kwant-project.org/authors.

11
12
from __future__ import print_function

Christoph Groth's avatar
Christoph Groth committed
13
import sys
14

15
import re
Christoph Groth's avatar
Christoph Groth committed
16
import os
17
import glob
18
import imp
Christoph Groth's avatar
Christoph Groth committed
19
import subprocess
20
import configparser
21
import collections
22
from setuptools import setup, find_packages, Extension, Command
23
from distutils.errors import DistutilsError, CCompilerError
24
25
26
from distutils.command.build import build as build_orig
from setuptools.command.sdist import sdist as sdist_orig
from setuptools.command.build_ext import build_ext as build_ext_orig
27
from setuptools.command.test import test as test_orig
28

Christoph Groth's avatar
Christoph Groth committed
29

30
STATIC_VERSION_PATH = ('kwant', '_kwant_version.py')
31

32
33
34
distr_root = os.path.dirname(os.path.abspath(__file__))


35
36
37
38
39
def configure_extensions(exts, aliases=(), build_summary=None):
    """Modify extension configuration according to the configuration file

    `exts` must be a dict of (name, kwargs) tuples that can be used like this:
    `Extension(name, **kwargs).  This function modifies the kwargs according to
40
41
42
    the configuration file.

    This function modifies `sys.argv`.
43
    """
44
45
46
47
48
49
50
51
52
53
    global config_file, config_file_present

    #### Determine the name of the configuration file.
    config_file_option = '--configfile'
    # Handle command line option
    for i, opt in enumerate(sys.argv):
        if not opt.startswith(config_file_option):
            continue
        l, _, config_file = opt.partition('=')
        if l != config_file_option or not config_file:
54
            print('Error: Expecting {}=PATH'.format(config_file_option),
55
                  file=sys.stderr)
56
            sys.exit(1)
57
58
59
60
        sys.argv.pop(i)
        break
    else:
        config_file = 'build.conf'
61
62
63
64

    #### Read build configuration file.
    configs = configparser.ConfigParser()
    try:
65
        with open(config_file) as f:
66
67
68
69
70
71
72
73
74
75
76
            configs.read_file(f)
    except IOError:
        config_file_present = False
    else:
        config_file_present = True

    #### Handle section aliases.
    for short, long in aliases:
        if short in configs:
            if long in configs:
                print('Error: both {} and {} sections present in {}.'.format(
77
                    short, long, config_file))
78
                sys.exit(1)
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
            configs[long] = configs[short]
            del configs[short]

    #### Apply config from file.  Use [DEFAULT] section for missing sections.
    defaultconfig = configs.defaults()
    for name, kwargs in exts.items():
        config = configs[name] if name in configs else defaultconfig
        for key, value in config.items():

            # Most, but not all, keys are lists of strings
            if key == 'language':
                pass
            elif key == 'optional':
                value = bool(int(value))
            else:
                value = value.split()

            if key == 'define_macros':
                value = [tuple(entry.split('=', maxsplit=1))
                         for entry in value]
                value = [(entry[0], None) if len(entry) == 1 else entry
                         for entry in value]

            if key in kwargs:
                msg = 'Caution: user config in file {} shadows {}.{}.'
                if build_summary is not None:
105
                    build_summary.append(msg.format(config_file, name, key))
106
107
            kwargs[key] = value

108
        kwargs.setdefault('depends', []).append(config_file)
109
110
111
112
113
114
        if config is not defaultconfig:
            del configs[name]

    unknown_sections = configs.sections()
    if unknown_sections:
        print('Error: Unknown sections in file {}: {}'.format(
115
            config_file, ', '.join(unknown_sections)))
116
        sys.exit(1)
117
118
119
120

    return exts


121
def check_versions():
122
123
124
125
126
127
    global version, version_is_from_git

    # Let Kwant itself determine its own version.  We cannot simply import
    # kwant, as it is not built yet.
    _dont_write_bytecode_saved = sys.dont_write_bytecode
    sys.dont_write_bytecode = True
128
    version_module = imp.load_source('version', 'kwant/version.py')
129
130
    sys.dont_write_bytecode = _dont_write_bytecode_saved

131
132
133
    version_module.ensure_python()
    version = version_module.version
    version_is_from_git = version_module.version_is_from_git
134
135
136


def init_cython():
137
138
139
140
141
142
143
144
145
146
147
148
149
150
    """Set the global variable `cythonize` (and other related globals).

    The variable `cythonize` can be in three states:

    * If Cython should be run and is ready, it contains the `cythonize()`
      function.

    * If Cython is not to be run, it contains `False`.

    * If Cython should, but cannot be run it contains `None`.  A help message
      on how to solve the problem is stored in `cython_help`.

    This function modifies `sys.argv`.
    """
151
    global cythonize, cython_help
152

153
    cython_option = '--cython'
154
    required_cython_version = (0, 22)
155
    try:
156
        sys.argv.remove(cython_option)
157
        cythonize = True
158
    except ValueError:
159
        cythonize = version_is_from_git
160

161
    if cythonize:
162
163
164
165
        try:
            import Cython
            from Cython.Build import cythonize
        except ImportError:
166
            cythonize = None
167
        else:
168
            #### Get Cython version.
169
170
171
172
173
174
175
176
            match = re.match('([0-9.]*)(.*)', Cython.__version__)
            cython_version = [int(n) for n in match.group(1).split('.')]
            # Decrease version if the version string contains a suffix.
            if match.group(2):
                while cython_version[-1] == 0:
                    cython_version.pop()
                cython_version[-1] -= 1
            cython_version = tuple(cython_version)
177

178
            if cython_version < required_cython_version:
179
180
                cythonize = None

181
182
183
184
185
        if cythonize is None:
            msg = ("Install Cython >= {0} or use"
                    " a source distribution (tarball) of Kwant.")
            ver = '.'.join(str(e) for e in required_cython_version)
            cython_help = msg.format(ver)
186
187
    else:
        msg = "Run setup.py with the {} option to enable Cython."
188
        cython_help = msg.format(cython_option)
189

190

191
192
193
def banner(title=''):
    starred = title.center(79, '*')
    return '\n' + starred if title else starred
194

Christoph Groth's avatar
Christoph Groth committed
195

196
class build_ext(build_ext_orig):
Christoph Groth's avatar
Christoph Groth committed
197
    def run(self):
198
199
200
201
202
        if not config_file_present:
            # Create an empty config file if none is present so that the
            # extensions will not be rebuilt each time.  Only depending on the
            # config file if it is present would make it impossible to detect a
            # necessary rebuild due to a deleted config file.
203
204
205
            with open(config_file, 'w') as f:
                f.write('# Build configuration created by setup.py '
                        '- feel free to modify.\n')
206

Christoph Groth's avatar
Christoph Groth committed
207
        try:
Christoph Groth's avatar
Christoph Groth committed
208
            super().run()
Christoph Groth's avatar
Christoph Groth committed
209
        except (DistutilsError, CCompilerError):
210
211
            error_msg = self.__error_msg.format(
                header=banner(' Error '), sep=banner())
212
            print(error_msg.format(file=config_file, summary=build_summary),
213
                  file=sys.stderr)
Christoph Groth's avatar
Christoph Groth committed
214
            raise
215
        print(banner(' Build summary '), *build_summary, sep='\n')
216
        print(banner())
Christoph Groth's avatar
Christoph Groth committed
217

218
219
220
221
222
223
224
225
226
227
228
    __error_msg = """{header}
The compilation of Kwant has failed.  Please examine the error message
above and consult the installation instructions in README.rst.
You might have to customize {{file}}.

Build configuration was:

{{summary}}
{sep}
"""

229

230
class build(build_orig):
231
    def run(self):
Christoph Groth's avatar
Christoph Groth committed
232
        super().run()
233
234
        write_version(os.path.join(self.build_lib, *STATIC_VERSION_PATH))

235
236

def git_lsfiles():
237
    if not version_is_from_git:
238
239
        return

240
    try:
241
        p = subprocess.Popen(['git', 'ls-files'], cwd=distr_root,
242
243
244
245
246
247
                             stdout=subprocess.PIPE, stderr=subprocess.PIPE)
    except OSError:
        return

    if p.wait() != 0:
        return
Joseph Weston's avatar
Joseph Weston committed
248
    return p.communicate()[0].decode().split('\n')[:-1]
249
250


251
252
253
254
# Make the command "sdist" depend on "build".  This verifies that the
# distribution in the current state actually builds.  It also makes sure that
# the Cython-made C files and the tutorial will be included in the source
# distribution and that they will be up-to-date.
255
256
class sdist(sdist_orig):
    sub_commands = [('build', None)] + sdist_orig.sub_commands
257
258

    def run(self):
Christoph Groth's avatar
Christoph Groth committed
259
260
261
262
263
264
265
266
267
        """
        Create MANIFEST.in from git if possible, otherwise check that MANIFEST.in
        is present.

        Right now (2015) generating MANIFEST.in seems to be the only way to
        include files in the source distribution that setuptools does not think
        should be there.  Setting include_package_data to True makes setuptools
        include *.pyx and other source files in the binary distribution.
        """
268
269
        manifest_in_file = 'MANIFEST.in'
        manifest = os.path.join(distr_root, manifest_in_file)
270
271
        names = git_lsfiles()
        if names is None:
Christoph Groth's avatar
Christoph Groth committed
272
            if not (os.path.isfile(manifest) and os.access(manifest, os.R_OK)):
273
                print("Error:", manifest_in_file,
Christoph Groth's avatar
Christoph Groth committed
274
275
                      "file is missing and Git is not available"
                      " to regenerate it.", file=sys.stderr)
276
                sys.exit(1)
277
        else:
Christoph Groth's avatar
Christoph Groth committed
278
            with open(manifest, 'w') as f:
279
280
281
282
283
                for name in names:
                    a, sep, b = name.rpartition('/')
                    if b == '.gitignore':
                        continue
                    stem, dot, extension = b.rpartition('.')
Christoph Groth's avatar
Christoph Groth committed
284
                    f.write('include {}'.format(name))
285
                    if extension == 'pyx':
Christoph Groth's avatar
Christoph Groth committed
286
287
                        f.write(''.join([' ', a, sep, stem, dot, 'c']))
                    f.write('\n')
288

Christoph Groth's avatar
Christoph Groth committed
289
        super().run()
290
291

        if names is None:
292
293
            msg = ("Git was not available to generate the list of files to be "
                   "included in the\nsource distribution. The old {} was used.")
294
            msg = msg.format(manifest_in_file)
295
            print(banner(' Caution '), msg, banner(), sep='\n', file=sys.stderr)
296

297
    def make_release_tree(self, base_dir, files):
Christoph Groth's avatar
Christoph Groth committed
298
        super().make_release_tree(base_dir, files)
299
        write_version(os.path.join(base_dir, *STATIC_VERSION_PATH))
300

Christoph Groth's avatar
Christoph Groth committed
301

Christoph Groth's avatar
Christoph Groth committed
302
303
# The following class is based on a recipe in
# http://doc.pytest.org/en/latest/goodpractices.html#manual-integration.
304
class test(test_orig):
Christoph Groth's avatar
Christoph Groth committed
305
306
307
308
309
310
311
312
    user_options = [('pytest-args=', 'a', "Arguments to pass to pytest")]

    def initialize_options(self):
        super().initialize_options()
        self.pytest_args = ''

    def run_tests(self):
        import shlex
313
        try:
Christoph Groth's avatar
Christoph Groth committed
314
315
316
            import pytest
        except:
            print('The Python package "pytest" is required to run tests.',
317
                  file=sys.stderr)
318
            sys.exit(1)
Christoph Groth's avatar
Christoph Groth committed
319
320
        errno = pytest.main(shlex.split(self.pytest_args))
        sys.exit(errno)
321
322


323
324
325
def write_version(fname):
    # This could be a hard link, so try to delete it first.  Is there any way
    # to do this atomically together with opening?
326
    try:
327
328
329
330
331
        os.remove(fname)
    except OSError:
        pass
    with open(fname, 'w') as f:
        f.write("# This file has been created by setup.py.\n")
Christoph Groth's avatar
Christoph Groth committed
332
        f.write("version = '{}'\n".format(version))
Christoph Groth's avatar
Christoph Groth committed
333
334


335
336
337
def long_description():
    text = []
    try:
Christoph Groth's avatar
Christoph Groth committed
338
        with open('README.rst', encoding='utf8') as f:
339
            for line in f:
340
                if line.startswith('See also in this directory:'):
341
342
                    break
                text.append(line.rstrip())
343
344
            while text[-1] == "":
                text.pop()
345
346
347
348
349
    except:
        return ''
    return '\n'.join(text)


350
def search_libs(libs):
351
352
353
    cmd = ['gcc']
    cmd.extend(['-l' + lib for lib in libs])
    cmd.extend(['-o/dev/null', '-xc', '-'])
Christoph Groth's avatar
Christoph Groth committed
354
    try:
355
        p = subprocess.Popen(cmd, stdin=subprocess.PIPE, stderr=subprocess.PIPE)
Christoph Groth's avatar
Christoph Groth committed
356
357
358
    except OSError:
        pass
    else:
359
        p.communicate(input=b'int main() {}\n')
360
        if p.wait() == 0:
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
            return libs


def search_mumps():
    """Return the configuration for MUMPS if it is available in a known way.

    This is known to work with the MUMPS provided by the Debian package
    libmumps-scotch-dev and the MUMPS binaries in the conda-forge channel."""
    lib_sets = [
        # Debian
        ['zmumps_scotch', 'mumps_common_scotch', 'mpiseq_scotch'],
        # Conda (via conda-forge).
        # TODO: remove dependency libs (scotch, metis...) when conda-forge
        # packaged mumps/scotch are built as properly linked shared libs
        ['zmumps', 'mumps_common', 'metis', 'esmumps', 'scotch',
376
         'scotcherr', 'mpiseq'],
377
378
379
380
381
382
383
384
385
386
    ]
    common_libs = ['pord', 'gfortran']

    for libs in lib_sets:
        found_libs = search_libs(libs + common_libs)
        if found_libs:
            return found_libs
    return []


387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
def search_lapack():
    """Return the BLAS variant that is installed."""
    lib_sets = [
        # Debian
        ['blas', 'lapack'],
        # Conda (via conda-forge). Openblas contains lapack symbols
        ['openblas', 'gfortran'],
    ]

    for libs in lib_sets:
        found_libs = search_libs(libs)
        if found_libs:
            return found_libs

    print('Error: BLAS/LAPACK are required but were not found.',
          file=sys.stderr)
    sys.exit(1)


406
def configure_special_extensions(exts, build_summary):
407
408
409
410
411
412
413
414
    #### Special config for LAPACK.
    lapack = exts['kwant.linalg.lapack']
    if 'libraries' in lapack:
        build_summary.append('User-configured LAPACK and BLAS')
    else:
        lapack['libraries'] = search_lapack()
        build_summary.append('Default LAPACK and BLAS')

415
416
417
    #### Special config for MUMPS.
    mumps = exts['kwant.linalg._mumps']
    if 'libraries' in mumps:
Christoph Groth's avatar
Christoph Groth committed
418
419
        build_summary.append('User-configured MUMPS')
    else:
420
421
422
        mumps_libs = search_mumps()
        if mumps_libs:
            mumps['libraries'] = mumps_libs
423
            build_summary.append('Auto-configured MUMPS')
424
425
        else:
            mumps = None
426
            del exts['kwant.linalg._mumps']
427
            build_summary.append('No MUMPS support')
Christoph Groth's avatar
Christoph Groth committed
428

429
430
431
432
433
434
    if mumps:
        # Copy config from LAPACK.
        for key, value in lapack.items():
            if key not in ['sources', 'depends']:
                mumps.setdefault(key, []).extend(value)

435
    return exts
Christoph Groth's avatar
Christoph Groth committed
436

437
438

def maybe_cythonize(exts):
439
    """Prepare a list of `Extension` instances, ready for `setup()`.
440

441
442
    The argument `exts` must be a mapping of names to kwargs to be passed
    on to `Extension`.
443
444
445
446

    If Cython is to be run, create the extensions and calls `cythonize()` on
    them.  If Cython is not to be run, replace .pyx file with .c or .cpp,
    check timestamps, and create the extensions.
447
    """
448
    if cythonize:
449
450
451
        return cythonize([Extension(name, **kwargs)
                          for name, kwargs in exts.items()],
                         language_level=3,
452
                         compiler_directives={'linetrace': True})
453
454
455
456

    # Cython is not going to be run: replace pyx extension by that of
    # the shipped translated file.

Christoph Groth's avatar
Christoph Groth committed
457
    result = []
458
    problematic_files = []
459
460
    for name, kwargs in exts.items():
        language = kwargs.get('language')
461
462
463
464
465
466
467
468
        if language is None:
            ext = '.c'
        elif language == 'c':
            ext = '.c'
        elif language == 'c++':
            ext = '.cpp'
        else:
            print('Unknown language: {}'.format(language), file=sys.stderr)
469
            sys.exit(1)
470
471
472

        pyx_files = []
        cythonized_files = []
473
474
        sources = []
        for f in kwargs['sources']:
475
476
477
478
            if f.endswith('.pyx'):
                pyx_files.append(f)
                f = f.rstrip('.pyx') + ext
                cythonized_files.append(f)
479
480
            sources.append(f)
        kwargs['sources'] = sources
481
482
483
484
485
486

        # Complain if cythonized files are older than Cython source files.
        try:
            cythonized_oldest = min(os.stat(f).st_mtime
                                    for f in cythonized_files)
        except OSError:
487
488
489
            msg = "Cython-generated file {} is missing."
            print(banner(" Error "), msg.format(f), "",
                  cython_help, banner(), sep="\n", file=sys.stderr)
490
            sys.exit(1)
491

492
        for f in pyx_files + kwargs.get('depends', []):
493
            if f == config_file:
494
495
496
497
498
                # The config file is only a dependency for the compilation
                # of the cythonized file, not for the cythonization.
                continue
            if os.stat(f).st_mtime > cythonized_oldest:
                problematic_files.append(f)
Christoph Groth's avatar
Christoph Groth committed
499

500
        result.append(Extension(name, **kwargs))
Christoph Groth's avatar
Christoph Groth committed
501

502
    if problematic_files:
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
        msg = ("Some Cython source files are newer than files that have "
               "been derived from them:\n{}")
        msg = msg.format(", ".join(problematic_files))

        # Cython should be run but won't.  Signal an error if this is because
        # Cython *cannot* be run, warn otherwise.
        error = cythonize is None
        if cythonize is False:
            dontworry = ('(Do not worry about this if you are building Kwant '
                         'from unmodified sources,\n'
                         'e.g. with "pip install".)\n\n')
            msg = dontworry + msg

        print(banner(" Error " if error else " Caution "), msg, "",
              cython_help, banner(), sep="\n", file=sys.stderr)
        if error:
519
            sys.exit(1)
520

Christoph Groth's avatar
Christoph Groth committed
521
522
    return result

523

Christoph Groth's avatar
Christoph Groth committed
524
def main():
525
526
    check_versions()

527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
    exts = collections.OrderedDict([
        ('kwant._system',
         dict(sources=['kwant/_system.pyx'],
              include_dirs=['kwant/graph'])),
        ('kwant.operator',
         dict(sources=['kwant/operator.pyx'],
              include_dirs=['kwant/graph'])),
        ('kwant.graph.core',
         dict(sources=['kwant/graph/core.pyx'],
              depends=['kwant/graph/core.pxd', 'kwant/graph/defs.h',
                       'kwant/graph/defs.pxd'])),
        ('kwant.graph.utils',
         dict(sources=['kwant/graph/utils.pyx'],
              depends=['kwant/graph/defs.h', 'kwant/graph/defs.pxd',
                       'kwant/graph/core.pxd'])),
        ('kwant.graph.slicer',
         dict(sources=['kwant/graph/slicer.pyx',
                       'kwant/graph/c_slicer/partitioner.cc',
                       'kwant/graph/c_slicer/slicer.cc'],
              depends=['kwant/graph/defs.h', 'kwant/graph/defs.pxd',
                       'kwant/graph/core.pxd', 'kwant/graph/c_slicer.pxd',
                       'kwant/graph/c_slicer/bucket_list.h',
                       'kwant/graph/c_slicer/graphwrap.h',
                       'kwant/graph/c_slicer/partitioner.h',
                       'kwant/graph/c_slicer/slicer.h'])),
        ('kwant.linalg.lapack',
553
554
         dict(sources=['kwant/linalg/lapack.pyx'],
              depends=['kwant/linalg/f_lapack.pxd'])),
555
556
557
558
        ('kwant.linalg._mumps',
         dict(sources=['kwant/linalg/_mumps.pyx'],
              depends=['kwant/linalg/cmumps.pxd']))])

559
560
561
562
563
564
565
566
567
568
569
    # Add NumPy header path to include_dirs of all the extensions.
    try:
        import numpy
    except ImportError:
        print(banner(' Caution '), 'NumPy header directory cannot be determined'
              ' ("import numpy" failed).', banner(), sep='\n', file=sys.stderr)
    else:
        numpy_include = numpy.get_include()
        for ext in exts.values():
            ext.setdefault('include_dirs', []).append(numpy_include)

570
571
    aliases = [('lapack', 'kwant.linalg.lapack'),
               ('mumps', 'kwant.linalg._mumps')]
572

573
574
    init_cython()

575
    global build_summary
576
    build_summary = []
577
    exts = configure_extensions(exts, aliases, build_summary)
578
579
580
    exts = configure_special_extensions(exts, build_summary)
    exts = maybe_cythonize(exts)

581
582
583
584
585
586
587
588
589
590
591
592
    classifiers = """\
        Development Status :: 5 - Production/Stable
        Intended Audience :: Science/Research
        Intended Audience :: Developers
        Programming Language :: Python :: 3 :: Only
        Topic :: Software Development
        Topic :: Scientific/Engineering
        Operating System :: POSIX
        Operating System :: Unix
        Operating System :: MacOS :: MacOS X
        Operating System :: Microsoft :: Windows"""

Christoph Groth's avatar
Christoph Groth committed
593
    setup(name='kwant',
594
          version=version,
595
596
          author='C. W. Groth (CEA), M. Wimmer, '
                 'A. R. Akhmerov, X. Waintal (CEA), and others',
597
          author_email='authors@kwant-project.org',
598
          description=("Package for numerical quantum transport calculations "
599
                       "(Python 3 version)"),
600
601
          long_description=long_description(),
          platforms=["Unix", "Linux", "Mac OS-X", "Windows"],
602
603
          url="http://kwant-project.org/",
          license="BSD",
604
          packages=find_packages('.'),
605
606
607
          cmdclass={'build': build,
                    'sdist': sdist,
                    'build_ext': build_ext,
608
                    'test': test},
609
          ext_modules=exts,
610
611
          install_requires=['numpy >= 1.8.1', 'scipy >= 0.14',
                            'tinyarray >= 1.2'],
612
          extras_require={
613
              'plotting': 'matplotlib >= 1.4.2',
614
615
616
              # Ubuntu 16.04 is the oldest supported distro with python3-sympy
              'continuum': 'sympy >= 0.7.6',
          },
617
          classifiers=[c.strip() for c in classifiers.split('\n')])
618

Christoph Groth's avatar
Christoph Groth committed
619
620
if __name__ == '__main__':
    main()