setup.py

"""A python implementation of Gate Set Tomography"""

from warnings import warn
from collections import defaultdict
import os

try:
    from setuptools import setup, find_packages
    from setuptools import Extension
    from setuptools.command.build_ext import build_ext
except ImportError:
    from distutils.core import setup
    from distutils.extension import Extension
    from distutils.command.build_ext import build_ext

# Configure setuptools_scm to build a custom version (for more info,
# see https://stackoverflow.com/a/78657279 and https://setuptools-scm.readthedocs.io/en/latest/extending)
# If on a clean release, it uses no local scheme
# Otherwise, it uses g{commit hash}.{branch}.[CLEAN | d{date}] for the local scheme,
# where the last entry is "CLEAN" if everything is committed and otherwise the date of last commit
def custom_version(version):
    from setuptools_scm.version import get_local_node_and_date

    local_scheme = ""
    if version.dirty or version.distance:
        node_and_date = get_local_node_and_date(version)

        if version.dirty:
            node, date = node_and_date.split('.')
        else:
            node = node_and_date
            date = "CLEAN"
        
        local_scheme = node + f'.{version.branch}.' + date

    return local_scheme

#Create a custom command class that allows us to specify different compiler flags
# based on the compiler (~platform) being used (see
# https://stackoverflow.com/questions/30985862/how-to-identify-compiler-before-defining-cython-extensions)
BUILD_ARGS = defaultdict(lambda: ["-std=c++11"])  # ,"-stdlib=libc++", '-O3', '-g0'
for compiler, args in [
        ('msvc', []),
        ('gcc', ["-std=c++11", "-Wno-deprecated"])]:
    BUILD_ARGS[compiler] = args

class build_ext_compiler_check(build_ext):
    def build_extensions(self):
        compiler = self.compiler.compiler_type
        args = BUILD_ARGS[compiler]
        print("\n\nCompiler: ",compiler,"\n")
        for ext in self.extensions:
            if ext.language == "c++":  # only do this for c++ files, so we can specify -std=c++11, etc.
                ext.extra_compile_args = args
        build_ext.build_extensions(self)

