setup.py 20.3 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
CYTHON_TRACE_OPTION = '--cython-trace'
51
52
53
TUT_DIR = 'tutorial'
TUT_GLOB = 'doc/source/tutorial/*.py'
TUT_HIDDEN_PREFIX = '#HIDDEN'
Joseph Weston's avatar
Joseph Weston committed
54
CLASSIFIERS = """\
55
    Development Status :: 5 - Production/Stable
Joseph Weston's avatar
Joseph Weston committed
56
57
58
59
60
61
62
63
64
65
    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"""

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
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')]
108

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


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
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

    #### Add cython tracing macro
    if trace_cython:
        for name, kwargs in exts.items():
            macros = kwargs.get('define_macros', [])
            macros.append(('CYTHON_TRACE', '1'))
            kwargs['define_macros'] = macros

    #### 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


187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
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():
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
    """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`.
    """
    global cythonize, cython_help, trace_cython
217

218
    try:
219
        sys.argv.remove(CYTHON_OPTION)
220
        cythonize = True
221
    except ValueError:
222
        cythonize = version_is_from_git
223
224
225
226

    try:
        sys.argv.remove(CYTHON_TRACE_OPTION)
        trace_cython = True
227
228
        if not cythonize:
            print('Error: --cython-trace provided, but Cython will not be run.',
229
230
231
232
233
                  file=sys.stderr)
            exit(1)
    except ValueError:
        trace_cython = False

234
    if cythonize:
235
236
237
238
        try:
            import Cython
            from Cython.Build import cythonize
        except ImportError:
239
            cythonize = None
240
        else:
241
            #### Get Cython version.
242
243
244
245
246
247
248
249
            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)
250

251
252
253
254
255
256
257
258
259
260
261
262
            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)

263

264
265
266
def banner(title=''):
    starred = title.center(79, '*')
    return '\n' + starred if title else starred
267

Christoph Groth's avatar
Christoph Groth committed
268

Christoph Groth's avatar
Christoph Groth committed
269
270
class kwant_build_ext(build_ext):
    def run(self):
271
272
273
274
275
276
277
278
        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
279
280
281
        try:
            build_ext.run(self)
        except (DistutilsError, CCompilerError):
282
283
            error_msg = self.__error_msg.format(
                header=banner(' Error '), sep=banner())
284
285
            print(error_msg.format(file=CONFIG_FILE, summary=build_summary),
                  file=sys.stderr)
Christoph Groth's avatar
Christoph Groth committed
286
            raise
287
        print(banner(' Build summary '), *build_summary, sep='\n')
288
        print(banner())
Christoph Groth's avatar
Christoph Groth committed
289

290
291
292
293
294
295
296
297
298
299
300
    __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}
"""

301

302
class kwant_build_tut(Command):
303
304
305
306
307
308
309
310
311
312
313
314
315
316
    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))
317
318
319
320
321
            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)
322
323
324
325
326
327


# 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.
328
329
class kwant_build(build):
    sub_commands = [('build_tut', None)] + build.sub_commands
330

331
    def run(self):
332
        build.run(self)
333
334
        write_version(os.path.join(self.build_lib, *STATIC_VERSION_PATH))

335
336

def git_lsfiles():
337
    if not version_is_from_git:
338
339
        return

340
    try:
341
        p = subprocess.Popen(['git', 'ls-files'], cwd=distr_root,
342
343
344
345
346
347
                             stdout=subprocess.PIPE, stderr=subprocess.PIPE)
    except OSError:
        return

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


351
352
353
354
# 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.
355
356
class kwant_sdist(sdist):
    sub_commands = [('build', None)] + sdist.sub_commands
357
358

    def run(self):
Christoph Groth's avatar
Christoph Groth committed
359
360
361
362
363
364
365
366
367
368
        """
        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)
369
370
        names = git_lsfiles()
        if names is None:
Christoph Groth's avatar
Christoph Groth committed
371
372
373
374
            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)
375
376
                exit(1)
        else:
Christoph Groth's avatar
Christoph Groth committed
377
            with open(manifest, 'w') as f:
378
379
380
381
382
                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
383
                    f.write('include {}'.format(name))
384
                    if extension == 'pyx':
Christoph Groth's avatar
Christoph Groth committed
385
386
                        f.write(''.join([' ', a, sep, stem, dot, 'c']))
                    f.write('\n')
387

388
        sdist.run(self)
389
390

        if names is None:
391
392
393
394
            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)
395

396
    def make_release_tree(self, base_dir, files):
397
        sdist.make_release_tree(self, base_dir, files)
398
        write_version(os.path.join(base_dir, *STATIC_VERSION_PATH))
399

Christoph Groth's avatar
Christoph Groth committed
400

401
402
403
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?
404
    try:
405
406
407
408
409
        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
410
        f.write("version = '{}'\n".format(version))
Christoph Groth's avatar
Christoph Groth committed
411
412


413
414
415
416
417
def long_description():
    text = []
    try:
        with open(README_FILE) as f:
            for line in f:
