setup.py 18.3 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
from setuptools import setup, find_packages, Extension, Command
Christoph Groth's avatar
Christoph Groth committed
34
from sysconfig import get_platform
Christoph Groth's avatar
Christoph Groth committed
35
36
from distutils.errors import DistutilsError, DistutilsModuleError, \
    CCompilerError
37
from distutils.command.build import build
Christoph Groth's avatar
Christoph Groth committed
38
39
from setuptools.command.sdist import sdist
from setuptools.command.build_ext import build_ext
40

Christoph Groth's avatar
Christoph Groth committed
41

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

65

66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
distr_root = os.path.dirname(os.path.abspath(__file__))


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():
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
    """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`.
    """
    global cythonize, cython_help, trace_cython
99

100
    try:
101
        sys.argv.remove(CYTHON_OPTION)
102
        cythonize = True
103
    except ValueError:
104
        cythonize = version_is_from_git
105
106
107
108

    try:
        sys.argv.remove(CYTHON_TRACE_OPTION)
        trace_cython = True
109
110
        if not cythonize:
            print('Error: --cython-trace provided, but Cython will not be run.',
111
112
113
114
115
                  file=sys.stderr)
            exit(1)
    except ValueError:
        trace_cython = False

116
    if cythonize:
117
118
119
120
        try:
            import Cython
            from Cython.Build import cythonize
        except ImportError:
121
            cythonize = None
122
        else:
123
            #### Get Cython version.
124
125
126
127
128
129
130
131
            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)
132

133
134
135
136
137
138
139
140
141
142
143
144
            if cython_version < REQUIRED_CYTHON_VERSION:
                cythonize = None

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

145

146
147
148
def banner(title=''):
    starred = title.center(79, '*')
    return '\n' + starred if title else starred
149

Christoph Groth's avatar
Christoph Groth committed
150

Christoph Groth's avatar
Christoph Groth committed
151
152
class kwant_build_ext(build_ext):
    def run(self):
153
154
155
156
157
158
159
160
        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
161
162
163
        try:
            build_ext.run(self)
        except (DistutilsError, CCompilerError):
164
165
            error_msg = self.__error_msg.format(
                header=banner(' Error '), sep=banner())
166
167
            print(error_msg.format(file=CONFIG_FILE, summary=build_summary),
                  file=sys.stderr)
Christoph Groth's avatar
Christoph Groth committed
168
            raise
169
        print(banner(' Build summary '))
170
        print(build_summary)
171
        print(banner())
Christoph Groth's avatar
Christoph Groth committed
172

173
174
175
176
177
178
179
180
181
182
183
    __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}
"""

184

185
class kwant_build_tut(Command):
186
187
188
189
190
191
192
193
194
195
196
197
198
199
    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))
200
201
202
203
204
            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)
205
206
207
208
209
210


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

214
    def run(self):
215
        build.run(self)
216
217
        write_version(os.path.join(self.build_lib, *STATIC_VERSION_PATH))

218
219

def git_lsfiles():
220
    if not version_is_from_git:
221
222
        return

223
    try:
224
        p = subprocess.Popen(['git', 'ls-files'], cwd=distr_root,
225
226
227
228
229
230
                             stdout=subprocess.PIPE, stderr=subprocess.PIPE)
    except OSError:
        return

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


234
235
236
237
# 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.
238
239
class kwant_sdist(sdist):
    sub_commands = [('build', None)] + sdist.sub_commands
240
241

    def run(self):
Christoph Groth's avatar
Christoph Groth committed
242
243
244
245
246
247
248
249
250
251
        """
        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)
252
253
        names = git_lsfiles()
        if names is None:
Christoph Groth's avatar
Christoph Groth committed
254
255
256
257
            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)
258
259
                exit(1)
        else:
Christoph Groth's avatar
Christoph Groth committed
260
            with open(manifest, 'w') as f:
261
262
263
264
265
                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
266
                    f.write('include {}'.format(name))
267
                    if extension == 'pyx':
Christoph Groth's avatar
Christoph Groth committed
268
269
                        f.write(''.join([' ', a, sep, stem, dot, 'c']))
                    f.write('\n')
270

271
        sdist.run(self)
272
273

        if names is None:
274
275
276
277
            msg = ("Git was not available to generate the list of files to be "
                   "included in the\nsource distribution. The old {} was used.")
            msg = msg.format(MANIFEST_IN_FILE)
            print(banner(' Caution '), msg, banner(), sep='\n', file=sys.stderr)
