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

v = sys.version_info
16
17
18
19
if v[:2] < (3, 4):
    error = "This version of Kwant requires Python 3.4 or above.\n"
    if v[0] == 2:
        error += "Kwant 1.1 is the last version to support Python 2."
20
21
22
    print(error, file=sys.stderr)
    sys.exit(1)

23
import re
Christoph Groth's avatar
Christoph Groth committed
24
import os
25
import glob
26
import imp
Christoph Groth's avatar
Christoph Groth committed
27
import subprocess
28
import configparser
29
from setuptools import setup, find_packages, Extension, Command
Christoph Groth's avatar
Christoph Groth committed
30
from sysconfig import get_platform
Christoph Groth's avatar
Christoph Groth committed
31
32
from distutils.errors import DistutilsError, DistutilsModuleError, \
    CCompilerError
33
from distutils.command.build import build
Christoph Groth's avatar
Christoph Groth committed
34
35
from setuptools.command.sdist import sdist
from setuptools.command.build_ext import build_ext
36

Christoph Groth's avatar
Christoph Groth committed
37

38
39
CONFIG_FILE = 'build.conf'
README_FILE = 'README.rst'
Christoph Groth's avatar
Christoph Groth committed
40
MANIFEST_IN_FILE = 'MANIFEST.in'
41
README_END_BEFORE = 'See also in this directory:'
42
STATIC_VERSION_PATH = ('kwant', '_kwant_version.py')
Christoph Groth's avatar
Christoph Groth committed
43
REQUIRED_CYTHON_VERSION = (0, 22)
44
CYTHON_OPTION = '--cython'
45
CYTHON_TRACE_OPTION = '--cython-trace'
46
47
48
TUT_DIR = 'tutorial'
TUT_GLOB = 'doc/source/tutorial/*.py'
TUT_HIDDEN_PREFIX = '#HIDDEN'
Joseph Weston's avatar
Joseph Weston committed
49
CLASSIFIERS = """\
50
    Development Status :: 5 - Production/Stable
Joseph Weston's avatar
Joseph Weston committed
51
52
53
54
55
56
57
58
59
60
    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"""

61

62
63
64
65
66
67
68
69
70
71
# 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

Christoph Groth's avatar
Christoph Groth committed
72
try:
73
    sys.argv.remove(CYTHON_OPTION)
74
    use_cython = True
75
except ValueError:
76
    use_cython = version_is_from_git
Christoph Groth's avatar
Christoph Groth committed
77

78
79
80
81
82
83
84
85
86
87
try:
    sys.argv.remove(CYTHON_TRACE_OPTION)
    trace_cython = True
    if not use_cython:
        print('error: --cython-trace provided, but cython will not be run',
              file=sys.stderr)
        exit(1)
except ValueError:
    trace_cython = False

88
if use_cython:
89
90
    try:
        import Cython
91
92
        from Cython.Build import cythonize
    except ImportError:
93
94
95
96
97
98
99
100
101
102
103
        cython_version = ()
    else:
        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)

104
distr_root = os.path.dirname(os.path.abspath(__file__))
105

106
107
108
def banner(title=''):
    starred = title.center(79, '*')
    return '\n' + starred if title else starred
109

110
error_msg = """{header}
111
112
113
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}}.
114

115
Build configuration was:
116

117
{{summary}}
118
119
120
{sep}
"""
error_msg = error_msg.format(header=banner(' Error '), sep=banner())
Christoph Groth's avatar
Christoph Groth committed
121

Christoph Groth's avatar
Christoph Groth committed
122

Christoph Groth's avatar
Christoph Groth committed
123
124
class kwant_build_ext(build_ext):
    def run(self):
125
126
127
128
129
130
131
132
        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
133
134
135
        try:
            build_ext.run(self)
        except (DistutilsError, CCompilerError):
136
137
            print(error_msg.format(file=CONFIG_FILE, summary=build_summary),
                  file=sys.stderr)
Christoph Groth's avatar
Christoph Groth committed
138
            raise
139
        print(banner(' Build summary '))
140
        print(build_summary)
141
        print(banner())
Christoph Groth's avatar
Christoph Groth committed
142

143

144
class kwant_build_tut(Command):
145
146
147
148
149
150
151
152
153
154
155
156
157
158
    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))
159
160
161
162
163
            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)
164
165
166
167
168
169


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

173
    def run(self):
174
        build.run(self)
175
176
        write_version(os.path.join(self.build_lib, *STATIC_VERSION_PATH))

