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
CONFIG_FILE = 'build.conf'
44
STATIC_VERSION_PATH = ('kwant', '_kwant_version.py')
45

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


49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
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
107
108
109
110
111
112
113
114
115
116
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


117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
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():
132
133
134
135
136
137
138
139
140
141
142
143
144
145
    """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`.
    """
146
    global cythonize, cython_help
147

148
    cython_option = '--cython'
149
    try:
150
        sys.argv.remove(cython_option)
151
        cythonize = True
152
    except ValueError:
153
        cythonize = version_is_from_git
154

155
    if cythonize:
156
157
158
159
        try:
            import Cython
            from Cython.Build import cythonize
        except ImportError:
160
            cythonize = None
161
        else:
162
            #### Get Cython version.
163
164
165
166
167
168
169
170
            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)
171

172
173
            required_cython_version = (0, 22)
            if cython_version < required_cython_version:
174
175
176
177
178
                cythonize = None

            if cythonize is None:
                msg = ("Install Cython >= {0} or use"
                       " a source distribution (tarball) of Kwant.")
179
                ver = '.'.join(str(e) for e in required_cython_version)
180
181
182
                cython_help = msg.format(ver)
    else:
        msg = "Run setup.py with the {} option to enable Cython."
183
        cython_help = msg.format(cython_option)
184

185

186
187
188
def banner(title=''):
    starred = title.center(79, '*')
    return '\n' + starred if title else starred
189

Christoph Groth's avatar
Christoph Groth committed
190

Christoph Groth's avatar
Christoph Groth committed
191
192
class kwant_build_ext(build_ext):
    def run(self):
193
194
195
196
197
198
199
200
        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
201
202
203
        try:
            build_ext.run(self)
        except (DistutilsError, CCompilerError):
204
205
            error_msg = self.__error_msg.format(
                header=banner(' Error '), sep=banner())
206
207
            print(error_msg.format(file=CONFIG_FILE, summary=build_summary),
                  file=sys.stderr)
Christoph Groth's avatar
Christoph Groth committed
208
            raise
209
        print(banner(' Build summary '), *build_summary, sep='\n')
210
        print(banner())
Christoph Groth's avatar
Christoph Groth committed
211

212
213
214
215
216
217
218
219
220
221
222
    __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}
"""

223

224
class kwant_build_tut(Command):
225
226
227
228
229
230
231
232
233
234
    description = "build the tutorial scripts"
    user_options = []

    def initialize_options(self):
        pass

    def finalize_options(self):
        pass

    def run(self):
235
236
237
238
239
        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))
240
241
242
            with open(in_fname) as in_file:
                with open(out_fname, 'w') as out_file:
                    for line in in_file:
243
                        if not line.startswith('#HIDDEN'):
244
                            out_file.write(line)
245
246
247
248
249
250


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

254
    def run(self):
255
        build.run(self)
256
257
        write_version(os.path.join(self.build_lib, *STATIC_VERSION_PATH))

258
259

def git_lsfiles():
260
    if not version_is_from_git:
261
262
        return

263
    try:
264
        p = subprocess.Popen(['git', 'ls-files'], cwd=distr_root,
265
266
267
268
269
270
                             stdout=subprocess.PIPE, stderr=subprocess.PIPE)
    except OSError:
        return

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


274
275
276
277
# 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.
278
279
class kwant_sdist(sdist):
    sub_commands = [('build', None)] + sdist.sub_commands
280
281

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

312
        sdist.run(self)
313
314

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

320
    def make_release_tree(self, base_dir, files):
321
        sdist.make_release_tree(self, base_dir, files)
322
        write_version(os.path.join(base_dir, *STATIC_VERSION_PATH))
323

Christoph Groth's avatar
Christoph Groth committed
324

325
326
327
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?
328
    try:
329
330
331
332
333
        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
334
        f.write("version = '{}'\n".format(version))
Christoph Groth's avatar
Christoph Groth committed
335
336


337
338
339
def long_description():
    text = []
    try:
340
        with open('README.rst') as f:
341
            for line in f:
342
                if line.startswith('See also in this directory:'):
343
344
                    break
                text.append(line.rstrip())
345
346
            while text[-1] == "":
                text.pop()
347
348
349
350
351
    except:
        return ''
    return '\n'.join(text)


352
353
354
355
356
357
358
359
360
361
362
363
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
364
    try:
365
        p = subprocess.Popen(cmd, stdin=subprocess.PIPE, stderr=subprocess.PIPE)
Christoph Groth's avatar
Christoph Groth committed
366
367
368
    except OSError:
        pass
    else:
369
        p.communicate(input=b'int main() {}\n')
370
371
        if p.wait() == 0:
            return {'libraries': libs}
Christoph Groth's avatar
Christoph Groth committed
372
373
374
    return {}


375
376
377
378
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
379
380
        build_summary.append('User-configured LAPACK and BLAS')
    else:
381
        lapack['libraries'] = ['lapack', 'blas']
Christoph Groth's avatar
Christoph Groth committed
382
        build_summary.append('Default LAPACK and BLAS')
383
384
385
386

    #### Special config for MUMPS.
    mumps = exts['kwant.linalg._mumps']
    if 'libraries' in mumps:
Christoph Groth's avatar
Christoph Groth committed
387
388
        build_summary.append('User-configured MUMPS')
    else:
389
390
391
392
        kwargs = search_mumps()
        if kwargs:
            for key, value in kwargs.items():
                mumps.setdefault(key, []).extend(value)
393
            build_summary.append('Auto-configured MUMPS')
394
395
396
397
        else:
            mumps = None
            del exts['mumps']
            build_summary.append('No MUMPS support')
Christoph Groth's avatar
Christoph Groth committed
398

399
400
401
402
403
    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
404

405
    return exts
Christoph Groth's avatar
Christoph Groth committed
406

407
408

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

411
412
    The argument `exts` must be a mapping of names to kwargs to be passed
    on to `Extension`.
413
414
415
416

    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.
417
    """