# Check if environment can try to build extensions
try:
    import numpy as np
    from Cython.Build import cythonize

    if "PYGSTI_SKIP_CYTHON" in os.environ:
        warn("PYGSTI_SKIP_CYTHON env variable defined. Installing without Cython extensions...")
        extensions = None
    else:
        ext_modules = [
            Extension(
                "pygsti.tools.fastcalc",
                sources=["pygsti/tools/fastcalc.pyx"],  # , "fastcalc.c
                # # Cython docs on NumPy usage should mention this!
                # define_macros = [('NPY_NO_DEPRECATED_API','NPY_1_7_API_VERSION')],
                # # leave above commented
                # # see http://docs.cython.org/en/latest/src/reference/compilation.html#configuring-the-c-build
                # define_macros = [('CYTHON_TRACE','1')], #for profiling
                include_dirs=['.', np.get_include()]
                # libraries=['m'] #math lib?
            ),
            Extension(
                "pygsti.baseobjs.opcalc.fastopcalc",
                sources=["pygsti/baseobjs/opcalc/fastopcalc.pyx"],
                include_dirs=['.', np.get_include()],
                language="c++",
                extra_link_args=["-std=c++11"]
            ),
            Extension(
                "pygsti.evotypes.basereps_cython",
                sources=[
                    "pygsti/evotypes/basereps_cython.pyx",
                    "pygsti/evotypes/basecreps.cpp"
                ],
                include_dirs=['.', np.get_include()],
                language="c++",
                extra_link_args=["-std=c++11"]
            ),
            Extension(
                "pygsti.evotypes.densitymx.statereps",
                sources=[
                    "pygsti/evotypes/densitymx/statereps.pyx",
                    "pygsti/evotypes/densitymx/statecreps.cpp"
                ],
                include_dirs=['.', 'pygsti/evotypes', np.get_include()],
                language="c++",
                extra_link_args=["-std=c++11"]
            ),
            Extension(
                "pygsti.evotypes.densitymx.opreps",
                sources=[
                    "pygsti/evotypes/densitymx/opreps.pyx",
                    "pygsti/evotypes/densitymx/opcreps.cpp",
                    "pygsti/evotypes/densitymx/statecreps.cpp"
                ],
                include_dirs=['.', 'pygsti/evotypes', np.get_include()],
                language="c++",
                extra_link_args=["-std=c++11"]
            ),
            Extension(
                "pygsti.evotypes.densitymx.effectreps",
                sources=[
                    "pygsti/evotypes/densitymx/effectreps.pyx",
                    "pygsti/evotypes/densitymx/effectcreps.cpp",
                    "pygsti/evotypes/densitymx/statecreps.cpp",
                    "pygsti/evotypes/densitymx/opcreps.cpp"
                ],
                include_dirs=['.', 'pygsti/evotypes', np.get_include()],
                language="c++",
                extra_link_args=["-std=c++11"]
            ),
            Extension(
                "pygsti.evotypes.statevec.statereps",
                sources=[
                    "pygsti/evotypes/statevec/statereps.pyx",
                    "pygsti/evotypes/statevec/statecreps.cpp"
                ],
                include_dirs=['.', 'pygsti/evotypes', np.get_include()],
                language="c++",
                extra_link_args=["-std=c++11"]
            ),
            Extension(
                "pygsti.evotypes.statevec.opreps",
                sources=[
                    "pygsti/evotypes/statevec/opreps.pyx",
                    "pygsti/evotypes/statevec/opcreps.cpp",
                    "pygsti/evotypes/statevec/statecreps.cpp"
                ],
                include_dirs=['.', 'pygsti/evotypes', np.get_include()],
                language="c++",
                extra_link_args=["-std=c++11"]
            ),
            Extension(
                "pygsti.evotypes.statevec.effectreps",
                sources=[
                    "pygsti/evotypes/statevec/effectreps.pyx",
                    "pygsti/evotypes/statevec/effectcreps.cpp",
                    "pygsti/evotypes/statevec/statecreps.cpp",
                    "pygsti/evotypes/statevec/opcreps.cpp"
                ],
                include_dirs=['.', 'pygsti/evotypes', np.get_include()],
                language="c++",
                extra_link_args=["-std=c++11"]
            ),
            Extension(
                "pygsti.evotypes.statevec.termreps",
                sources=[
                    "pygsti/evotypes/statevec/termreps.pyx",
                    "pygsti/evotypes/statevec/termcreps.cpp",
                    "pygsti/evotypes/statevec/statecreps.cpp",
                    "pygsti/evotypes/statevec/opcreps.cpp",
                    "pygsti/evotypes/statevec/effectcreps.cpp"
                ],
                include_dirs=['.', 'pygsti/evotypes', np.get_include()],
                language="c++",
                extra_link_args=["-std=c++11"]
            ),
            Extension(
                "pygsti.evotypes.stabilizer.statereps",
                sources=[
                    "pygsti/evotypes/stabilizer/statereps.pyx",
                    "pygsti/evotypes/stabilizer/statecreps.cpp"
                ],
                include_dirs=['.', 'pygsti/evotypes', np.get_include()],
                language="c++",
                extra_link_args=["-std=c++11"]
            ),
            Extension(
                "pygsti.evotypes.stabilizer.opreps",
                sources=[
                    "pygsti/evotypes/stabilizer/opreps.pyx",
                    "pygsti/evotypes/stabilizer/opcreps.cpp",
                    "pygsti/evotypes/stabilizer/statecreps.cpp"
                ],
                include_dirs=['.', 'pygsti/evotypes', np.get_include()],
                language="c++",
                extra_link_args=["-std=c++11"]
            ),
            Extension(
                "pygsti.evotypes.stabilizer.effectreps",
                sources=[
                    "pygsti/evotypes/stabilizer/effectreps.pyx",
                    "pygsti/evotypes/stabilizer/effectcreps.cpp",
                    "pygsti/evotypes/stabilizer/statecreps.cpp",
                    "pygsti/evotypes/stabilizer/opcreps.cpp"
                ],
                include_dirs=['.', 'pygsti/evotypes', np.get_include()],
                language="c++",
                extra_link_args=["-std=c++11"]
            ),
            Extension(
                "pygsti.evotypes.stabilizer.termreps",
                sources=[
                    "pygsti/evotypes/stabilizer/termreps.pyx",
                    "pygsti/evotypes/stabilizer/termcreps.cpp",
                    "pygsti/evotypes/stabilizer/statecreps.cpp",
                    "pygsti/evotypes/stabilizer/opcreps.cpp",
                    "pygsti/evotypes/stabilizer/effectcreps.cpp"
                ],
                include_dirs=['.', 'pygsti/evotypes', np.get_include()],
                language="c++",
                extra_link_args=["-std=c++11"]
            ),
            Extension(
                "pygsti.forwardsims.mapforwardsim_calc_densitymx",
                sources=[
                    "pygsti/forwardsims/mapforwardsim_calc_densitymx.pyx",
                    "pygsti/evotypes/densitymx/statecreps.cpp",
                ],
                include_dirs=['.', 'pygsti/evotypes', 'pygsti/evotypes/densitymx', np.get_include()],
                language="c++",
                extra_link_args=["-std=c++11"]
            ),
            Extension(
                "pygsti.forwardsims.termforwardsim_calc_statevec",
                sources=[
                    "pygsti/forwardsims/termforwardsim_calc_statevec.pyx",
                    "pygsti/evotypes/statevec/statecreps.cpp",
                    "pygsti/evotypes/basecreps.cpp"
                ],
                include_dirs=['.', 'pygsti/evotypes', 'pygsti/evotypes/statevec', np.get_include()],
                language="c++",
                extra_link_args=["-std=c++11"]
            ),
            Extension(
                "pygsti.forwardsims.termforwardsim_calc_stabilizer",
                sources=[
                    "pygsti/forwardsims/termforwardsim_calc_stabilizer.pyx",
                    "pygsti/evotypes/stabilizer/statecreps.cpp",
                    "pygsti/evotypes/basecreps.cpp"
                ],
                include_dirs=['.', 'pygsti/evotypes', 'pygsti/evotypes/stabilizer', np.get_include()],
                language="c++",
                extra_link_args=["-std=c++11"]
            ),
            Extension(
                "pygsti.circuits.circuitparser.fastcircuitparser",
                sources=["pygsti/circuits/circuitparser/fastcircuitparser.pyx"],
                include_dirs=['.', np.get_include()],
                language="c++",
                extra_link_args=["-std=c++11"]
            )
        ]
        extensions = cythonize(ext_modules, compiler_directives={'language_level': "3"}, exclude_failures="PYGSTI_CYTHON_EXCLUDE_FAILURES" in os.environ)
