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

3
# Copyright 2011-2016 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
from __future__ import print_function
Christoph Groth's avatar
Christoph Groth committed
12
13

import sys
14

15
16
17
18
19
20
21
22
23
24
25
def ensure_python(required_version):
    v = sys.version_info
    if v[:3] < required_version:
        error = "This version of Kwant requires Python {} or above.".format(
            ".".join(str(p) for p in required_version))
        if v[0] == 2:
            error += "\nKwant 1.1 is the last version to support Python 2."
        print(error, file=sys.stderr)
        sys.exit(1)

ensure_python((3, 4))
26

27
import re
Christoph Groth's avatar
Christoph Groth committed
28
import os
29
import glob
30
import imp
Christoph Groth's avatar
Christoph Groth committed
31
import subprocess
32
import configparser
33
import collections
34
from setuptools import setup, find_packages, Extension, Command
Christoph Groth's avatar
Christoph Groth committed
35
from sysconfig import get_platform
Christoph Groth's avatar
Christoph Groth committed
36
37
from distutils.errors import DistutilsError, DistutilsModuleError, \
    CCompilerError
38
from distutils.command.build import build
Christoph Groth's avatar
Christoph Groth committed
39
40
from setuptools.command.sdist import sdist
from setuptools.command.build_ext import build_ext
41

Christoph Groth's avatar
Christoph Groth committed
42

