setup.py 20 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
    global config_file, config_file_present

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

    #### Read build configuration file.
    configs = configparser.ConfigParser()
    try:
67
        with open(config_file) as f:
68
69
70
            configs.read_file(f)
    except IOError:
        config_file_present = False
71
72
73
74
        if config_file_option_present:
            print("Error: '{}' option was provided, but '{}' does not exist"
                  .format(config_file_option, config_file))
            sys.exit(1)
75
76
77
78
79
80
81
82
    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(
83
                    short, long, config_file))
84
                sys.exit(1)
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
            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:
111
                    build_summary.append(msg.format(config_file, name, key))
112
113
            kwargs[key] = value

114
        kwargs.setdefault('depends', []).append(config_file)
115
116
117
118
119
120
        if config is not defaultconfig:
            del configs[name]

    unknown_sections = configs.sections()
    if unknown_sections:
        print('Error: Unknown sections in file {}: {}'.format(
121
            config_file, ', '.join(unknown_sections)))
122
        sys.exit(1)
123
124
125
126

    return exts


127
128
129
130
131
132
133
134
135
136
def check_python_version(min_version):
    installed_version = sys.version_info[:3]
    if installed_version < min_version:
        print('Error: Python {} required, but {} is installed'.format(
              '.'.join(map(str, min_version)),
              '.'.join(map(str, installed_version)))
        )
        sys.exit(1)


137
def check_versions():
138
139
140
141
142
143
    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
144
    version_module = imp.load_source('version', 'kwant/version.py')
145
146
    sys.dont_write_bytecode = _dont_write_bytecode_saved

147
148
149
    version_module.ensure_python()
    version = version_module.version
    version_is_from_git = version_module.version_is_from_git
150
151
152


def init_cython():
153
154
155
156
157
158
159
160
161
162
163
164
165
166
    """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`.
    """
167
    global cythonize, cython_help
168

169
    cython_option = '--cython'
170
    required_cython_version = (0, 22)
171
    try:
172
        sys.argv.remove(cython_option)
173
        cythonize = True
174
    except ValueError:
175
        cythonize = version_is_from_git
176

177
    if cythonize:
178
179
180
181
        try:
            import Cython
            from Cython.Build import cythonize
        except ImportError:
182
            cythonize = None
183
        else:
184
            #### Get Cython version.
185
186
187
188
189
190
191
192
            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)
193

194
            if cython_version < required_cython_version:
195
196
                cythonize = None

197
198
199
200
201
        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)
202
203
    else:
        msg = "Run setup.py with the {} option to enable Cython."
204
        cython_help = msg.format(cython_option)
205

206

207
208
209
def banner(title=''):
    starred = title.center(79, '*')
    return '\n' + starred if title else starred
210

Christoph Groth's avatar
Christoph Groth committed
211

212
class build_ext(build_ext_orig):
Christoph Groth's avatar
Christoph Groth committed
213
    def run(self):
214
215
216
217
218
        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.
219
220
221
            with open(config_file, 'w') as f:
                f.write('# Build configuration created by setup.py '
                        '- feel free to modify.\n')
222

Christoph Groth's avatar
Christoph Groth committed
223
        try:
Christoph Groth's avatar
Christoph Groth committed
224
            super().run()
Christoph Groth's avatar
Christoph Groth committed
225
        except (DistutilsError, CCompilerError):
226
227
            error_msg = self.__error_msg.format(
                header=banner(' Error '), sep=banner())
228
            print(error_msg.format(file=config_file, summary=build_summary),
229
                  file=sys.stderr)
Christoph Groth's avatar
Christoph Groth committed
230
            raise
231
        print(banner(' Build summary '), *build_summary, sep='\n')
232
        print(banner())
Christoph Groth's avatar
Christoph Groth committed
233

234
235
236
237
238
239
240
241
242
243
244
    __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}
