setup.py 21.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.

Christoph Groth's avatar
Christoph Groth committed
11
import sys
12

13

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

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

Christoph Groth's avatar
Christoph Groth committed
40

41
STATIC_VERSION_PATH = ('kwant', '_kwant_version.py')
42

43
44
45
distr_root = os.path.dirname(os.path.abspath(__file__))


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

    This function modifies `sys.argv`.
54
    """
55
56
57
58
59
60
61
62
63
64
65
66
    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)
67
            sys.exit(1)
68
69
70
71
        sys.argv.pop(i)
        break
    else:
        config_file = 'build.conf'
72
73
74
75

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

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

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

    return exts


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

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

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

188
            if cython_version < required_cython_version:
189
190
                cythonize = None

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

200

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

Christoph Groth's avatar
Christoph Groth committed
205

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

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

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

239

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

    def initialize_options(self):
        pass

    def finalize_options(self):
        pass

    def run(self):
251
252
253
254
255
        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))
256
257
258
            with open(in_fname) as in_file:
                with open(out_fname, 'w') as out_file:
                    for line in in_file:
259
                        if not line.startswith('#HIDDEN'):
260
                            out_file.write(line)
261
262
263
264
265
266


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

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

274
275

def git_lsfiles():
276
    if not version_is_from_git:
277
278
        return

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

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


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

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

Christoph Groth's avatar
Christoph Groth committed
328
        super().run()
329
330

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

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

Christoph Groth's avatar
Christoph Groth committed
340

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


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


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


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


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

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

436
437
438
439
440
    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
441

442
    return exts
Christoph Groth's avatar
Christoph Groth committed
443

444
445

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

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

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

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

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

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

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

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

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

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

Christoph Groth's avatar
Christoph Groth committed
528
529
    return result

530

Christoph Groth's avatar
Christoph Groth committed
531
def main():
532
533
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
    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']))])

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

575
576
    aliases = [('lapack', 'kwant.linalg.lapack'),
               ('mumps', 'kwant.linalg._mumps')]
577

578
579
580
    get_version()
    init_cython()

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

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

Christoph Groth's avatar
Christoph Groth committed
621
622
if __name__ == '__main__':
    main()