setup.py 17.2 KB
Newer Older
1
2
#!/usr/bin/env python

3
# Copyright 2011-2013 Kwant authors.
4
#
5
# This file is part of Kwant.  It is subject to the license terms in the
6
# LICENSE file 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
8
9
10
# the AUTHORS file at the top-level directory of this distribution and at
# http://kwant-project.org/authors.

11
from __future__ import print_function
Christoph Groth's avatar
Christoph Groth committed
12
13

import sys
14
import re
Christoph Groth's avatar
Christoph Groth committed
15
import os
16
import glob
Christoph Groth's avatar
Christoph Groth committed
17
18
import subprocess
import ConfigParser
Christoph Groth's avatar
Christoph Groth committed
19
20
21
22
from distutils.core import setup, Extension, Command
from distutils.util import get_platform
from distutils.errors import DistutilsError, DistutilsModuleError, \
    CCompilerError
23
from distutils.command.build import build as distutils_build
24
from distutils.command.sdist import sdist as distutils_sdist
25

Christoph Groth's avatar
Christoph Groth committed
26
27
import numpy

28
29
30
31
CONFIG_FILE = 'build.conf'
README_FILE = 'README.rst'
README_END_BEFORE = 'See also in this directory:'
STATIC_VERSION_FILE = 'kwant/_static_version.py'
Christoph Groth's avatar
Christoph Groth committed
32
REQUIRED_CYTHON_VERSION = (0, 22)
33
34
35
36
37
NO_CYTHON_OPTION = '--no-cython'
TUT_DIR = 'tutorial'
TUT_GLOB = 'doc/source/tutorial/*.py'
TUT_HIDDEN_PREFIX = '#HIDDEN'

Christoph Groth's avatar
Christoph Groth committed
38
39
40
41
42
try:
    import Cython
except:
    cython_version = ()
else:
43
44
45
46
47
48
49
50
    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)
51

Christoph Groth's avatar
Christoph Groth committed
52
53
54
55
56
57
58
try:
    sys.argv.remove(NO_CYTHON_OPTION)
    cythonize = False
except ValueError:
    cythonize = True

if cythonize and cython_version:
59
60
    from Cython.Distutils import build_ext
else:
Christoph Groth's avatar
Christoph Groth committed
61
62
    from distutils.command.build_ext import build_ext

63
distr_root = os.path.dirname(os.path.abspath(__file__))
64

65
66
67
68
69
70
71
72
73
74
75
76
def header(title=''):
    return title.center(79, '*')

error_msg = """{sep}
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}}.
{sep}
Build configuration was:
{{summary}}
{sep}"""
error_msg = error_msg.format(sep=header())
Christoph Groth's avatar
Christoph Groth committed
77
78
79

class kwant_build_ext(build_ext):
    def run(self):
80
81
82
83
84
85
86
87
        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
88
89
90
        try:
            build_ext.run(self)
        except (DistutilsError, CCompilerError):
91
92
            print(error_msg.format(file=CONFIG_FILE, summary=build_summary),
                  file=sys.stderr)
Christoph Groth's avatar
Christoph Groth committed
93
            raise
94
95
        print(header(' Build summary '))
        print(build_summary)
Christoph Groth's avatar
Christoph Groth committed
96

97

98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
class build_tut(Command):
    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))
113
114
115
116
117
            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)
118
119
120
121
122
123
124
125


# 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.
class kwant_build(distutils_build):
    sub_commands = [('build_tut', None)] + distutils_build.sub_commands
126
127


Christoph Groth's avatar
Christoph Groth committed
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
class test(Command):
    description = "build, then run the unit tests"
    user_options = []

    def initialize_options(self):
        pass

    def finalize_options(self):
        pass

    def run(self):
        try:
            from nose.core import run
        except ImportError:
            raise DistutilsModuleError('nose <http://nose.readthedocs.org/> '
                                       'is needed to run the tests')
        self.run_command('build')
        major, minor = sys.version_info[:2]
        lib_dir = "build/lib.{0}-{1}.{2}".format(get_platform(), major, minor)
147
        print(header(' Tests '))
Christoph Groth's avatar
Christoph Groth committed
148
149
150
151
        if not run(argv=[__file__, '-v', lib_dir]):
            raise DistutilsError('at least one of the tests failed')


152
153
def git_lsfiles():
    try:
154
        p = subprocess.Popen(['git', 'ls-files'], cwd=distr_root,
155
156
157
158
159
160
161
                             stdout=subprocess.PIPE, stderr=subprocess.PIPE)
    except OSError:
        return

    if p.wait() != 0:
        return
    return p.communicate()[0].split('\n')[:-1]
162
163


164
165
166
167
168
169
# 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.
class kwant_sdist(distutils_sdist):
    sub_commands = [('build', None)] + distutils_sdist.sub_commands
170
171
172
173
174
175
176
177

    def run(self):
        names = git_lsfiles()
        trustworthy = True
        if names is None:
            # Check that MANIFEST exists and has not been generated by
            # distutils.
            try:
178
                with open(distr_root + '/MANIFEST', 'r') as f:
179
180
                    line = f.read()
            except IOError:
181
182
                print("error: MANIFEST file is missing and Git is not"
                      " available to regenerate it.", file=sys.stderr)
183
184
185
186
                exit(1)
            trustworthy = not line.strip().startswith('#')
        else:
            # Generate MANIFEST file.
187
            with open(distr_root + '/MANIFEST', 'w') as f:
188
189
190
191
192
193
194
195
196
                for name in names:
                    a, sep, b = name.rpartition('/')
                    if b == '.gitignore':
                        continue
                    stem, dot, extension = b.rpartition('.')
                    if extension == 'pyx':
                        f.write(''.join([a, sep, stem, dot, 'c', '\n']))
                    f.write(name + '\n')
                f.write(STATIC_VERSION_FILE + '\n')
197
                f.write('MANIFEST\n')
198
199
200

        distutils_sdist.run(self)

201
        msg = None
202
        if names is None:
203
204
205
206
            msg = ['Git was not available for re-generating '
                   'the MANIFEST file (the list of file',
                   'names to be included in the source'
                   ' distribution).  The old MANIFEST was used.']
207
        if not trustworthy:
208
209
210
211
212
213
214
            msg = ['-The existing MANIFEST file seems to'
                   ' have been generated by distutils (it begins',
                   '-with a comment).  It may well be incomplete.']

        if msg is not None:
            msg.insert(0, header(' Warning '))
            print(msg, sep='\n', file=sys.stderr)
215
216


217
# This is an exact copy of the function from kwant/_common.py.  We can't import
218
# it here (because Kwant is not yet built when this scipt is run), so we just
219
220
221
# include a copy.
def get_version_from_git():
    try:
222
223
        p = subprocess.Popen(['git', 'rev-parse', '--show-toplevel'],
                             cwd=distr_root,
224
225
226
227
228
                             stdout=subprocess.PIPE, stderr=subprocess.PIPE)
    except OSError:
        return
    if p.wait() != 0:
        return
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
    # TODO: use os.path.samefile once we depend on Python >= 3.3.
    if os.path.normpath(p.communicate()[0].rstrip('\n')) != distr_root:
        # The top-level directory of the current Git repository is not the same
        # as the root directory of the Kwant distribution: do not extract the
        # version from Git.
        return

    # git describe --first-parent does not take into account tags from branches
    # that were merged-in.
    for opts in [['--first-parent'], []]:
        try:
            p = subprocess.Popen(['git', 'describe'] + opts, cwd=distr_root,
                                 stdout=subprocess.PIPE, stderr=subprocess.PIPE)
        except OSError:
            return
        if p.wait() == 0:
            break
    else:
        return
    version = p.communicate()[0].rstrip('\n')
249
250
251
252
253

    if version[0] == 'v':
        version = version[1:]

    try:
254
        p = subprocess.Popen(['git', 'diff', '--quiet'], cwd=distr_root)
255
256
257
258
259
260
261
    except OSError:
        version += '-confused'  # This should never happen.
    else:
        if p.wait() == 1:
            version += '-dirty'
    return version

Christoph Groth's avatar
Christoph Groth committed
262

263
def read_static_version():
264
    """Return the version as recorded inside the source code."""
265
    try:
Christoph Groth's avatar
Christoph Groth committed
266
        with open(STATIC_VERSION_FILE) as f:
267
268
269
270
271
272
273
            contents = f.read()
            assert contents[:11] == "version = '"
            assert contents[-2:] == "'\n"
            return contents[11:-2]
    except:
        return None

Christoph Groth's avatar
Christoph Groth committed
274

275
276
277
278
279
280
def write_static_version(version):
    """Record the version so that it is available without version control."""
    with open(STATIC_VERSION_FILE, 'w') as f:
        f.write("version = '%s'\n" % version)