"""

245

246
class build(build_orig):
247
    def run(self):
Christoph Groth's avatar
Christoph Groth committed
248
        super().run()
249
250
        write_version(os.path.join(self.build_lib, *STATIC_VERSION_PATH))

251
252

def git_lsfiles():
253
    if not version_is_from_git:
254
255
        return

256
    try:
257
        p = subprocess.Popen(['git', 'ls-files'], cwd=distr_root,
258
259
260
261
262
263
                             stdout=subprocess.PIPE, stderr=subprocess.PIPE)
    except OSError:
        return

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


267
268
# Make the command "sdist" depend on "build".  This verifies that the
# distribution in the current state actually builds.  It also makes sure that
269
# the Cython-made C files will be up-to-date and included in the source.
270
271
class sdist(sdist_orig):
    sub_commands = [('build', None)] + sdist_orig.sub_commands
272
273

    def run(self):
Christoph Groth's avatar
Christoph Groth committed
274
275
276
277
278
279
280
281
282
        """
        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.
        """
283
284
        manifest_in_file = 'MANIFEST.in'
        manifest = os.path.join(distr_root, manifest_in_file)
285
286
        names = git_lsfiles()
        if names is None:
Christoph Groth's avatar
Christoph Groth committed
287
            if not (os.path.isfile(manifest) and os.access(manifest, os.R_OK)):
288
                print("Error:", manifest_in_file,
Christoph Groth's avatar
Christoph Groth committed
289
290
                      "file is missing and Git is not available"
                      " to regenerate it.", file=sys.stderr)
291
                sys.exit(1)
292
        else:
Christoph Groth's avatar
Christoph Groth committed
293
            with open(manifest, 'w') as f:
294
295
296
297
298
                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
299
                    f.write('include {}'.format(name))
300
                    if extension == 'pyx':
Christoph Groth's avatar
Christoph Groth committed
301
302
                        f.write(''.join([' ', a, sep, stem, dot, 'c']))
                    f.write('\n')
303

Christoph Groth's avatar
Christoph Groth committed
304
        super().run()
305
306

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

312
    def make_release_tree(self, base_dir, files):
Christoph Groth's avatar
Christoph Groth committed
313
        super().make_release_tree(base_dir, files)
314
        write_version(os.path.join(base_dir, *STATIC_VERSION_PATH))
315

Christoph Groth's avatar
Christoph Groth committed
316

Christoph Groth's avatar
Christoph Groth committed
317
318
# The following class is based on a recipe in
# http://doc.pytest.org/en/latest/goodpractices.html#manual-integration.
319
class test(test_orig):
Christoph Groth's avatar
Christoph Groth committed
320
321
322
323
324
325
326
327
    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
328
        try:
Christoph Groth's avatar
Christoph Groth committed
329
330
331
            import pytest
        except:
            print('The Python package "pytest" is required to run tests.',
332
                  file=sys.stderr)
333
            sys.exit(1)
Christoph Groth's avatar
Christoph Groth committed
334
335
        errno = pytest.main(shlex.split(self.pytest_args))
        sys.exit(errno)
336
337


338
339
340
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?
341
    try:
342
343
344
345
346
        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
347
        f.write("version = '{}'\n".format(version))
Christoph Groth's avatar
Christoph Groth committed
348
349


350
351
352
def long_description():
    text = []
    try:
Christoph Groth's avatar
Christoph Groth committed
353
        with open('README.rst', encoding='utf8') as f:
354
            for line in f:
355
                if line.startswith('See also in this directory:'):
356
357
                    break
                text.append(line.rstrip())
358
359
            while text[-1] == "":
                text.pop()
360
361
362
363
364
    except:
        return ''
    return '\n'.join(text)


365
def search_libs(libs):
366
367
368
    cmd = ['gcc']
    cmd.extend(['-l' + lib for lib in libs])
    cmd.extend(['-o/dev/null', '-xc', '-'])
Christoph Groth's avatar
Christoph Groth committed
369
    try:
370
        p = subprocess.Popen(cmd, stdin=subprocess.PIPE, stderr=subprocess.PIPE)
Christoph Groth's avatar
Christoph Groth committed
371
372
373
    except OSError:
        pass
    else:
374
        p.communicate(input=b'int main() {}\n')
375
        if p.wait() == 0:
376
377
378
379
380
381
382
383
384
385
386
387
388
389
            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
390
        # 'openblas' provides Lapack and BLAS symbols
391
        ['zmumps', 'mumps_common', 'metis', 'esmumps', 'scotch',
392
         'scotcherr', 'mpiseq', 'openblas'],
393
394
395
396
397
398
399
400
401
402
    ]
    common_libs = ['pord', 'gfortran']

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


403
404
405
406
def configure_special_extensions(exts, build_summary):
    #### Special config for MUMPS.
    mumps = exts['kwant.linalg._mumps']
    if 'libraries' in mumps:
Christoph Groth's avatar
Christoph Groth committed
407
408
        build_summary.append('User-configured MUMPS')
    else:
409
410
411
        mumps_libs = search_mumps()
        if mumps_libs:
            mumps['libraries'] = mumps_libs
412
            build_summary.append('Auto-configured MUMPS')
413
414
        else:
            mumps = None
415
            del exts['kwant.linalg._mumps']
416
            build_summary.append('No MUMPS support')
Christoph Groth's avatar
Christoph Groth committed
417

418
    return exts
Christoph Groth's avatar
Christoph Groth committed
419

420
421

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

424
425
    The argument `exts` must be a mapping of names to kwargs to be passed
    on to `Extension`.
426
427
428
429

    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.
430
    """
