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

Christoph Groth's avatar
Christoph Groth committed
11
CONFIG_FILE = 'build.conf'
12
README_FILE = 'README'
Christoph Groth's avatar
Christoph Groth committed
13
14
15
STATIC_VERSION_FILE = 'kwant/_static_version.py'
REQUIRED_CYTHON_VERSION = (0, 17, 1)
NO_CYTHON_OPTION = '--no-cython'
16
17
18
TUT_DIR = 'tutorial'
TUT_GLOB = 'doc/source/tutorial/*.py'
TUT_HIDDEN_PREFIX = '#HIDDEN'
Christoph Groth's avatar
Christoph Groth committed
19
20
21

import sys
import os
22
import glob
Christoph Groth's avatar
Christoph Groth committed
23
24
import subprocess
import ConfigParser
Christoph Groth's avatar
Christoph Groth committed
25
26
27
28
from distutils.core import setup, Extension, Command
from distutils.util import get_platform
from distutils.errors import DistutilsError, DistutilsModuleError, \
    CCompilerError
29
from distutils.command.build import build as distutils_build
30
from distutils.command.sdist import sdist as distutils_sdist
Christoph Groth's avatar
Christoph Groth committed
31
32
33
34
35
36
37
38
39
import numpy

try:
    import Cython
except:
    cython_version = ()
else:
    cython_version = tuple(
        int(n) for n in Cython.__version__.split('-')[0].split('.'))
40

Christoph Groth's avatar
Christoph Groth committed
41
42
43
44
45
46
47
try:
    sys.argv.remove(NO_CYTHON_OPTION)
    cythonize = False
except ValueError:
    cythonize = True

if cythonize and cython_version:
48
49
    from Cython.Distutils import build_ext
else:
Christoph Groth's avatar
Christoph Groth committed
50
51
    from distutils.command.build_ext import build_ext

52
53
kwant_dir = os.path.dirname(os.path.abspath(__file__))

Christoph Groth's avatar
Christoph Groth committed
54
55
56

class kwant_build_ext(build_ext):
    def run(self):
57
58
59
60
61
62
63
64
        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
65
66
67
68
69
        try:
            build_ext.run(self)
        except (DistutilsError, CCompilerError):
            print >>sys.stderr, \
"""{0}
70
The compilation of Kwant has failed.  Please examine the error message
Christoph Groth's avatar
Christoph Groth committed
71
above and consult the installation instructions in README.
Christoph Groth's avatar
Christoph Groth committed
72
73
74
75
76
77
78
79
80
You might have to customize {1}.
{0}
Build configuration was:
{2}
{0}""".format('*' * 70, CONFIG_FILE, build_summary)
            raise
        print '**************** Build summary ****************'
        print build_summary

81

82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
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))
97
98
99
100
101
            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)
102
103
104
105
106
107
108
109


# 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
110
111


Christoph Groth's avatar
Christoph Groth committed
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
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)
        print '**************** Tests ****************'
        if not run(argv=[__file__, '-v', lib_dir]):
            raise DistutilsError('at least one of the tests failed')


136
137
138
139
140
141
142
143
144
145
def git_lsfiles():
    try:
        p = subprocess.Popen(['git', 'ls-files'], cwd=kwant_dir,
                             stdout=subprocess.PIPE, stderr=subprocess.PIPE)
    except OSError:
        return

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


148
149
150
151
152
153
# 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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180

    def run(self):
        names = git_lsfiles()
        trustworthy = True
        if names is None:
            # Check that MANIFEST exists and has not been generated by
            # distutils.
            try:
                with open(kwant_dir + '/MANIFEST', 'r') as f:
                    line = f.read()
            except IOError:
                print >>sys.stderr, "error: MANIFEST file is missing and " \
                    "Git is not available to regenerate it."
                exit(1)
            trustworthy = not line.strip().startswith('#')
        else:
            # Generate MANIFEST file.
            with open(kwant_dir + '/MANIFEST', 'w') as f:
                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')
181
                f.write('MANIFEST\n')
182
183
184
185
186
187
188
189
190
191
192
193
194
195

        distutils_sdist.run(self)

        if names is None:
            print >>sys.stderr, \
    """**************** Warning ****************
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."""

        if not trustworthy:
            print >>sys.stderr, \
    """**************** Warning ****************
The existing MANIFEST file seems to have been generated by distutils (it begins
with a comment).  It may well be incomplete."""
196
197


198
# This is an exact copy of the function from kwant/version.py.  We can't import
199
# it here (because Kwant is not yet built when this scipt is run), so we just
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
# include a copy.
def get_version_from_git():
    try:
        p = subprocess.Popen(['git', 'describe'], cwd=kwant_dir,
                             stdout=subprocess.PIPE, stderr=subprocess.PIPE)
    except OSError:
        return

    if p.wait() != 0:
        return
    version = p.communicate()[0].strip()

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

    try:
        p = subprocess.Popen(['git', 'diff', '--quiet'], cwd=kwant_dir)
    except OSError:
        version += '-confused'  # This should never happen.
    else:
        if p.wait() == 1:
            version += '-dirty'
    return version

Christoph Groth's avatar
Christoph Groth committed
224

225
def get_static_version():
226
    """Return the version as recorded inside the source code."""
227
    try:
Christoph Groth's avatar
Christoph Groth committed
228
        with open(STATIC_VERSION_FILE) as f:
229
230
231
232
233
234
235
            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
236
237

