setup.py 20.3 KB
Newer Older
1
#!/usr/bin/env python3
2

3
# Copyright 2011-2018 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 12
from __future__ import print_function

Christoph Groth's avatar
Christoph Groth committed
13
import sys
14

15
import re
Christoph Groth's avatar
Christoph Groth committed
16
import os
17
import glob
18
import importlib
Christoph Groth's avatar
Christoph Groth committed
19
import subprocess
20
import configparser
21
import collections
22
from setuptools import setup, find_packages, Extension, Command
23
from distutils.errors import DistutilsError, CCompilerError
24 25 26
from distutils.command.build import build as build_orig
from setuptools.command.sdist import sdist as sdist_orig
from setuptools.command.build_ext import build_ext as build_ext_orig
27
from setuptools.command.test import test as test_orig
28

Christoph Groth's avatar
Christoph Groth committed
29

30
STATIC_VERSION_PATH = ('kwant', '_kwant_version.py')
31

32 33 34
distr_root = os.path.dirname(os.path.abspath(__file__))


35 36 37 38 39
def configure_extensions(exts, aliases=(), build_summary=None):
    """Modify extension configuration according to the configuration file

    `exts` must be a dict of (name, kwargs) tuples that can be used like this:
    `Extension(name, **kwargs).  This function modifies the kwargs according to
40 41 42
    the configuration file.

    This function modifies `sys.argv`.
43
    """
44 45 46 47
    global config_file, config_file_present

    #### Determine the name of the configuration file.
    config_file_option = '--configfile'
48
    config_file_option_present = False
49 50 51 52
    # Handle command line option
    for i, opt in enumerate(sys.argv):
        if not opt.startswith(config_file_option):
            continue
53
        config_file_option_present = True
54 55
        l, _, config_file = opt.partition('=')
        if l != config_file_option or not config_file:
56
            print('Error: Expecting {}=PATH'.format(config_file_option),
57
                  file=sys.stderr)
58
            sys.exit(1)
59 60 61 62
        sys.argv.pop(i)
        break
    else:
        config_file = 'build.conf'
63 64 65 66

    #### Read build configuration file.
    configs = configparser.ConfigParser()
    try:
67
        with open(config_file) as f:
68 69 70
            configs.read_file(f)
    except IOError:
        config_file_present = False
71 72 73 74
        if config_file_option_present:
            print("Error: '{}' option was provided, but '{}' does not exist"
                  .format(config_file_option, config_file))
            sys.exit(1)
75 76 77 78 79 80 81 82
    else:
        config_file_present = True

    #### Handle section aliases.
    for short, long in aliases:
        if short in configs:
            if long in configs:
                print('Error: both {} and {} sections present in {}.'.format(
83
                    short, long, config_file))
84
                sys.exit(1)
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
            configs[long] = configs[short]
            del configs[short]

    #### Apply config from file.  Use [DEFAULT] section for missing sections.
    defaultconfig = configs.defaults()
    for name, kwargs in exts.items():
        config = configs[name] if name in configs else defaultconfig
        for key, value in config.items():

            # Most, but not all, keys are lists of strings
            if key == 'language':
                pass
            elif key == 'optional':
                value = bool(int(value))
            else:
                value = value.split()

            if key == 'define_macros':
                value = [tuple(entry.split('=', maxsplit=1))
                         for entry in value]
                value = [(entry[0], None) if len(entry) == 1 else entry
                         for entry in value]

            if key in kwargs:
                msg = 'Caution: user config in file {} shadows {}.{}.'
                if build_summary is not None:
111
                    build_summary.append(msg.format(config_file, name, key))
112 113
            kwargs[key] = value

114
        kwargs.setdefault('depends', []).append(config_file)
115 116 117 118 119 120
        if config is not defaultconfig:
            del configs[name]

    unknown_sections = configs.sections()
    if unknown_sections:
        print('Error: Unknown sections in file {}: {}'.format(
121
            config_file, ', '.join(unknown_sections)))
122
        sys.exit(1)
123 124 125 126

    return exts


127 128 129 130 131 132 133 134 135 136
def check_python_version(min_version):
    installed_version = sys.version_info[:3]
    if installed_version < min_version:
        print('Error: Python {} required, but {} is installed'.format(
              '.'.join(map(str, min_version)),
              '.'.join(map(str, installed_version)))
        )
        sys.exit(1)


137
def check_versions():
138 139 140 141
    global version, version_is_from_git

    # Let Kwant itself determine its own version.  We cannot simply import
    # kwant, as it is not built yet.
142 143 144
    spec = importlib.util.spec_from_file_location('version', 'kwant/version.py')
    version_module = importlib.util.module_from_spec(spec)
    spec.loader.exec_module(version_module)
145

146 147 148
    version_module.ensure_python()
    version = version_module.version
    version_is_from_git = version_module.version_is_from_git