177
178

def git_lsfiles():
179
    if not version_is_from_git:
180
181
        return

182
    try:
183
        p = subprocess.Popen(['git', 'ls-files'], cwd=distr_root,
184
185
186
187
188
189
                             stdout=subprocess.PIPE, stderr=subprocess.PIPE)
    except OSError:
        return

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


193
194
195
196
# 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.
197
198
class kwant_sdist(sdist):
    sub_commands = [('build', None)] + sdist.sub_commands
199
200

    def run(self):
Christoph Groth's avatar
Christoph Groth committed
201
202
203
204
205
206
207
208
209
210
        """
        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.
        """
        manifest = os.path.join(distr_root, MANIFEST_IN_FILE)
211
212
        names = git_lsfiles()
        if names is None:
Christoph Groth's avatar
Christoph Groth committed
213
214
215
216
            if not (os.path.isfile(manifest) and os.access(manifest, os.R_OK)):
                print("Error:", MANIFEST_IN_FILE,
                      "file is missing and Git is not available"
                      " to regenerate it.", file=sys.stderr)
217
218
                exit(1)
        else:
Christoph Groth's avatar
Christoph Groth committed
219
            with open(manifest, 'w') as f:
220
221
222
223
224
                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
225
                    f.write('include {}'.format(name))
226
                    if extension == 'pyx':
Christoph Groth's avatar
Christoph Groth committed
227
228
                        f.write(''.join([' ', a, sep, stem, dot, 'c']))
                    f.write('\n')
229

230
        sdist.run(self)
231
232

        if names is None:
233
            print(banner(' Caution '),
Christoph Groth's avatar
Christoph Groth committed
234
        """Git was not available to generate the list of files to be included in the
235
236
source distribution.  The old {} was used.""".format(MANIFEST_IN_FILE),
                  banner(), sep='\n', file=sys.stderr)
237

238
    def make_release_tree(self, base_dir, files):
239
        sdist.make_release_tree(self, base_dir, files)
240
        write_version(os.path.join(base_dir, *STATIC_VERSION_PATH))
241

Christoph Groth's avatar
Christoph Groth committed
242

243
244
245
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?
246
    try:
247
248
249
250
251
        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
252
        f.write("version = '{}'\n".format(version))
Christoph Groth's avatar
Christoph Groth committed
253
254


255
256
257
258
259
def long_description():
    text = []
    try:
        with open(README_FILE) as f:
            for line in f:
260
                if line.startswith(README_END_BEFORE):
261
262
                    break
                text.append(line.rstrip())
263
264
            while text[-1] == "":
                text.pop()
265
266
267
268
269
    except:
        return ''
    return '\n'.join(text)


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


def extensions():
Christoph Groth's avatar
Christoph Groth committed
294
    """Return a list of tuples (args, kwrds) to be passed to Extension."""
Christoph Groth's avatar
Christoph Groth committed
295

296
    global build_summary, config_file_present
Christoph Groth's avatar
Christoph Groth committed
297
298
    build_summary = []

299
    #### Add components of Kwant without external compile-time dependencies.
Christoph Groth's avatar
Christoph Groth committed
300
301
302
    result = [
        (['kwant._system', ['kwant/_system.pyx']],
         {'include_dirs': ['kwant/graph']}),
Joseph Weston's avatar
Joseph Weston committed
303
304
        (['kwant.operator', ['kwant/operator.pyx']],
         {'include_dirs': ['kwant/graph']}),
Christoph Groth's avatar
Christoph Groth committed
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
        (['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']})]

322
323
324
325
326
327
328
    #### Add cython tracing macro
    if trace_cython:
        for args, kwargs in result:
            macros = kwargs.get('define_macros', [])
            macros.append(('CYTHON_TRACE', '1'))
            kwargs['define_macros'] = macros

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

    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:
363
        kwrds = search_mumps()
Christoph Groth's avatar
Christoph Groth committed
364
        if kwrds:
365
            build_summary.append('Auto-configured MUMPS')
Christoph Groth's avatar
Christoph Groth committed
366
    if kwrds:
367
        for name, value in lapack.items():
Christoph Groth's avatar
Christoph Groth committed
368
369
370
371
372
373
374
375
376
377
378
379
            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


380
def complain_cython_unavailable():
381
382
    assert not use_cython or cython_version < REQUIRED_CYTHON_VERSION
    if use_cython:
383
384
        msg = ("Install Cython {0} or newer so it can be made\n"
               "or use a source distribution of Kwant.")
385
        ver = '.'.join(str(e) for e in REQUIRED_CYTHON_VERSION)
386
        print(msg.format(ver), file=sys.stderr)
387
    else:
388
        print("Run setup.py with the {} option.".format(CYTHON_OPTION),
389
              file=sys.stderr)
390
391


392
393
def maybe_cythonize(extensions):
    """Prepare a list of `Extension` instances, ready for `setup()`.
394

395
396
397
398
399
400
    The argument `extensions` must be a sequence of (args, kwrds) to be passed on
    to `Extension`.

    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.
401
    """
402
403
    if use_cython and cython_version >= REQUIRED_CYTHON_VERSION:
        return cythonize([Extension(*args, **kwrds)
404
                          for args, kwrds in extensions], language_level=3,
Christoph Groth's avatar
Christoph Groth committed
405
                         compiler_directives={'linetrace': trace_cython})
406
407
408
409

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

Christoph Groth's avatar
Christoph Groth committed
410
    result = []
411
    problematic_files = []
Christoph Groth's avatar
Christoph Groth committed
412
    for args, kwrds in extensions:
413
414
        name, sources = args

415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
        language = kwrds.get('language')
        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 = []
        new_sources = []
        for f in sources:
            if f.endswith('.pyx'):
                pyx_files.append(f)
                f = f.rstrip('.pyx') + ext
                cythonized_files.append(f)
            new_sources.append(f)
        sources = new_sources

        # 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:
            print("error: Cython-generated file {} is missing.".format(f),
                  file=sys.stderr)
            complain_cython_unavailable()
            exit(1)

        for f in pyx_files + kwrds.get('depends', []):
            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
454

455
        result.append(Extension(name, sources, **kwrds))
Christoph Groth's avatar
Christoph Groth committed
456

457
458
459
    if problematic_files:
        problematic_files = ", ".join(problematic_files)
        msg = ("Some Cython source files are newer than files that should have\n"
460
               "been derived from them, but {}.\n"
461
462
               "\n"
               "Affected files: {}")
463
        if use_cython:
464
465
466
467
468
469
470
471
472
473
            if not cython_version:
                reason = "Cython is not installed"
            else:
                reason = "the installed Cython is too old"
            print(banner(" Error "), msg.format(reason, problematic_files),
                  banner(), sep="\n", file=sys.stderr)
            print()
            complain_cython_unavailable()
            exit(1)
        else:
474
475
476
477
478
            reason = "the option {} has not been given".format(CYTHON_OPTION)
            dontworry = ('(Do not worry about this if you are building Kwant\n'
                         'from unmodified sources, e.g. with "pip install".)\n')
            print(banner(" Caution "), dontworry,
                  msg.format(reason, problematic_files),
479
480
                  banner(), sep='\n', file=sys.stderr)

Christoph Groth's avatar
Christoph Groth committed
481
482
    return result

483

Christoph Groth's avatar
Christoph Groth committed
484
485
def main():
    setup(name='kwant',
486
          version=version,
487
488
          author='C. W. Groth (CEA), M. Wimmer, '
                 'A. R. Akhmerov, X. Waintal (CEA), and others',
489
          author_email='authors@kwant-project.org',
490
          description=("Package for numerical quantum transport calculations "
491
                       "(Python 3 version)"),
492
493
          long_description=long_description(),
          platforms=["Unix", "Linux", "Mac OS-X", "Windows"],
494
495
          url="http://kwant-project.org/",
          license="BSD",
496
          packages=find_packages('.'),
497
          cmdclass={'build': kwant_build,
498
                    'sdist': kwant_sdist,
499
                    'build_ext': kwant_build_ext,
Christoph Groth's avatar
Christoph Groth committed
500
                    'build_tut': kwant_build_tut},
501
          ext_modules=maybe_cythonize(extensions()),
502
503
          setup_requires=['pytest-runner >= 2.7'],
          tests_require=['numpy > 1.6.1', 'pytest >= 2.6.3'],
Christoph Groth's avatar
Christoph Groth committed
504
          install_requires=['numpy > 1.6.1', 'scipy >= 0.9', 'tinyarray'],
Joseph Weston's avatar
Joseph Weston committed
505
506
          extras_require={'plotting': 'matplotlib >= 1.2'},
          classifiers=[c.strip() for c in CLASSIFIERS.split('\n')])
507

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