def version():
238
    """Determine the version of Kwant.  Return it and save it in a file."""
Christoph Groth's avatar
Christoph Groth committed
239
240
241
242
243
244
245
246
247
248
249
250
251
252
    git_version = get_version_from_git()
    static_version = get_static_version()
    if git_version is not None:
        version = git_version
        if static_version != git_version:
            with open(STATIC_VERSION_FILE, 'w') as f:
                f.write("version = '%s'\n" % version)
    elif static_version is not None:
        version = static_version
    else:
        version = 'unknown'
    return version


253
254
255
256
257
258
259
260
261
262
263
264
265
def long_description():
    text = []
    try:
        with open(README_FILE) as f:
            for line in f:
                if line == "\n":
                    break
                text.append(line.rstrip())
    except:
        return ''
    return '\n'.join(text)


266
267
268
269
270
271
def packages():
    return [root.replace('/', '.')
            for root, dnames, fnames in os.walk('kwant')
            if '__init__.py' in fnames or root.endswith('/tests')]


272
273
274
275
276
277
278
279
280
281
282
283
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
284
    try:
285
        p = subprocess.Popen(cmd, stdin=subprocess.PIPE, stderr=subprocess.PIPE)
Christoph Groth's avatar
Christoph Groth committed
286
287
288
    except OSError:
        pass
    else:
289
290
291
        p.communicate(input='int main() {}\n')
        if p.wait() == 0:
            return {'libraries': libs}
Christoph Groth's avatar
Christoph Groth committed
292
293
294
295
296
297
298
299
    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."""

300
    global build_summary, config_file_present
Christoph Groth's avatar
Christoph Groth committed
301
302
    build_summary = []

303
    #### Add components of Kwant without external compile-time dependencies.
Christoph Groth's avatar
Christoph Groth committed
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
    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']})]

324
    #### Add components of Kwant with external compile-time dependencies.
Christoph Groth's avatar
Christoph Groth committed
325
326
327
328
329
    config = ConfigParser.ConfigParser()
    try:
        with open(CONFIG_FILE) as f:
            config.readfp(f)
    except IOError:
330
331
332
        config_file_present = False
    else:
        config_file_present = True
Christoph Groth's avatar
Christoph Groth committed
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357

    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:
358
        kwrds = search_mumps()
Christoph Groth's avatar
Christoph Groth committed
359
        if kwrds:
360
            build_summary.append('Auto-configured MUMPS')
Christoph Groth's avatar
Christoph Groth committed
361
362
363
364
365
366
367
368
369
370
371
372
373
374
    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


375
376
377
378
379
380
381
382
383
384
385
386
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)
        print >>sys.stderr, msg.format(ver)
    else:
        print >>sys.stderr, "Run setup.py without", \
            NO_CYTHON_OPTION


Christoph Groth's avatar
Christoph Groth committed
387
388
389
390
def ext_modules(extensions):
    """Prepare the ext_modules argument for distutils' setup."""
    result = []
    for args, kwrds in extensions:
391
        if not cythonize or cython_version < REQUIRED_CYTHON_VERSION:
Christoph Groth's avatar
Christoph Groth committed
392
393
394
395
396
397
398
399
            if 'language' in kwrds:
                if kwrds['language'] == 'c':
                    ext = '.c'
                elif kwrds['language'] == 'c++':
                    ext = '.cpp'
                else:
                    print >>sys.stderr, 'Unknown language'
                    exit(1)
400
            else:
Christoph Groth's avatar
Christoph Groth committed
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
                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:
                print >>sys.stderr, \
418
                    "error: Cython-generated file {0} is missing.".format(f)
419
                complain_cython_unavailable()
420
                exit(1)
Christoph Groth's avatar
Christoph Groth committed
421
            for f in pyx_files + kwrds.get('depends', []):
422
423
424
425
                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
426
                if os.stat(f).st_mtime > cythonized_oldest:
427
428
429
430
431
                    msg = "error: {0} is newer than its source file, but "
                    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
432
                    else:
433
                        msg += "Cython is not to be run."
Christoph Groth's avatar
Christoph Groth committed
434
                    print >>sys.stderr, msg.format(f)
435
436
                    complain_cython_unavailable()
                    exit(1)
Christoph Groth's avatar
Christoph Groth committed
437
438
439
440
441
442
443
444
445

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

    return result


def main():
    setup(name='kwant',
          version=version(),
Christoph Groth's avatar
Christoph Groth committed
446
          author='C. W. Groth (CEA), M. Wimmer, A. R. Akhmerov, X. Waintal (CEA), and others',
447
          author_email='authors@kwant-project.org',
Christoph Groth's avatar
Christoph Groth committed
448
          description="Package for numerical quantum transport calculations.",
449
450
          long_description=long_description(),
          platforms=["Unix", "Linux", "Mac OS-X", "Windows"],
451
452
          url="http://kwant-project.org/",
          license="BSD",
453
          packages=packages(),
454
          cmdclass={'build': kwant_build,
455
                    'sdist': kwant_sdist,
456
                    'build_ext': kwant_build_ext,
Christoph Groth's avatar
Christoph Groth committed
457
458
                    'build_tut': build_tut,
                    'test': test},
Christoph Groth's avatar
Christoph Groth committed
459
460
          ext_modules=ext_modules(extensions()),
          include_dirs=[numpy.get_include()])
461

Christoph Groth's avatar
Christoph Groth committed
462
463
if __name__ == '__main__':
    main()