149 150 151


def init_cython():
152 153 154 155 156 157 158 159 160 161 162 163 164 165
    """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`.
    """
166
    global cythonize, cython_help
167

168
    cython_option = '--cython'
Joseph Weston's avatar
Joseph Weston committed
169
    required_cython_version = (0, 24)
170
    try:
171
        sys.argv.remove(cython_option)
172
        cythonize = True
173
    except ValueError:
174
        cythonize = version_is_from_git
175

176
    if cythonize:
177 178 179 180
        try:
            import Cython
            from Cython.Build import cythonize
        except ImportError:
181
            cythonize = None
182
        else:
183
            #### Get Cython version.
184 185 186 187 188 189 190 191
            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)
192

193
            if cython_version < required_cython_version:
194 195
                cythonize = None

196 197 198 199 200
        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)
201 202
    else:
        msg = "Run setup.py with the {} option to enable Cython."
203
        cython_help = msg.format(cython_option)
204

205

206 207 208
def banner(title=''):
    starred = title.center(79, '*')
    return '\n' + starred if title else starred
209

Christoph Groth's avatar
Christoph Groth committed
210

211
class build_ext(build_ext_orig):
Christoph Groth's avatar
Christoph Groth committed
212
    def run(self):
213 214 215 216 217
        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.
218 219 220
            with open(config_file, 'w') as f:
                f.write('# Build configuration created by setup.py '
                        '- feel free to modify.\n')
221

Christoph Groth's avatar
Christoph Groth committed
222
        try:
Christoph Groth's avatar
Christoph Groth committed
223
            super().run()
Christoph Groth's avatar
Christoph Groth committed
224
        except (DistutilsError, CCompilerError):
225 226
            error_msg = self.__error_msg.format(
                header=banner(' Error '), sep=banner())
227
            print(error_msg.format(file=config_file, summary=build_summary),
228
                  file=sys.stderr)
Christoph Groth's avatar
Christoph Groth committed
229
            raise
230
        print(banner(' Build summary '), *build_summary, sep='\n')
231
        print(banner())
Christoph Groth's avatar
Christoph Groth committed
232

233 234 235 236 237 238 239 240 241 242 243
    __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}
"""

244

245
class build(build_orig):
246
    def run(self):
Christoph Groth's avatar
Christoph Groth committed
247
        super().run()
248 249
        write_version(os.path.join(self.build_lib, *STATIC_VERSION_PATH))

250 251

def git_lsfiles():
252
    if not version_is_from_git:
253 254
        return

255
    try:
256
        p = subprocess.Popen(['git', 'ls-files'], cwd=distr_root,
257 258 259 260 261 262
                             stdout=subprocess.PIPE, stderr=subprocess.PIPE)
    except OSError:
        return

    if p.wait() != 0:
        return
263
    return p.communicate()[0].decode().split('\n')[:-1]
264 265


266 267
# Make the command "sdist" depend on "build".  This verifies that the
# distribution in the current state actually builds.  It also makes sure that
268
# the Cython-made C files will be up-to-date and included in the source.
269 270
class sdist(sdist_orig):
    sub_commands = [('build', None)] + sdist_orig.sub_commands
271 272

    def run(self):
Christoph Groth's avatar
Christoph Groth committed
273 274
        """Create MANIFEST.in from git if possible, otherwise check that
        MANIFEST.in is present.