418
                if line.startswith(README_END_BEFORE):
419
420
                    break
                text.append(line.rstrip())
421
422
            while text[-1] == "":
                text.pop()
423
424
425
426
427
    except:
        return ''
    return '\n'.join(text)


428
429
430
431
432
433
434
435
436
437
438
439
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
440
    try:
441
        p = subprocess.Popen(cmd, stdin=subprocess.PIPE, stderr=subprocess.PIPE)
Christoph Groth's avatar
Christoph Groth committed
442
443
444
    except OSError:
        pass
    else:
445
        p.communicate(input=b'int main() {}\n')
446
447
        if p.wait() == 0:
            return {'libraries': libs}
Christoph Groth's avatar
Christoph Groth committed
448
449
450
    return {}


451
452
453
454
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
455
456
        build_summary.append('User-configured LAPACK and BLAS')
    else:
457
        lapack['libraries'] = ['lapack', 'blas']
Christoph Groth's avatar
Christoph Groth committed
458
        build_summary.append('Default LAPACK and BLAS')
459
460
461
462

    #### Special config for MUMPS.
    mumps = exts['kwant.linalg._mumps']
    if 'libraries' in mumps:
Christoph Groth's avatar
Christoph Groth committed
463
464
        build_summary.append('User-configured MUMPS')
    else:
465
466
467
468
        kwargs = search_mumps()
        if kwargs:
            for key, value in kwargs.items():
                mumps.setdefault(key, []).extend(value)
469
            build_summary.append('Auto-configured MUMPS')
470
471
472
473
        else:
            mumps = None
            del exts['mumps']
            build_summary.append('No MUMPS support')
Christoph Groth's avatar
Christoph Groth committed
474

475
476
477
478
479
    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
480

481
    return exts
Christoph Groth's avatar
Christoph Groth committed
482

483
484

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

487
488
    The argument `exts` must be a mapping of names to kwargs to be passed
    on to `Extension`.
489
490
491
492

    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.
493
    """
494
    if cythonize:
495
496
497
        return cythonize([Extension(name, **kwargs)
                          for name, kwargs in exts.items()],
                         language_level=3,
Christoph Groth's avatar
Christoph Groth committed
498
                         compiler_directives={'linetrace': trace_cython})
499
500
501
502

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

Christoph Groth's avatar
Christoph Groth committed
503
    result = []
504
    problematic_files = []
505
506
    for name, kwargs in exts.items():
        language = kwargs.get('language')
507
508
509
510
511
512
513
514
515
516
517
518
        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 = []
519
520
        sources = []
        for f in kwargs['sources']:
521
522
523
524
            if f.endswith('.pyx'):
                pyx_files.append(f)
                f = f.rstrip('.pyx') + ext
                cythonized_files.append(f)
525
526
            sources.append(f)
        kwargs['sources'] = sources
527
528
529
530
531
532

        # 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:
533
534
535
            msg = "Cython-generated file {} is missing."
            print(banner(" Error "), msg.format(f), "",
                  cython_help, banner(), sep="\n", file=sys.stderr)
536
537
            exit(1)

538
        for f in pyx_files + kwargs.get('depends', []):
539
540
541
542
543
544
            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
545

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

548
    if problematic_files:
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
        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:
565
566
            exit(1)

Christoph Groth's avatar
Christoph Groth committed
567
568
    return result

569

Christoph Groth's avatar
Christoph Groth committed
570
def main():
571
572
    global build_summary

573
574
575
    get_version()
    init_cython()

576
577
578
579
580
581
    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
582
    setup(name='kwant',
583
          version=version,
584
585
          author='C. W. Groth (CEA), M. Wimmer, '
                 'A. R. Akhmerov, X. Waintal (CEA), and others',
586
          author_email='authors@kwant-project.org',
587
          description=("Package for numerical quantum transport calculations "
588
                       "(Python 3 version)"),
589
590
          long_description=long_description(),
          platforms=["Unix", "Linux", "Mac OS-X", "Windows"],
591
592
          url="http://kwant-project.org/",
          license="BSD",
593
          packages=find_packages('.'),
594
          cmdclass={'build': kwant_build,
595
                    'sdist': kwant_sdist,
596
                    'build_ext': kwant_build_ext,
Christoph Groth's avatar
Christoph Groth committed
597
                    'build_tut': kwant_build_tut},
598
          ext_modules=exts,
599
600
          setup_requires=['pytest-runner >= 2.7'],
          tests_require=['numpy > 1.6.1', 'pytest >= 2.6.3'],
Christoph Groth's avatar
Christoph Groth committed
601
          install_requires=['numpy > 1.6.1', 'scipy >= 0.9', 'tinyarray'],
Joseph Weston's avatar
Joseph Weston committed
602
603
          extras_require={'plotting': 'matplotlib >= 1.2'},
          classifiers=[c.strip() for c in CLASSIFIERS.split('\n')])
604

Christoph Groth's avatar
Christoph Groth committed
605
606
if __name__ == '__main__':
    main()