setup.py 16.1 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
17
import imp
Christoph Groth's avatar
Christoph Groth committed
18
19
import subprocess
import ConfigParser
Christoph Groth's avatar
Christoph Groth committed
20
21
22
23
from distutils.core import setup, Extension, Command
from distutils.util import get_platform
from distutils.errors import DistutilsError, DistutilsModuleError, \
    CCompilerError
24
from distutils.command.build import build as distutils_build
25
from distutils.command.sdist import sdist as distutils_sdist
26

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

29
30
31
32
33
_dont_write_bytecode_saved = sys.dont_write_bytecode
sys.dont_write_bytecode = True
kwant_common = imp.load_source('kwant_common', 'kwant/_common.py')
sys.dont_write_bytecode = _dont_write_bytecode_saved

34
35
36
37
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
38
REQUIRED_CYTHON_VERSION = (0, 22)
39
NO_CYTHON_OPTION = '--no-cython'
40
NO_GIT_OPTION = '--no-git'
41
42
43
44
TUT_DIR = 'tutorial'
TUT_GLOB = 'doc/source/tutorial/*.py'
TUT_HIDDEN_PREFIX = '#HIDDEN'

Christoph Groth's avatar
Christoph Groth committed
45
46
47
48
49
try:
    import Cython
except:
    cython_version = ()
else:
50
51
52
53
54
55
56
57
    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)
58

Christoph Groth's avatar
Christoph Groth committed
59
60
61
62
63
64
try:
    sys.argv.remove(NO_CYTHON_OPTION)
    cythonize = False
except ValueError:
    cythonize = True

65
66
67
68
69
70
try:
    sys.argv.remove(NO_GIT_OPTION)
    use_git = False
except ValueError:
    use_git = True

Christoph Groth's avatar
Christoph Groth committed
71
if cythonize and cython_version:
72
73
    from Cython.Distutils import build_ext
else:
Christoph Groth's avatar
Christoph Groth committed
74
75
    from distutils.command.build_ext import build_ext

76
distr_root = os.path.dirname(os.path.abspath(__file__))
77

78
79
80
def banner(title=''):
    starred = title.center(79, '*')
    return '\n' + starred if title else starred
81

82
error_msg = """{header}
83
84
85
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}}.
86

87
Build configuration was:
88

89
{{summary}}
90
91
92
{sep}
"""
error_msg = error_msg.format(header=banner(' Error '), sep=banner())
Christoph Groth's avatar
Christoph Groth committed
93
94
95

class kwant_build_ext(build_ext):
    def run(self):
96
97
98
99
100
101
102
103
        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
104
105
106
        try:
            build_ext.run(self)
        except (DistutilsError, CCompilerError):
107
108
            print(error_msg.format(file=CONFIG_FILE, summary=build_summary),
                  file=sys.stderr)
Christoph Groth's avatar
Christoph Groth committed
109
            raise
110
        print(banner(' Build summary '))
111
        print(build_summary)
112
        print(banner())
Christoph Groth's avatar
Christoph Groth committed
113

114

115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
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))
130
131
132
133
134
            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)
135
136
137
138
139
140
141
142


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


Christoph Groth's avatar
Christoph Groth committed
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
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)
164
        print()
Christoph Groth's avatar
Christoph Groth committed
165
166
167
168
        if not run(argv=[__file__, '-v', lib_dir]):
            raise DistutilsError('at least one of the tests failed')


169
def git_lsfiles():
170
171
172
    if not use_git:
        return

173
    try:
174
        p = subprocess.Popen(['git', 'ls-files'], cwd=distr_root,
175
176
177
178
179
180
181
                             stdout=subprocess.PIPE, stderr=subprocess.PIPE)
    except OSError:
        return

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


184
185
186
187
188
189
# 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
190
191
192
193
194
195
196
197

    def run(self):
        names = git_lsfiles()
        trustworthy = True
        if names is None:
            # Check that MANIFEST exists and has not been generated by
            # distutils.
            try:
198
                with open(distr_root + '/MANIFEST', 'r') as f:
199
200
                    line = f.read()
            except IOError:
201
                print("Error: MANIFEST file is missing and Git is not"
202
                      " available to regenerate it.", file=sys.stderr)
203
204
205
206
                exit(1)
            trustworthy = not line.strip().startswith('#')
        else:
            # Generate MANIFEST file.
207
            with open(distr_root + '/MANIFEST', 'w') as f:
208
209
210
211
212
213
214
215
216
                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')
217
                f.write('MANIFEST\n')
218
219
220
221

        distutils_sdist.run(self)

        if names is None:
222
            print(banner(' Warning '),
223
224
"""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.""",
225
                  banner(),
226
                  sep='\n', file=sys.stderr)
227

228
        if not trustworthy:
229
            print(banner(' Warning '),
230
231
"""The existing MANIFEST file seems to have been generated by distutils (it begins
with a comment).  It may well be incomplete.""",
232
                  banner(),
233
                  sep='\n', file=sys.stderr)
234

235
def get_version_from_git():
236
237
    if use_git:
        return kwant_common.get_version_from_git()
238

Christoph Groth's avatar
Christoph Groth committed
239

240
def read_static_version():
241
    """Return the version as recorded inside the source code."""
242
    try:
Christoph Groth's avatar
Christoph Groth committed
243
        with open(STATIC_VERSION_FILE) as f:
244
245
246
247
248
249
250
            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
251

252
253
254
255
256
257
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
258
def version():
259
    """Determine the version of Kwant.  Return it and save it in a file."""