Christoph Groth's avatar
Christoph Groth committed
275 276 277 278 279 280

        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.
        """
281 282
        manifest_in_file = 'MANIFEST.in'
        manifest = os.path.join(distr_root, manifest_in_file)
283 284
        names = git_lsfiles()
        if names is None:
Christoph Groth's avatar
Christoph Groth committed
285
            if not (os.path.isfile(manifest) and os.access(manifest, os.R_OK)):
286
                print("Error:", manifest_in_file,
Christoph Groth's avatar
Christoph Groth committed
287 288
                      "file is missing and Git is not available"
                      " to regenerate it.", file=sys.stderr)
289
                sys.exit(1)
290
        else:
Christoph Groth's avatar
Christoph Groth committed
291
            with open(manifest, 'w') as f:
292 293 294 295 296
                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
297
                    f.write('include {}'.format(name))
298
                    if extension == 'pyx':
Christoph Groth's avatar
Christoph Groth committed
299 300
                        f.write(''.join([' ', a, sep, stem, dot, 'c']))
                    f.write('\n')
301

Christoph Groth's avatar
Christoph Groth committed
302
        super().run()
303 304

        if names is None:
305 306
            msg = ("Git was not available to generate the list of files to be "
                   "included in the\nsource distribution. The old {} was used.")
307
            msg = msg.format(manifest_in_file)
308
            print(banner(' Caution '), msg, banner(), sep='\n', file=sys.stderr)
309

310
    def make_release_tree(self, base_dir, files):
Christoph Groth's avatar
Christoph Groth committed
311
        super().make_release_tree(base_dir, files)
312
        write_version(os.path.join(base_dir, *STATIC_VERSION_PATH))
313

Christoph Groth's avatar
Christoph Groth committed
314

Christoph Groth's avatar
Christoph Groth committed
315 316
# The following class is based on a recipe in
# http://doc.pytest.org/en/latest/goodpractices.html#manual-integration.
317
class test(test_orig):
Christoph Groth's avatar
Christoph Groth committed
318 319 320 321 322 323 324 325
    user_options = [('pytest-args=', 'a', "Arguments to pass to pytest")]

    def initialize_options(self):
        super().initialize_options()
        self.pytest_args = ''

    def run_tests(self):
        import shlex
326
        try:
Christoph Groth's avatar
Christoph Groth committed
327 328 329
            import pytest
        except:
            print('The Python package "pytest" is required to run tests.',
330
                  file=sys.stderr)
331
            sys.exit(1)
Christoph Groth's avatar
Christoph Groth committed
332 333
        errno = pytest.main(shlex.split(self.pytest_args))
        sys.exit(errno)
334 335


336 337 338
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?
339
    try:
340 341 342 343 344
        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
345
        f.write("version = '{}'\n".format(version))
Christoph Groth's avatar
Christoph Groth committed
346 347


348 349 350
def long_description():
    text = []
    try:
Christoph Groth's avatar
Christoph Groth committed
351
        with open('README.rst', encoding='utf8') as f:
352
            for line in f:
353
                if line.startswith('See also in this directory:'):
354 355
                    break
                text.append(line.rstrip())
356 357
            while text[-1] == "":
                text.pop()
358 359 360 361 362
    except:
        return ''
    return '\n'.join(text)


363
def search_libs(libs):
364 365 366
    cmd = ['gcc']
    cmd.extend(['-l' + lib for lib in libs])
    cmd.extend(['-o/dev/null', '-xc', '-'])
Christoph Groth's avatar
Christoph Groth committed
367
    try:
368
        p = subprocess.Popen(cmd, stdin=subprocess.PIPE, stderr=subprocess.PIPE)
Christoph Groth's avatar
Christoph Groth committed
369 370 371
    except OSError:
        pass
    else:
372
        p.communicate(input=b'int main() {}\n')
373
        if p.wait() == 0:
374 375 376 377 378 379 380 381 382 383 384 385 386 387
            return libs


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 and the MUMPS binaries in the conda-forge channel."""
    lib_sets = [
        # Debian
        ['zmumps_scotch', 'mumps_common_scotch', 'mpiseq_scotch'],
        # Conda (via conda-forge).
        # TODO: remove dependency libs (scotch, metis...) when conda-forge
        # packaged mumps/scotch are built as properly linked shared libs
388
        # 'openblas' provides Lapack and BLAS symbols
389
        ['zmumps', 'mumps_common', 'metis', 'esmumps', 'scotch',
390
         'scotcherr', 'mpiseq', 'openblas'],
391 392 393 394 395 396 397 398 399 400
    ]
    common_libs = ['pord', 'gfortran']

    for libs in lib_sets:
        found_libs = search_libs(libs + common_libs)
        if found_libs:
            return found_libs
    return []


401 402 403 404
def configure_special_extensions(exts, build_summary):
    #### Special config for MUMPS.
    mumps = exts['kwant.linalg._mumps']
    if 'libraries' in mumps:
Christoph Groth's avatar
Christoph Groth committed
405 406
        build_summary.append('User-configured MUMPS')
    else:
407 408 409
        mumps_libs = search_mumps()
        if mumps_libs:
            mumps['libraries'] = mumps_libs
410
            build_summary.append('Auto-configured MUMPS')
411 412
        else:
            mumps = None
413
            del exts['kwant.linalg._mumps']
414
            build_summary.append('No MUMPS support')
Christoph Groth's avatar
Christoph Groth committed
415

416
    return exts
Christoph Groth's avatar
Christoph Groth committed
417

418 419

def maybe_cythonize(exts):
420
    """Prepare a list of `Extension` instances, ready for `setup()`.
421

422 423
    The argument `exts` must be a mapping of names to kwargs to be passed
    on to `Extension`.
424 425 426 427

    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.
428
    """
429
    if cythonize:
430 431 432
        return cythonize([Extension(name, **kwargs)
                          for name, kwargs in exts.items()],
                         language_level=3,
433
                         compiler_directives={'linetrace': True})
434 435 436 437

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

Christoph Groth's avatar
Christoph Groth committed
438
    result = []
439
    problematic_files = []
440 441
    for name, kwargs in exts.items():
        language = kwargs.get('language')
442 443 444 445 446 447 448 449
        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)
450
            sys.exit(1)