418
    if cythonize:
419
420
421
        return cythonize([Extension(name, **kwargs)
                          for name, kwargs in exts.items()],
                         language_level=3,
422
                         compiler_directives={'linetrace': True})
423
424
425
426

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

Christoph Groth's avatar
Christoph Groth committed
427
    result = []
428
    problematic_files = []
429
430
    for name, kwargs in exts.items():
        language = kwargs.get('language')
431
432
433
434
435
436
437
438
439
440
441
442
        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 = []
443
444
        sources = []
        for f in kwargs['sources']:
445
446
447
448
            if f.endswith('.pyx'):
                pyx_files.append(f)
                f = f.rstrip('.pyx') + ext
                cythonized_files.append(f)
449
450
            sources.append(f)
        kwargs['sources'] = sources
451
452
453
454
455
456

        # 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:
457
458
459
            msg = "Cython-generated file {} is missing."
            print(banner(" Error "), msg.format(f), "",
                  cython_help, banner(), sep="\n", file=sys.stderr)
460
461
            exit(1)

462
        for f in pyx_files + kwargs.get('depends', []):
463
464
465
466
467
468
            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
469

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

472
    if problematic_files:
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
        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:
489
490
            exit(1)

Christoph Groth's avatar
Christoph Groth committed
491
492
    return result

493

Christoph Groth's avatar
Christoph Groth committed
494
def main():
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
    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']))])

    aliases = [('lapack', 'kwant.linalg.lapack'),
               ('mumps', 'kwant.linalg._mumps')]
529

530
531
532
    get_version()
    init_cython()

533
    global build_summary
534
    build_summary = []
535
    exts = configure_extensions(exts, aliases, build_summary)
536
537
538
    exts = configure_special_extensions(exts, build_summary)
    exts = maybe_cythonize(exts)

539
540
541
542
543
544
545
546
547
548
549
550
    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
551
    setup(name='kwant',
552
          version=version,
553
554
          author='C. W. Groth (CEA), M. Wimmer, '
                 'A. R. Akhmerov, X. Waintal (CEA), and others',
555
          author_email='authors@kwant-project.org',
556
          description=("Package for numerical quantum transport calculations "
557
                       "(Python 3 version)"),
558
559
          long_description=long_description(),
          platforms=["Unix", "Linux", "Mac OS-X", "Windows"],
560
561
          url="http://kwant-project.org/",
          license="BSD",
562
          packages=find_packages('.'),
563
          cmdclass={'build': kwant_build,
564
                    'sdist': kwant_sdist,
565
                    'build_ext': kwant_build_ext,
Christoph Groth's avatar
Christoph Groth committed
566
                    'build_tut': kwant_build_tut},
567
          ext_modules=exts,
568
569
          setup_requires=['pytest-runner >= 2.7'],
          tests_require=['numpy > 1.6.1', 'pytest >= 2.6.3'],
Christoph Groth's avatar
Christoph Groth committed
570
          install_requires=['numpy > 1.6.1', 'scipy >= 0.9', 'tinyarray'],
Joseph Weston's avatar
Joseph Weston committed
571
          extras_require={'plotting': 'matplotlib >= 1.2'},
572
          classifiers=[c.strip() for c in classifiers.split('\n')])
573

Christoph Groth's avatar
Christoph Groth committed
574
575
if __name__ == '__main__':
    main()