278

279
    def make_release_tree(self, base_dir, files):
280
        sdist.make_release_tree(self, base_dir, files)
281
        write_version(os.path.join(base_dir, *STATIC_VERSION_PATH))
282

Christoph Groth's avatar
Christoph Groth committed
283

284
285
286
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?
287
    try:
288
289
290
291
292
        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
293
        f.write("version = '{}'\n".format(version))
Christoph Groth's avatar
Christoph Groth committed
294
295


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


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

337
    global build_summary, config_file_present
Christoph Groth's avatar
Christoph Groth committed
338
339
    build_summary = []

340
    #### Add components of Kwant without external compile-time dependencies.
Christoph Groth's avatar
Christoph Groth committed
341
342
343
    result = [
        (['kwant._system', ['kwant/_system.pyx']],
         {'include_dirs': ['kwant/graph']}),
Joseph Weston's avatar
Joseph Weston committed
344
345
        (['kwant.operator', ['kwant/operator.pyx']],
         {'include_dirs': ['kwant/graph']}),
Christoph Groth's avatar
Christoph Groth committed
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
        (['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']})]

363
364
365
366
367
368
369
    #### 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

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

    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:
404
        kwrds = search_mumps()
Christoph Groth's avatar
Christoph Groth committed
405
        if kwrds:
406
            build_summary.append('Auto-configured MUMPS')
Christoph Groth's avatar
Christoph Groth committed
407
    if kwrds:
408
        for name, value in lapack.items():
Christoph Groth's avatar
Christoph Groth committed
409
410
411
412
413
414
415
416
417
418
419
420
            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


421
422
def maybe_cythonize(extensions):
    """Prepare a list of `Extension` instances, ready for `setup()`.
423

424
425
426
427
428
429
    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.
430
    """
431
    if cythonize:
432
        return cythonize([Extension(*args, **kwrds)
433
                          for args, kwrds in extensions], language_level=3,
Christoph Groth's avatar
Christoph Groth committed
434
                         compiler_directives={'linetrace': trace_cython})
435
436
437
438

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

Christoph Groth's avatar
Christoph Groth committed
439
    result = []
440
    problematic_files = []
Christoph Groth's avatar
Christoph Groth committed
441
    for args, kwrds in extensions:
442
443
        name, sources = args

444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
        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:
471
472
473
            msg = "Cython-generated file {} is missing."
            print(banner(" Error "), msg.format(f), "",
                  cython_help, banner(), sep="\n", file=sys.stderr)
474
475
476
477
478
479
480
481
482
            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
483

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

486
    if problematic_files:
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
        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:
503
504
            exit(1)

Christoph Groth's avatar
Christoph Groth committed
505
506
    return result

507

Christoph Groth's avatar
Christoph Groth committed
508
def main():
509
510
511
    get_version()
    init_cython()

Christoph Groth's avatar
Christoph Groth committed
512
    setup(name='kwant',
513
          version=version,
514
515
          author='C. W. Groth (CEA), M. Wimmer, '
                 'A. R. Akhmerov, X. Waintal (CEA), and others',
516
          author_email='authors@kwant-project.org',
517
          description=("Package for numerical quantum transport calculations "
518
                       "(Python 3 version)"),
519
520
          long_description=long_description(),
          platforms=["Unix", "Linux", "Mac OS-X", "Windows"],
521
522
          url="http://kwant-project.org/",
          license="BSD",
523
          packages=find_packages('.'),
524
          cmdclass={'build': kwant_build,
525
                    'sdist': kwant_sdist,
526
                    'build_ext': kwant_build_ext,
Christoph Groth's avatar
Christoph Groth committed
527
                    'build_tut': kwant_build_tut},
528
          ext_modules=maybe_cythonize(extensions()),
529
530
          setup_requires=['pytest-runner >= 2.7'],
          tests_require=['numpy > 1.6.1', 'pytest >= 2.6.3'],
Christoph Groth's avatar
Christoph Groth committed
531
          install_requires=['numpy > 1.6.1', 'scipy >= 0.9', 'tinyarray'],
Joseph Weston's avatar
Joseph Weston committed
532
533
          extras_require={'plotting': 'matplotlib >= 1.2'},
          classifiers=[c.strip() for c in CLASSIFIERS.split('\n')])
534

Christoph Groth's avatar
Christoph Groth committed
535
536
if __name__ == '__main__':
    main()