451 452 453

        pyx_files = []
        cythonized_files = []
454 455
        sources = []
        for f in kwargs['sources']:
456 457 458 459
            if f.endswith('.pyx'):
                pyx_files.append(f)
                f = f.rstrip('.pyx') + ext
                cythonized_files.append(f)
460 461
            sources.append(f)
        kwargs['sources'] = sources
462 463 464 465 466 467

        # 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:
468 469 470
            msg = "Cython-generated file {} is missing."
            print(banner(" Error "), msg.format(f), "",
                  cython_help, banner(), sep="\n", file=sys.stderr)
471
            sys.exit(1)
472

473
        for f in pyx_files + kwargs.get('depends', []):
474
            if f == config_file:
475 476 477 478 479
                # 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
480

481
        result.append(Extension(name, **kwargs))
Christoph Groth's avatar
Christoph Groth committed
482

483
    if problematic_files:
484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499
        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:
500
            sys.exit(1)
501

Christoph Groth's avatar
Christoph Groth committed
502 503
    return result

504

505 506 507 508 509 510 511 512 513 514 515 516 517 518
def maybe_add_numpy_include(exts):
    # Add NumPy header path to include_dirs of all the extensions.
    try:
        import numpy
    except ImportError:
        print(banner(' Caution '), 'NumPy header directory cannot be determined'
              ' ("import numpy" failed).', banner(), sep='\n', file=sys.stderr)
    else:
        numpy_include = numpy.get_include()
        for ext in exts.values():
            ext.setdefault('include_dirs', []).append(numpy_include)
    return exts


Christoph Groth's avatar
Christoph Groth committed
519
def main():
520
    check_python_version((3, 6))
521 522
    check_versions()

523 524 525 526 527 528 529 530 531 532 533
    exts = collections.OrderedDict([
        ('kwant._system',
         dict(sources=['kwant/_system.pyx'],
              include_dirs=['kwant/graph'])),
        ('kwant.operator',
         dict(sources=['kwant/operator.pyx'],
              include_dirs=['kwant/graph'])),
        ('kwant.graph.core',
         dict(sources=['kwant/graph/core.pyx'],
              depends=['kwant/graph/core.pxd', 'kwant/graph/defs.h',
                       'kwant/graph/defs.pxd'])),
534 535
        ('kwant.graph.dijkstra',
         dict(sources=['kwant/graph/dijkstra.pyx'])),
536
        ('kwant.linalg.lapack',
537
         dict(sources=['kwant/linalg/lapack.pyx'])),
538 539 540 541
        ('kwant.linalg._mumps',
         dict(sources=['kwant/linalg/_mumps.pyx'],
              depends=['kwant/linalg/cmumps.pxd']))])

542
    aliases = [('mumps', 'kwant.linalg._mumps')]
543

544 545
    init_cython()

546
    global build_summary
547
    build_summary = []
548
    exts = configure_extensions(exts, aliases, build_summary)
549
    exts = configure_special_extensions(exts, build_summary)
550
    exts = maybe_add_numpy_include(exts)
551 552
    exts = maybe_cythonize(exts)

553 554 555 556 557 558 559 560 561 562 563 564
    classifiers = """\
        Development Status :: 5 - Production/Stable
        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"""

565
    packages = find_packages('.')
Christoph Groth's avatar
Christoph Groth committed
566
    setup(name='kwant',
567
          version=version,
568 569
          author='C. W. Groth (CEA), M. Wimmer, '
                 'A. R. Akhmerov, X. Waintal (CEA), and others',
570
          author_email='authors@kwant-project.org',
571
          description=("Package for numerical quantum transport calculations "
572
                       "(Python 3 version)"),
573 574
          long_description=long_description(),
          platforms=["Unix", "Linux", "Mac OS-X", "Windows"],
575 576
          url="http://kwant-project.org/",
          license="BSD",
577 578
          packages=packages,
          package_data={p: ['*.pxd', '*.h'] for p in packages},
579 580 581
          cmdclass={'build': build,
                    'sdist': sdist,
                    'build_ext': build_ext,
582
                    'test': test},
583
          ext_modules=exts,
584
          install_requires=['numpy >= 1.13.3', 'scipy >= 0.19.1',
585
                            'tinyarray >= 1.2'],
586
          extras_require={
587
              # The oldest versions between: Debian stable, Ubuntu LTS
588 589
              'plotting': ['matplotlib >= 2.1.1',
                           'plotly >= 2.2.2'],
590
              'continuum': 'sympy >= 1.1.1',
591
              # qsymm is only packaged on PyPI
592
              'qsymm': 'qsymm >= 1.2.6',
593
          },
594
          classifiers=[c.strip() for c in classifiers.split('\n')])
595

Christoph Groth's avatar
Christoph Groth committed
596 597
if __name__ == '__main__':
    main()