setup.py 21.4 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
12
from __future__ import print_function

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

15

16
17
18
19
20
21
22
23
24
25
26
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))
27

28
import re
Christoph Groth's avatar
Christoph Groth committed
29
import os
30
import glob
31
import imp
Christoph Groth's avatar
Christoph Groth committed
32
import subprocess
33
import configparser
34
import collections
35
from setuptools import setup, find_packages, Extension, Command
36
from distutils.errors import DistutilsError, CCompilerError
37
38
39
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
40
from setuptools.command.test import test as test_orig
41

Christoph Groth's avatar
Christoph Groth committed
42

43
STATIC_VERSION_PATH = ('kwant', '_kwant_version.py')
44

45
46
47
distr_root = os.path.dirname(os.path.abspath(__file__))


48
49
50
51
52
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
53
54
55
    the configuration file.

    This function modifies `sys.argv`.
56
    """
57
58
59
60
61
62
63
64
65
66
67
68
    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:
            print('error: Expecting {}=PATH'.format(config_file_option),
                  file=sys.stderr)
69
            sys.exit(1)
70
71
72
73
        sys.argv.pop(i)
        break
    else:
        config_file = 'build.conf'
74
75
76
77

    #### Read build configuration file.
    configs = configparser.ConfigParser()
    try:
78
        with open(config_file) as f:
79
80
81
82
83
84
85
86
87
88
89
            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(
90
                    short, long, config_file))
91
                sys.exit(1)
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
            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:
118
                    build_summary.append(msg.format(config_file, name, key))
119
120
            kwargs[key] = value

121
        kwargs.setdefault('depends', []).append(config_file)
122
123
124
125
126
127
        if config is not defaultconfig:
            del configs[name]

    unknown_sections = configs.sections()
    if unknown_sections:
        print('Error: Unknown sections in file {}: {}'.format(
128
            config_file, ', '.join(unknown_sections)))
129
        sys.exit(1)
130
131
132
133

    return exts


134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
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():
149
150
151
152
153
154
155
156
157
158
159
160
161
162
    """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`.
    """
163
    global cythonize, cython_help
164

165
    cython_option = '--cython'
166
    required_cython_version = (0, 22)
167
    try:
168
        sys.argv.remove(cython_option)
169
        cythonize = True
170
    except ValueError:
171
        cythonize = version_is_from_git
172

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

190
            if cython_version < required_cython_version:
191
192
                cythonize = None

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

202

203
204
205
def banner(title=''):
    starred = title.center(79, '*')
    return '\n' + starred if title else starred
206

Christoph Groth's avatar
Christoph Groth committed
207

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

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

230
231
232
233
234
235
236
237
238
239
240
    __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}
"""

241

242
class build_tut(Command):
243
244
245
246
247
248
249
250
251
252
    description = "build the tutorial scripts"
    user_options = []

    def initialize_options(self):
        pass

    def finalize_options(self):
        pass

    def run(self):
253
254
255
256
257
        tut_dir = 'tutorial'
        if not os.path.exists(tut_dir):
            os.mkdir(tut_dir)
        for in_fname in glob.glob('doc/source/tutorial/*.py'):
            out_fname = os.path.join(tut_dir, os.path.basename(in_fname))
258
259
260
            with open(in_fname) as in_file:
                with open(out_fname, 'w') as out_file:
                    for line in in_file:
261
                        if not line.startswith('#HIDDEN'):
262
                            out_file.write(line)
263
264
265
266
267
268


# 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.
269
270
class build(build_orig):
    sub_commands = [('build_tut', None)] + build_orig.sub_commands
271

272
    def run(self):
Christoph Groth's avatar
Christoph Groth committed
273
        super().run()
274
275
        write_version(os.path.join(self.build_lib, *STATIC_VERSION_PATH))

276
277

def git_lsfiles():
278
    if not version_is_from_git:
279
280
        return

281
    try:
282
        p = subprocess.Popen(['git', 'ls-files'], cwd=distr_root,
283
284
285
286
287
288
                             stdout=subprocess.PIPE, stderr=subprocess.PIPE)
    except OSError:
        return

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


292
293
294
295
# 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.
296
297
class sdist(sdist_orig):
    sub_commands = [('build', None)] + sdist_orig.sub_commands
298
299

    def run(self):
Christoph Groth's avatar
Christoph Groth committed
300
301
302
303
304
305
306
307
308
        """
        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.
        """
309
310
        manifest_in_file = 'MANIFEST.in'
        manifest = os.path.join(distr_root, manifest_in_file)
311
312
        names = git_lsfiles()
        if names is None:
Christoph Groth's avatar
Christoph Groth committed
313
            if not (os.path.isfile(manifest) and os.access(manifest, os.R_OK)):
314
                print("Error:", manifest_in_file,
Christoph Groth's avatar
Christoph Groth committed
315
316
                      "file is missing and Git is not available"
                      " to regenerate it.", file=sys.stderr)
317
                sys.exit(1)
318
        else:
Christoph Groth's avatar
Christoph Groth committed
319
            with open(manifest, 'w') as f:
320
321
322
323
324
                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
325
                    f.write('include {}'.format(name))
326
                    if extension == 'pyx':
Christoph Groth's avatar
Christoph Groth committed
327
328
                        f.write(''.join([' ', a, sep, stem, dot, 'c']))
                    f.write('\n')
329

Christoph Groth's avatar
Christoph Groth committed
330
        super().run()
331
332

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

338
    def make_release_tree(self, base_dir, files):
Christoph Groth's avatar
Christoph Groth committed
339
        super().make_release_tree(base_dir, files)
340
        write_version(os.path.join(base_dir, *STATIC_VERSION_PATH))
341

Christoph Groth's avatar
Christoph Groth committed
342

Christoph Groth's avatar
Christoph Groth committed
343
344
# The following class is based on a recipe in
# http://doc.pytest.org/en/latest/goodpractices.html#manual-integration.
345
class test(test_orig):
Christoph Groth's avatar
Christoph Groth committed
346
347
348
349
350
351
352
353
    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
354
        try:
Christoph Groth's avatar
Christoph Groth committed
355
356
357
            import pytest
        except:
            print('The Python package "pytest" is required to run tests.',
358
                  file=sys.stderr)
359
            sys.exit(1)
Christoph Groth's avatar
Christoph Groth committed
360
361
        errno = pytest.main(shlex.split(self.pytest_args))
        sys.exit(errno)
362
363


364
365
366
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?
367
    try:
368
369
370
371
372
        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
373
        f.write("version = '{}'\n".format(version))
Christoph Groth's avatar
Christoph Groth committed
374
375


376
377
378
def long_description():
    text = []
    try:
379
        with open('README.rst') as f:
380
            for line in f:
381
                if line.startswith('See also in this directory:'):
382
383
                    break
                text.append(line.rstrip())
384
385
            while text[-1] == "":
                text.pop()
386
387
388
389
390
    except:
        return ''
    return '\n'.join(text)


391
392
393
394
395
396
397
398
399
400
401
402
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
403
    try:
404
        p = subprocess.Popen(cmd, stdin=subprocess.PIPE, stderr=subprocess.PIPE)
Christoph Groth's avatar
Christoph Groth committed
405
406
407
    except OSError:
        pass
    else:
408
        p.communicate(input=b'int main() {}\n')
409
410
        if p.wait() == 0:
            return {'libraries': libs}
Christoph Groth's avatar
Christoph Groth committed
411
412
413
    return {}


414
415
416
417
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
418
419
        build_summary.append('User-configured LAPACK and BLAS')
    else:
420
        lapack['libraries'] = ['lapack', 'blas']
Christoph Groth's avatar
Christoph Groth committed
421
        build_summary.append('Default LAPACK and BLAS')
422
423
424
425

    #### Special config for MUMPS.
    mumps = exts['kwant.linalg._mumps']
    if 'libraries' in mumps:
Christoph Groth's avatar
Christoph Groth committed
426
427
        build_summary.append('User-configured MUMPS')
    else:
428
429
430
431
        kwargs = search_mumps()
        if kwargs:
            for key, value in kwargs.items():
                mumps.setdefault(key, []).extend(value)
432
            build_summary.append('Auto-configured MUMPS')
433
434
        else:
            mumps = None
435
            del exts['kwant.linalg._mumps']
436
            build_summary.append('No MUMPS support')
Christoph Groth's avatar
Christoph Groth committed
437

438
439
440
441
442
    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
443

444
    return exts
Christoph Groth's avatar
Christoph Groth committed
445

446
447

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

450
451
    The argument `exts` must be a mapping of names to kwargs to be passed
    on to `Extension`.
452
453
454
455

    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.
456
    """
457
    if cythonize:
458
459
460
        return cythonize([Extension(name, **kwargs)
                          for name, kwargs in exts.items()],
                         language_level=3,
461
                         compiler_directives={'linetrace': True})
462
463
464
465

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

Christoph Groth's avatar
Christoph Groth committed
466
    result = []
467
    problematic_files = []
468
469
    for name, kwargs in exts.items():
        language = kwargs.get('language')
470
471
472
473
474
475
476
477
        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)
478
            sys.exit(1)
479
480
481

        pyx_files = []
        cythonized_files = []
482
483
        sources = []
        for f in kwargs['sources']:
484
485
486
487
            if f.endswith('.pyx'):
                pyx_files.append(f)
                f = f.rstrip('.pyx') + ext
                cythonized_files.append(f)
488
489
            sources.append(f)
        kwargs['sources'] = sources
490
491
492
493
494
495

        # 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:
496
497
498
            msg = "Cython-generated file {} is missing."
            print(banner(" Error "), msg.format(f), "",
                  cython_help, banner(), sep="\n", file=sys.stderr)
499
            sys.exit(1)
500

501
        for f in pyx_files + kwargs.get('depends', []):
502
            if f == config_file:
503
504
505
506
507
                # 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
508

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

511
    if problematic_files:
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
        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:
528
            sys.exit(1)
529

Christoph Groth's avatar
Christoph Groth committed
530
531
    return result

532

Christoph Groth's avatar
Christoph Groth committed
533
def main():
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
    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',
         dict(sources=['kwant/linalg/lapack.pyx'],
              depends=['kwant/linalg/f_lapack.pxd'])),
        ('kwant.linalg._mumps',
         dict(sources=['kwant/linalg/_mumps.pyx'],
              depends=['kwant/linalg/cmumps.pxd']))])

566
567
568
569
570
571
572
573
574
575
576
    # 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)

577
578
    aliases = [('lapack', 'kwant.linalg.lapack'),
               ('mumps', 'kwant.linalg._mumps')]
579

580
581
582
    get_version()
    init_cython()

583
    global build_summary
584
    build_summary = []
585
    exts = configure_extensions(exts, aliases, build_summary)
586
587
588
    exts = configure_special_extensions(exts, build_summary)
    exts = maybe_cythonize(exts)

589
590
591
592
593
594
595
596
597
598
599
600
    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
601
    setup(name='kwant',
602
          version=version,
603
604
          author='C. W. Groth (CEA), M. Wimmer, '
                 'A. R. Akhmerov, X. Waintal (CEA), and others',
605
          author_email='authors@kwant-project.org',
606
          description=("Package for numerical quantum transport calculations "
607
                       "(Python 3 version)"),
608
609
          long_description=long_description(),
          platforms=["Unix", "Linux", "Mac OS-X", "Windows"],
610
611
          url="http://kwant-project.org/",
          license="BSD",
612
          packages=find_packages('.'),
613
614
615
          cmdclass={'build': build,
                    'sdist': sdist,
                    'build_ext': build_ext,
616
617
                    'build_tut': build_tut,
                    'test': test},
618
          ext_modules=exts,
619
          install_requires=['numpy > 1.6.1', 'scipy >= 0.11.0', 'tinyarray'],
Joseph Weston's avatar
Joseph Weston committed
620
          extras_require={'plotting': 'matplotlib >= 1.2'},
621
          classifiers=[c.strip() for c in classifiers.split('\n')])
622

Christoph Groth's avatar
Christoph Groth committed
623
624
if __name__ == '__main__':
    main()