431
    if cythonize:
432
433
434
        return cythonize([Extension(name, **kwargs)
                          for name, kwargs in exts.items()],
                         language_level=3,
435
                         compiler_directives={'linetrace': True})
436
437
438
439

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

Christoph Groth's avatar
Christoph Groth committed
440
    result = []
441
    problematic_files = []
442
443
    for name, kwargs in exts.items():
        language = kwargs.get('language')
444
445
446
447
448
449
450
451
        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)
452
            sys.exit(1)
453
454
455

        pyx_files = []
        cythonized_files = []
456
457
        sources = []
        for f in kwargs['sources']:
458
459
460
461
            if f.endswith('.pyx'):
                pyx_files.append(f)
                f = f.rstrip('.pyx') + ext
                cythonized_files.append(f)
462
463
            sources.append(f)
        kwargs['sources'] = sources
464
465
466
467
468
469

        # 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:
470
471
472
            msg = "Cython-generated file {} is missing."
            print(banner(" Error "), msg.format(f), "",
                  cython_help, banner(), sep="\n", file=sys.stderr)
473
            sys.exit(1)
474

475
        for f in pyx_files + kwargs.get('depends', []):
476
            if f == config_file:
477
478
479
480
481
                # 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
482

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

485
    if problematic_files:
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
        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:
502
            sys.exit(1)
503

Christoph Groth's avatar
Christoph Groth committed
504
505
    return result

506

507
508
509
510
511
512
513
514
515
516
517
518
519
520
def maybe_add_numpy_include(exts):
    # 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)
    return exts


Christoph Groth's avatar
Christoph Groth committed
521
def main():
522
    check_python_version((3, 5))
523
524
    check_versions()

525
526
527
528
529
530
531
532
533
534
535
536
    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.linalg.lapack',
537
         dict(sources=['kwant/linalg/lapack.pyx'])),
538
539
540
541
        ('kwant.linalg._mumps',
         dict(sources=['kwant/linalg/_mumps.pyx'],
              depends=['kwant/linalg/cmumps.pxd']))])

542
    aliases = [('mumps', 'kwant.linalg._mumps')]
543

544
545
    init_cython()

546
    global build_summary
547
    build_summary = []
548
    exts = configure_extensions(exts, aliases, build_summary)
549
    exts = configure_special_extensions(exts, build_summary)
550
    exts = maybe_add_numpy_include(exts)
551
552
    exts = maybe_cythonize(exts)

553
554
555
556
557
558
559
560
561
562
563
564
    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
565
    setup(name='kwant',
566
          version=version,
567
568
          author='C. W. Groth (CEA), M. Wimmer, '
                 'A. R. Akhmerov, X. Waintal (CEA), and others',
569
          author_email='authors@kwant-project.org',
570
          description=("Package for numerical quantum transport calculations "
571
                       "(Python 3 version)"),
572
573
          long_description=long_description(),
          platforms=["Unix", "Linux", "Mac OS-X", "Windows"],
574
575
          url="http://kwant-project.org/",
          license="BSD",
576
          packages=find_packages('.'),
577
578
579
          cmdclass={'build': build,
                    'sdist': sdist,
                    'build_ext': build_ext,
580
                    'test': test},
581
          ext_modules=exts,
582
          install_requires=['numpy >= 1.11.0', 'scipy >= 0.17.0',
583
                            'tinyarray >= 1.2'],
584
          extras_require={
585
586
              # The oldest versions between: Debian stable, Ubuntu LTS
              'plotting': 'matplotlib >= 1.5.1',
587
588
              'continuum': 'sympy >= 0.7.6',
          },
589
          classifiers=[c.strip() for c in classifiers.split('\n')])
590

Christoph Groth's avatar
Christoph Groth committed
591
592
if __name__ == '__main__':
    main()