setup.py 20.8 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 29
from distutils.ccompiler import new_compiler
from distutils.sysconfig import customize_compiler
30

Christoph Groth's avatar
Christoph Groth committed
31

32
STATIC_VERSION_PATH = ('kwant', '_kwant_version.py')
33

34 35 36
distr_root = os.path.dirname(os.path.abspath(__file__))


37 38 39 40 41
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
42 43 44
    the configuration file.

    This function modifies `sys.argv`.
45
    """
46 47 48 49
    global config_file, config_file_present

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

    #### Read build configuration file.
    configs = configparser.ConfigParser()
    try:
69
        with open(config_file) as f:
70 71 72
            configs.read_file(f)
    except IOError:
        config_file_present = False
73 74 75 76
        if config_file_option_present:
            print("Error: '{}' option was provided, but '{}' does not exist"
                  .format(config_file_option, config_file))
            sys.exit(1)
77 78 79 80 81 82 83 84
    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(
85
                    short, long, config_file))
86
                sys.exit(1)
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
            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:
113
                    build_summary.append(msg.format(config_file, name, key))
114 115
            kwargs[key] = value

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

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

    return exts


129 130 131 132 133 134 135 136 137 138
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)


139
def check_versions():
140 141 142 143
    global version, version_is_from_git

    # Let Kwant itself determine its own version.  We cannot simply import
    # kwant, as it is not built yet.
144 145 146
    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)
147

148 149 150
    version_module.ensure_python()
    version = version_module.version
    version_is_from_git = version_module.version_is_from_git
151 152 153


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

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

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

195
            if cython_version < required_cython_version:
196 197
                cythonize = None

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

207

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

Christoph Groth's avatar
Christoph Groth committed
212

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

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

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

246

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

252 253

def git_lsfiles():
254
    if not version_is_from_git:
255 256
        return

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

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


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

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

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

Christoph Groth's avatar
Christoph Groth committed
304
        super().run()
305 306

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

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

Christoph Groth's avatar
Christoph Groth committed
316

Christoph Groth's avatar
Christoph Groth committed
317 318
# The following class is based on a recipe in
# http://doc.pytest.org/en/latest/goodpractices.html#manual-integration.
319
class test(test_orig):
Christoph Groth's avatar
Christoph Groth committed
320 321 322 323 324 325 326 327
    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
328
        try:
Christoph Groth's avatar
Christoph Groth committed
329 330 331
            import pytest
        except:
            print('The Python package "pytest" is required to run tests.',
332
                  file=sys.stderr)
333
            sys.exit(1)
Christoph Groth's avatar
Christoph Groth committed
334 335
        errno = pytest.main(shlex.split(self.pytest_args))
        sys.exit(errno)
336 337


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


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


365
def search_libs(libs):
366 367 368 369 370
    # This gives us a compiler with the same flags as will be used to
    # compile the extensions.
    cc = new_compiler("c")
    customize_compiler(cc)
    cmd = cc.linker_so
371 372
    cmd.extend(['-l' + lib for lib in libs])
    cmd.extend(['-o/dev/null', '-xc', '-'])
Christoph Groth's avatar
Christoph Groth committed
373
    try:
374
        p = subprocess.Popen(cmd, stdin=subprocess.PIPE, stderr=subprocess.PIPE)
Christoph Groth's avatar
Christoph Groth committed
375 376 377
    except OSError:
        pass
    else:
378
        p.communicate(input=b'int main() {}\n')
379
        if p.wait() == 0:
380 381 382 383 384 385 386 387 388 389
            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
390 391
        ['zmumps_scotch', 'mumps_common_scotch', 'mpiseq_scotch',
         'pord', 'gfortran'],
392
        # Conda (via conda-forge).
393
        ['zmumps_seq', 'mumps_common_seq'],
394 395
    ]
    for libs in lib_sets:
396
        found_libs = search_libs(libs)
397 398 399 400 401
        if found_libs:
            return found_libs
    return []


402 403 404 405
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
406 407
        build_summary.append('User-configured MUMPS')
    else:
408 409 410
        mumps_libs = search_mumps()
        if mumps_libs:
            mumps['libraries'] = mumps_libs
411
            build_summary.append('Auto-configured MUMPS')
412 413
        else:
            mumps = None
414
            del exts['kwant.linalg._mumps']
415
            build_summary.append('No MUMPS support')
Christoph Groth's avatar
Christoph Groth committed
416

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

419 420

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

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

    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.
429
    """
430
    if cythonize:
431 432 433
        return cythonize([Extension(name, **kwargs)
                          for name, kwargs in exts.items()],
                         language_level=3,
434
                         compiler_directives={'linetrace': True})
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 = []
441 442
    for name, kwargs in exts.items():
        language = kwargs.get('language')
443 444 445 446 447 448 449 450
        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)
451
            sys.exit(1)
452 453 454

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

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

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

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

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

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

505

506 507 508 509 510 511 512 513 514 515 516 517 518 519
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


520 521 522 523 524 525 526 527 528 529
def add_sys_includes_and_libs(exts):
    # If the shell has not been set up correctly then the include and library paths
    # are not necessarily set correctly, which will cause problems when compiling
    # the Mumps extension (cannot find include files or libs)
    for ext in exts.values():
        ext.setdefault('include_dirs', []).append(os.path.join(sys.prefix, 'include'))
        ext.setdefault('library_dirs', []).append(os.path.join(sys.prefix, 'lib'))
    return exts


Christoph Groth's avatar
Christoph Groth committed
530
def main():
531
    check_python_version((3, 6))
532 533
    check_versions()

534 535 536 537 538 539 540 541 542 543 544
    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'])),
545 546
        ('kwant.graph.dijkstra',
         dict(sources=['kwant/graph/dijkstra.pyx'])),
547
        ('kwant.linalg.lapack',
548
         dict(sources=['kwant/linalg/lapack.pyx'])),
549 550 551 552
        ('kwant.linalg._mumps',
         dict(sources=['kwant/linalg/_mumps.pyx'],
              depends=['kwant/linalg/cmumps.pxd']))])

553
    aliases = [('mumps', 'kwant.linalg._mumps')]
554

555 556
    init_cython()

557
    global build_summary
558
    build_summary = []
559
    exts = configure_extensions(exts, aliases, build_summary)
560
    exts = configure_special_extensions(exts, build_summary)
561
    exts = maybe_add_numpy_include(exts)
562
    exts = add_sys_includes_and_libs(exts)
563 564
    exts = maybe_cythonize(exts)

565 566 567 568 569 570 571 572 573 574 575 576
    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"""

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

Christoph Groth's avatar
Christoph Groth committed
609 610
if __name__ == '__main__':
    main()