43
44
CONFIG_FILE = 'build.conf'
README_FILE = 'README.rst'
Christoph Groth's avatar
Christoph Groth committed
45
MANIFEST_IN_FILE = 'MANIFEST.in'
46
README_END_BEFORE = 'See also in this directory:'
47
STATIC_VERSION_PATH = ('kwant', '_kwant_version.py')
Christoph Groth's avatar
Christoph Groth committed
48
REQUIRED_CYTHON_VERSION = (0, 22)
49
CYTHON_OPTION = '--cython'
50
51
52
TUT_DIR = 'tutorial'
TUT_GLOB = 'doc/source/tutorial/*.py'
TUT_HIDDEN_PREFIX = '#HIDDEN'
Joseph Weston's avatar
Joseph Weston committed
53
CLASSIFIERS = """\
54
    Development Status :: 5 - Production/Stable
Joseph Weston's avatar
Joseph Weston committed
55
56
57
58
59
60
61
62
63
64
    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"""

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
EXTENSIONS = [
    ('kwant._system',
     {'sources': ['kwant/_system.pyx'],
      'include_dirs': ['kwant/graph']}),

    ('kwant.operator',
     {'sources': ['kwant/operator.pyx'],
      'include_dirs': ['kwant/graph']}),

    ('kwant.graph.core',
     {'sources': ['kwant/graph/core.pyx'],
      'depends': ['kwant/graph/core.pxd', 'kwant/graph/defs.h',
                  'kwant/graph/defs.pxd']}),

    ('kwant.graph.utils',
     {'sources': ['kwant/graph/utils.pyx'],
      'depends': ['kwant/graph/defs.h', 'kwant/graph/defs.pxd',
                  'kwant/graph/core.pxd']}),

    ('kwant.graph.slicer',
     {'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',
     {'sources': ['kwant/linalg/lapack.pyx'],
      'depends': ['kwant/linalg/f_lapack.pxd']}),

    ('kwant.linalg._mumps',
     {'sources': ['kwant/linalg/_mumps.pyx'],
      'depends': ['kwant/linalg/cmumps.pxd']})]

EXTENSION_ALIASES = [('lapack', 'kwant.linalg.lapack'),
                     ('mumps', 'kwant.linalg._mumps')]
107

108
109
110
distr_root = os.path.dirname(os.path.abspath(__file__))


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
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
    the configuration file `CONFIG_FILE`.
    """
    global config_file_present

    #### Read build configuration file.
    configs = configparser.ConfigParser()
    try:
        with open(CONFIG_FILE) as f:
            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(
                    short, long, CONFIG_FILE))
                exit(1)
            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:
                    build_summary.append(msg.format(CONFIG_FILE, name, key))
            kwargs[key] = value

        kwargs.setdefault('depends', []).append(CONFIG_FILE)
        if config is not defaultconfig:
            del configs[name]

    unknown_sections = configs.sections()
    if unknown_sections:
        print('Error: Unknown sections in file {}: {}'.format(
            CONFIG_FILE, ', '.join(unknown_sections)))
        exit(1)

    return exts


179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
def get_version():
    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
    _common = imp.load_source('_common', 'kwant/_common.py')
    sys.dont_write_bytecode = _dont_write_bytecode_saved

    version = _common.version
    version_is_from_git = _common.version_is_from_git


def init_cython():
194
195
196
197
198
199
200
201
202
203
204
205
206
207
    """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`.
    """
208
    global cythonize, cython_help
209

210
    try:
211
        sys.argv.remove(CYTHON_OPTION)
212
        cythonize = True
213
    except ValueError:
214
        cythonize = version_is_from_git
215

216
    if cythonize:
217
218
219
220
        try:
            import Cython
            from Cython.Build import cythonize
        except ImportError:
221
            cythonize = None
222
        else:
223
            #### Get Cython version.
224
225
226
227
228
229
230
231
            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)
232

233
234
235
236
237
238
239
240
241
242
243
244
            if cython_version < REQUIRED_CYTHON_VERSION:
                cythonize = None

            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)
    else:
        msg = "Run setup.py with the {} option to enable Cython."
        cython_help = msg.format(CYTHON_OPTION)

245

246
247
248
def banner(title=''):
    starred = title.center(79, '*')
    return '\n' + starred if title else starred
249

Christoph Groth's avatar
Christoph Groth committed
250

Christoph Groth's avatar
Christoph Groth committed
251
252
class kwant_build_ext(build_ext):
    def run(self):
253
254
255
256
257
258
259
260
        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.
            with open(CONFIG_FILE, 'w') as f:
                f.write('# Created by setup.py - feel free to modify.\n')

Christoph Groth's avatar
Christoph Groth committed
261
262
263
        try:
            build_ext.run(self)
        except (DistutilsError, CCompilerError):
264
265
            error_msg = self.__error_msg.format(
                header=banner(' Error '), sep=banner())
266
267
            print(error_msg.format(file=CONFIG_FILE, summary=build_summary),
                  file=sys.stderr)
Christoph Groth's avatar
Christoph Groth committed
268
            raise
269
        print(banner(' Build summary '), *build_summary, sep='\n')
270
        print(banner())
Christoph Groth's avatar
Christoph Groth committed
271

272
273
274
275
276
277
278
279
280
281
282
    __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}
"""

283

284
class kwant_build_tut(Command):
285
286
287
288
289
290
291
292
293
294
295
296
297
298
    description = "build the tutorial scripts"
    user_options = []

    def initialize_options(self):
        pass

    def finalize_options(self):
        pass

    def run(self):
        if not os.path.exists(TUT_DIR):
            os.mkdir(TUT_DIR)
        for in_fname in glob.glob(TUT_GLOB):
            out_fname = os.path.join(TUT_DIR, os.path.basename(in_fname))
299
300
301
302
303
            with open(in_fname) as in_file:
                with open(out_fname, 'w') as out_file:
                    for line in in_file:
                        if not line.startswith(TUT_HIDDEN_PREFIX):
                            out_file.write(line)
304
305
306
307
308
309


# Our version of the "build" command also makes sure the tutorial is made.
# Even though the tutorial is not necessary for installation, and "build" is
# supposed to make everything needed to install, this is a robust way to ensure
# that the tutorial is present.
310
311
class kwant_build(build):
    sub_commands = [('build_tut', None)] + build.sub_commands
312

313
    def run(self):
314
        build.run(self)
315
316
        write_version(os.path.join(self.build_lib, *STATIC_VERSION_PATH))

317
318

def git_lsfiles():
319
    if not version_is_from_git:
320
321
        return

322
    try:
323
        p = subprocess.Popen(['git', 'ls-files'], cwd=distr_root,
324
325
326
327
328
329
                             stdout=subprocess.PIPE, stderr=subprocess.PIPE)
    except OSError:
        return

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


333
334
335
336
# 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.
337
338
class kwant_sdist(sdist):
    sub_commands = [('build', None)] + sdist.sub_commands
339
340

    def run(self):
Christoph Groth's avatar
Christoph Groth committed
341
342
343
344
345
346
347
348
349
350
        """
        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.
        """
        manifest = os.path.join(distr_root, MANIFEST_IN_FILE)
351
352
        names = git_lsfiles()
        if names is None:
Christoph Groth's avatar
Christoph Groth committed
353
354
355
356
            if not (os.path.isfile(manifest) and os.access(manifest, os.R_OK)):
                print("Error:", MANIFEST_IN_FILE,
                      "file is missing and Git is not available"
                      " to regenerate it.", file=sys.stderr)
357
358
                exit(1)
        else:
Christoph Groth's avatar
Christoph Groth committed
359
            with open(manifest, 'w') as f:
360
361
362
363
364
                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
365
                    f.write('include {}'.format(name))
366
                    if extension == 'pyx':
Christoph Groth's avatar
Christoph Groth committed
367
368
                        f.write(''.join([' ', a, sep, stem, dot, 'c']))
                    f.write('\n')
369

370
        sdist.run(self)
371
372

        if names is None:
373
374
375
376
            msg = ("Git was not available to generate the list of files to be "
                   "included in the\nsource distribution. The old {} was used.")
            msg = msg.format(MANIFEST_IN_FILE)
            print(banner(' Caution '), msg, banner(), sep='\n', file=sys.stderr)
377

378
    def make_release_tree(self, base_dir, files):
379
        sdist.make_release_tree(self, base_dir, files)
380
        write_version(os.path.join(base_dir, *STATIC_VERSION_PATH))
381

Christoph Groth's avatar
Christoph Groth committed
382

383
384
385
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?
386
    try:
387
388
389
390
391
        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
392
        f.write("version = '{}'\n".format(version))
Christoph Groth's avatar
Christoph Groth committed
393
394


395
396
397
398
399
def long_description():
    text = []
    try:
        with open(README_FILE) as f:
            for line in f:
400
                if line.startswith(README_END_BEFORE):
401
402
                    break
                text.append(line.rstrip())
403
404
            while text[-1] == "":
                text.pop()
405
406
407
408
409
    except:
        return ''
    return '\n'.join(text)


410
411
412
413
414
415
416
417
418
419
420
421
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."""

    libs = ['zmumps_scotch', 'mumps_common_scotch', 'pord', 'mpiseq_scotch',
            'gfortran']

    cmd = ['gcc']
    cmd.extend(['-l' + lib for lib in libs])
    cmd.extend(['-o/dev/null', '-xc', '-'])
Christoph Groth's avatar
Christoph Groth committed
422
    try:
423
        p = subprocess.Popen(cmd, stdin=subprocess.PIPE, stderr=subprocess.PIPE)
Christoph Groth's avatar
Christoph Groth committed
424
425
426
    except OSError:
        pass
    else:
427
        p.communicate(input=b'int main() {}\n')
428
429
        if p.wait() == 0:
            return {'libraries': libs}
Christoph Groth's avatar
Christoph Groth committed
430
431
432
    return {}


433
434
435
436
def configure_special_extensions(exts, build_summary):
    #### Special config for LAPACK.
    lapack = exts['kwant.linalg.lapack']
    if 'libraries' in lapack:
Christoph Groth's avatar
Christoph Groth committed
437
438
        build_summary.append('User-configured LAPACK and BLAS')
    else:
439
        lapack['libraries'] = ['lapack', 'blas']
Christoph Groth's avatar
Christoph Groth committed
440
        build_summary.append('Default LAPACK and BLAS')
441
442
443
444

    #### Special config for MUMPS.
    mumps = exts['kwant.linalg._mumps']
    if 'libraries' in mumps:
Christoph Groth's avatar
Christoph Groth committed
445
446
        build_summary.append('User-configured MUMPS')
    else:
447
448
449
450
        kwargs = search_mumps()
        if kwargs:
            for key, value in kwargs.items():
                mumps.setdefault(key, []).extend(value)
451
            build_summary.append('Auto-configured MUMPS')
452
453
454
455
        else:
            mumps = None
            del exts['mumps']
            build_summary.append('No MUMPS support')
Christoph Groth's avatar
Christoph Groth committed
456

457
458
459
460
461
    if mumps:
        # Copy config from LAPACK.
        for key, value in lapack.items():
            if key not in ['sources', 'depends']:
                mumps.setdefault(key, []).extend(value)
Christoph Groth's avatar
Christoph Groth committed
462

463
    return exts
Christoph Groth's avatar
Christoph Groth committed
464

465
466

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

469
470
    The argument `exts` must be a mapping of names to kwargs to be passed
    on to `Extension`.
471
472
473
474

    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.
475
    """
476
    if cythonize:
477
478
479
        return cythonize([Extension(name, **kwargs)
                          for name, kwargs in exts.items()],
                         language_level=3,
480
                         compiler_directives={'linetrace': True})
481
482
483
484

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

Christoph Groth's avatar
Christoph Groth committed
485
    result = []
486
    problematic_files = []
487
488
    for name, kwargs in exts.items():
        language = kwargs.get('language')
489
490
491
492
493
494
495
496
497
498
499
500
        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)
            exit(1)

        pyx_files = []
        cythonized_files = []
501
502
        sources = []
        for f in kwargs['sources']:
503
504
505
506
            if f.endswith('.pyx'):
                pyx_files.append(f)
                f = f.rstrip('.pyx') + ext
                cythonized_files.append(f)
507
508
            sources.append(f)
        kwargs['sources'] = sources
509
510
511
512
513
514

        # 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:
515
516
517
            msg = "Cython-generated file {} is missing."
            print(banner(" Error "), msg.format(f), "",
                  cython_help, banner(), sep="\n", file=sys.stderr)
518
519
            exit(1)

520
        for f in pyx_files + kwargs.get('depends', []):
521
522
523
524
525
526
            if f == CONFIG_FILE:
                # 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
527

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

530
    if problematic_files:
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
        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:
547
548
            exit(1)

Christoph Groth's avatar
Christoph Groth committed
549
550
    return result

551

Christoph Groth's avatar
Christoph Groth committed
552
def main():
553
554
    global build_summary

555
556
557
    get_version()
    init_cython()

558
559
560
561
562
563
    build_summary = []
    exts = collections.OrderedDict(EXTENSIONS)
    exts = configure_extensions(exts, EXTENSION_ALIASES, build_summary)
    exts = configure_special_extensions(exts, build_summary)
    exts = maybe_cythonize(exts)

Christoph Groth's avatar
Christoph Groth committed
564
    setup(name='kwant',
565
          version=version,
566
567
          author='C. W. Groth (CEA), M. Wimmer, '
                 'A. R. Akhmerov, X. Waintal (CEA), and others',
568
          author_email='authors@kwant-project.org',
569
          description=("Package for numerical quantum transport calculations "
570
                       "(Python 3 version)"),
571
572
          long_description=long_description(),
          platforms=["Unix", "Linux", "Mac OS-X", "Windows"],
573
574
          url="http://kwant-project.org/",
          license="BSD",
575
          packages=find_packages('.'),
576
          cmdclass={'build': kwant_build,
577
                    'sdist': kwant_sdist,
578
                    'build_ext': kwant_build_ext,
Christoph Groth's avatar
Christoph Groth committed
579
                    'build_tut': kwant_build_tut},
580
          ext_modules=exts,
581
582
          setup_requires=['pytest-runner >= 2.7'],
          tests_require=['numpy > 1.6.1', 'pytest >= 2.6.3'],
Christoph Groth's avatar
Christoph Groth committed
583
          install_requires=['numpy > 1.6.1', 'scipy >= 0.9', 'tinyarray'],
Joseph Weston's avatar
Joseph Weston committed
584
585
          extras_require={'plotting': 'matplotlib >= 1.2'},
          classifiers=[c.strip() for c in CLASSIFIERS.split('\n')])
586

Christoph Groth's avatar
Christoph Groth committed
587
588
if __name__ == '__main__':
    main()