Christoph Groth's avatar
Christoph Groth committed
281
def version():
282
    """Determine the version of Kwant.  Return it and save it in a file."""
Christoph Groth's avatar
Christoph Groth committed
283
    git_version = get_version_from_git()
284
    static_version = read_static_version()
Christoph Groth's avatar
Christoph Groth committed
285
286
287
    if git_version is not None:
        version = git_version
        if static_version != git_version:
288
            write_static_version(version)
Christoph Groth's avatar
Christoph Groth committed
289
290
291
292
293
294
295
    elif static_version is not None:
        version = static_version
    else:
        version = 'unknown'
    return version


296
297
298
299
300
def long_description():
    text = []
    try:
        with open(README_FILE) as f:
            for line in f:
301
                if line.startswith(README_END_BEFORE):
302
303
                    break
                text.append(line.rstrip())
304
305
            while text[-1] == "":
                text.pop()
306
307
308
309
310
    except:
        return ''
    return '\n'.join(text)


311
312
313
314
315
316
def packages():
    return [root.replace('/', '.')
            for root, dnames, fnames in os.walk('kwant')
            if '__init__.py' in fnames or root.endswith('/tests')]


317
318
319
320
321
322
323
324
325
326
327
328
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
329
    try:
330
        p = subprocess.Popen(cmd, stdin=subprocess.PIPE, stderr=subprocess.PIPE)
Christoph Groth's avatar
Christoph Groth committed
331
332
333
    except OSError:
        pass
    else:
334
335
336
        p.communicate(input='int main() {}\n')
        if p.wait() == 0:
            return {'libraries': libs}
Christoph Groth's avatar
Christoph Groth committed
337
338
339
340
341
342
343
344
    return {}


def extensions():
    """Return a list of tuples (args, kwrds) to be passed to
    Extension. possibly after replacing ".pyx" with ".c" if Cython is not to be
    used."""

345
    global build_summary, config_file_present
Christoph Groth's avatar
Christoph Groth committed
346
347
    build_summary = []

348
    #### Add components of Kwant without external compile-time dependencies.
Christoph Groth's avatar
Christoph Groth committed
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
    result = [
        (['kwant._system', ['kwant/_system.pyx']],
         {'include_dirs': ['kwant/graph']}),
        (['kwant.graph.core', ['kwant/graph/core.pyx']],
         {'depends': ['kwant/graph/core.pxd', 'kwant/graph/defs.h',
                      'kwant/graph/defs.pxd']}),
        (['kwant.graph.utils', ['kwant/graph/utils.pyx']],
         {'depends': ['kwant/graph/defs.h', 'kwant/graph/defs.pxd',
                      'kwant/graph/core.pxd']}),
        (['kwant.graph.slicer', ['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']})]

369
    #### Add components of Kwant with external compile-time dependencies.
Christoph Groth's avatar
Christoph Groth committed
370
371
372
373
374
    config = ConfigParser.ConfigParser()
    try:
        with open(CONFIG_FILE) as f:
            config.readfp(f)
    except IOError:
375
376
377
        config_file_present = False
    else:
        config_file_present = True
Christoph Groth's avatar
Christoph Groth committed
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402

    kwrds_by_section = {}
    for section in config.sections():
        kwrds_by_section[section] = kwrds = {}
        for name, value in config.items(section):
            kwrds[name] = value.split()

    # Setup LAPACK.
    lapack = kwrds_by_section.get('lapack')
    if lapack:
        build_summary.append('User-configured LAPACK and BLAS')
    else:
        lapack = {'libraries': ['lapack', 'blas']}
        build_summary.append('Default LAPACK and BLAS')
    kwrds = lapack.copy()
    kwrds.setdefault('depends', []).extend(
        [CONFIG_FILE, 'kwant/linalg/f_lapack.pxd'])
    result.append((['kwant.linalg.lapack', ['kwant/linalg/lapack.pyx']],
                   kwrds))

    # Setup MUMPS.
    kwrds = kwrds_by_section.get('mumps')
    if kwrds:
        build_summary.append('User-configured MUMPS')
    else:
403
        kwrds = search_mumps()
Christoph Groth's avatar
Christoph Groth committed
404
        if kwrds:
405
            build_summary.append('Auto-configured MUMPS')