Christoph Groth's avatar
Christoph Groth committed
260
    git_version = get_version_from_git()
261
    static_version = read_static_version()
Christoph Groth's avatar
Christoph Groth committed
262
263
264
    if git_version is not None:
        version = git_version
        if static_version != git_version:
265
            write_static_version(version)
Christoph Groth's avatar
Christoph Groth committed
266
267
268
269
270
271
272
    elif static_version is not None:
        version = static_version
    else:
        version = 'unknown'
    return version


273
274
275
276
277
def long_description():
    text = []
    try:
        with open(README_FILE) as f:
            for line in f:
278
                if line.startswith(README_END_BEFORE):
279
280
                    break
                text.append(line.rstrip())
281
282
            while text[-1] == "":
                text.pop()
283
284
285
286
287
    except:
        return ''
    return '\n'.join(text)


288
289
290
291
292
293
def packages():
    return [root.replace('/', '.')
            for root, dnames, fnames in os.walk('kwant')
            if '__init__.py' in fnames or root.endswith('/tests')]


294
295
296
297
298
299
300
301
302
303
304
305
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
306
    try:
307
        p = subprocess.Popen(cmd, stdin=subprocess.PIPE, stderr=subprocess.PIPE)
Christoph Groth's avatar
Christoph Groth committed
308
309
310
    except OSError:
        pass
    else:
311
312
313
        p.communicate(input='int main() {}\n')
        if p.wait() == 0:
            return {'libraries': libs}
Christoph Groth's avatar
Christoph Groth committed
314
315
316
317
318
319
320
321
    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."""

322
    global build_summary, config_file_present
Christoph Groth's avatar
Christoph Groth committed
323
324
    build_summary = []

325
    #### Add components of Kwant without external compile-time dependencies.
Christoph Groth's avatar
Christoph Groth committed
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
    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']})]

346
    #### Add components of Kwant with external compile-time dependencies.
Christoph Groth's avatar
Christoph Groth committed
347
348
349
350
351
    config = ConfigParser.ConfigParser()
    try:
        with open(CONFIG_FILE) as f:
            config.readfp(f)
    except IOError:
352
353
354
        config_file_present = False
    else:
        config_file_present = True
Christoph Groth's avatar
Christoph Groth committed
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379

    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:
380
        kwrds = search_mumps()
Christoph Groth's avatar
Christoph Groth committed
381
        if kwrds:
382
            build_summary.append('Auto-configured MUMPS')
Christoph Groth's avatar
Christoph Groth committed
383
384
385
386
387
388
389
390
391
392
393
394
395
396
    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


397
398
399
400
401
402
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)
403
        print(msg.format(ver), file=sys.stderr)
404
    else:
405
        print("Run setup.py without", NO_CYTHON_OPTION, file=sys.stderr)
406
407


Christoph Groth's avatar
Christoph Groth committed
408
409
410
411
def ext_modules(extensions):
    """Prepare the ext_modules argument for distutils' setup."""
    result = []
    for args, kwrds in extensions:
412
        if not cythonize or cython_version < REQUIRED_CYTHON_VERSION:
Christoph Groth's avatar
Christoph Groth committed
413
414
415
416
417
418
            if 'language' in kwrds:
                if kwrds['language'] == 'c':
                    ext = '.c'
                elif kwrds['language'] == 'c++':
                    ext = '.cpp'
                else:
419
                    print('Unknown language', file=sys.stderr)
Christoph Groth's avatar
Christoph Groth committed
420
                    exit(1)
421
            else:
Christoph Groth's avatar
Christoph Groth committed
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
                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:
438
439
                print("error: Cython-generated file {} is missing.".format(f),
                      file=sys.stderr)
440
                complain_cython_unavailable()
441
                exit(1)
Christoph Groth's avatar
Christoph Groth committed
442
            for f in pyx_files + kwrds.get('depends', []):
443
444
445
446
                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
447
                if os.stat(f).st_mtime > cythonized_oldest:
448
                    msg = "error: {} is newer than its source file, but "
449
450
451
452
                    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
453
                    else:
454
                        msg += "Cython is not to be run."
455
                    print(msg.format(f), file=sys.stderr)
456
457
                    complain_cython_unavailable()
                    exit(1)
Christoph Groth's avatar
Christoph Groth committed
458
459
460
461
462
463
464
465
466

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

    return result


def main():
    setup(name='kwant',
          version=version(),
467
468
          author='C. W. Groth (CEA), M. Wimmer, '
                 'A. R. Akhmerov, X. Waintal (CEA), and others',
469
          author_email='authors@kwant-project.org',
Christoph Groth's avatar
Christoph Groth committed
470
          description="Package for numerical quantum transport calculations.",
471
472
          long_description=long_description(),
          platforms=["Unix", "Linux", "Mac OS-X", "Windows"],
473
474
          url="http://kwant-project.org/",
          license="BSD",
475
          packages=packages(),
476
          cmdclass={'build': kwant_build,
477
                    'sdist': kwant_sdist,
478
                    'build_ext': kwant_build_ext,
Christoph Groth's avatar
Christoph Groth committed
479
480
                    'build_tut': build_tut,
                    'test': test},
Christoph Groth's avatar
Christoph Groth committed
481
482
          ext_modules=ext_modules(extensions()),
          include_dirs=[numpy.get_include()])
483

Christoph Groth's avatar
Christoph Groth committed
484
485
if __name__ == '__main__':
    main()