except ImportError:
    warn("Extensions build tools are not available. Installing without Cython extensions...")
    extensions = None

try:
    setup(
        use_scm_version={'version_scheme': 'no-guess-dev', 'version_file': "pygsti/_version.py", 'local_scheme': custom_version},
        cmdclass={'build_ext': build_ext_compiler_check},
        ext_modules=extensions,
        packages=find_packages(where='.', include=['pygsti']),
        package_data={
            'pygsti.tools': ['fastcalc.pyx'],
            'pygsti.evotypes': [
                'basereps_cython.pxd',
                'basereps_cython.pyx',
                'basecreps.cpp',
                'basecreps.h'],
            'pygsti.evotypes.densitymx': [
                'opreps.pxd',
                'opreps.pyx',
                'opcreps.cpp',
                'opcreps.h',
                'statereps.pxd',
                'statereps.pyx',
                'statecreps.cpp',
                'statecreps.h',
                'effectreps.pxd',
                'effectreps.pyx',
                'effectcreps.cpp',
                'effectcreps.h'
            ],
            'pygsti.evotypes.statevec': [
                'opreps.pxd',
                'opreps.pyx',
                'opcreps.cpp',
                'opcreps.h',
                'statereps.pxd',
                'statereps.pyx',
                'statecreps.cpp',
                'statecreps.h',
                'effectreps.pxd',
                'effectreps.pyx',
                'effectcreps.cpp',
                'effectcreps.h',
                'termreps.pxd',
                'termreps.pyx',
                'termcreps.cpp',
                'termcreps.h',
            ],
            'pygsti.evotypes.stabilizer': [
                'opreps.pxd',
                'opreps.pyx',
                'opcreps.cpp',
                'opcreps.h',
                'statereps.pxd',
                'statereps.pyx',
                'statecreps.cpp',
                'statecreps.h',
                'effectreps.pxd',
                'effectreps.pyx',
                'effectcreps.cpp',
                'effectcreps.h',
                'termreps.pxd',
                'termreps.pyx',
                'termcreps.cpp',
                'termcreps.h',
            ],
            'pygsti.forwardsims': [
                'mapforwardsim_calc_densitymx.pyx',
                'termforwardsim_calc_statevec.pyx',
                'termforwardsim_calc_stabilizer.pyx'
            ],
            'pygsti.baseobjs.opcalc': ['fastopcalc.pyx'],
            'pygsti.circuits.circuitparser': ['fastcircuitparser.pyx'],
            'pygsti.report': [
                'templates/*.tex',
                'templates/*.html',
                'templates/*.json',
                'templates/*.ipynb',
                'templates/report_notebook/*.txt',
                'templates/standard_html_report/*.html',
                'templates/standard_html_report/tabs/*.html',
                'templates/idletomography_html_report/*.html',
                'templates/idletomography_html_report/tabs/*.html',
                'templates/drift_html_report/*.html',
                'templates/drift_html_report/tabs/*.html',
                'templates/offline/README.txt',
                'templates/offline/*.js',
                'templates/offline/*.css',
                'templates/offline/fonts/*',
                'templates/offline/images/*'
            ]
        }
    )
except SystemExit as e:
    print("\nAn error occurred while compiling Cython extensions.")
    print("Either fix the compilation issue or use the PYGSTI_CYTHON_SKIP to skip compilation,",)
    print('e.g. PYGSTI_CYTHON_SKIP=1 pip install pygsti')
    print("To enable partial Cython failures (i.e. the exclude_failures=True flag of cythonize), use PYGSTI_CYTHON_EXCLUDE_FAILURES instead.\n")
    raise e