Christoph Groth's avatar
Christoph Groth committed
406
407
408
409
410
411
412
413
414
415
416
417
418
419
    if kwrds:
        for name, value in lapack.iteritems():
            kwrds.setdefault(name, []).extend(value)
        kwrds.setdefault('depends', []).extend(
            [CONFIG_FILE, 'kwant/linalg/cmumps.pxd'])
        result.append((['kwant.linalg._mumps', ['kwant/linalg/_mumps.pyx']],
                       kwrds))
    else:
        build_summary.append('No MUMPS support')

    build_summary = '\n'.join(build_summary)
    return result


420
421
422
423
424
425
def complain_cython_unavailable():
    assert not cythonize or cython_version < REQUIRED_CYTHON_VERSION
    if cythonize:
        msg = "Install Cython {0} or newer so it can be made or use a source " \
            "distribution of Kwant."
        ver = '.'.join(str(e) for e in REQUIRED_CYTHON_VERSION)
426
        print(msg.format(ver), file=sys.stderr)
427
    else:
428
        print("Run setup.py without", NO_CYTHON_OPTION, file=sys.stderr)
429
430


Christoph Groth's avatar
Christoph Groth committed
431
432
433
434
def ext_modules(extensions):
    """Prepare the ext_modules argument for distutils' setup."""
    result = []
    for args, kwrds in extensions:
435
        if not cythonize or cython_version < REQUIRED_CYTHON_VERSION:
Christoph Groth's avatar
Christoph Groth committed
436
437
438
439
440
441
            if 'language' in kwrds:
                if kwrds['language'] == 'c':
                    ext = '.c'
                elif kwrds['language'] == 'c++':
                    ext = '.cpp'
                else:
442
                    print('Unknown language', file=sys.stderr)
Christoph Groth's avatar
Christoph Groth committed
443
                    exit(1)
444
            else:
Christoph Groth's avatar
Christoph Groth committed
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
                ext = '.c'
            pyx_files = []
            cythonized_files = []
            sources = []
            for f in args[1]:
                if f[-4:] == '.pyx':
                    pyx_files.append(f)
                    f = f[:-4] + ext
                    cythonized_files.append(f)
                sources.append(f)
            args[1] = sources

            try:
                cythonized_oldest = min(os.stat(f).st_mtime
                                        for f in cythonized_files)
            except OSError:
461
462
                print("error: Cython-generated file {} is missing.".format(f),
                      file=sys.stderr)
463
                complain_cython_unavailable()
464
                exit(1)
Christoph Groth's avatar
Christoph Groth committed
465
            for f in pyx_files + kwrds.get('depends', []):
466
467
468
469
                if f == CONFIG_FILE:
                    # The config file is only a dependency for the compilation
                    # of the cythonized file, not for the cythonization.
                    continue
Christoph Groth's avatar
Christoph Groth committed
470
                if os.stat(f).st_mtime > cythonized_oldest:
471
                    msg = "error: {} is newer than its source file, but "
472
473
474
475
                    if cythonize and not cython_version:
                        msg += "Cython is not installed."
                    elif cythonize:
                        msg += "the installed Cython is too old."
Christoph Groth's avatar
Christoph Groth committed
476
                    else:
477
                        msg += "Cython is not to be run."
478
                    print(msg.format(f), file=sys.stderr)
479
480
                    complain_cython_unavailable()
                    exit(1)
Christoph Groth's avatar
Christoph Groth committed
481
482
483
484
485
486
487
488
489

        result.append(Extension(*args, **kwrds))

    return result


def main():
    setup(name='kwant',
          version=version(),
490
491
          author='C. W. Groth (CEA), M. Wimmer, '
                 'A. R. Akhmerov, X. Waintal (CEA), and others',
492
          author_email='authors@kwant-project.org',
Christoph Groth's avatar
Christoph Groth committed
493
          description="Package for numerical quantum transport calculations.",
494
495
          long_description=long_description(),
          platforms=["Unix", "Linux", "Mac OS-X", "Windows"],
496
497
          url="http://kwant-project.org/",
          license="BSD",
498
          packages=packages(),
499
          cmdclass={'build': kwant_build,
500
                    'sdist': kwant_sdist,
501
                    'build_ext': kwant_build_ext,
Christoph Groth's avatar
Christoph Groth committed
502
503
                    'build_tut': build_tut,
                    'test': test},
Christoph Groth's avatar
Christoph Groth committed
504
505
          ext_modules=ext_modules(extensions()),
          include_dirs=[numpy.get_include()])
506

Christoph Groth's avatar
Christoph Groth committed
507
508
if __name__ == '__main__':
    main()