qiskit/setup.py

120 lines
4.1 KiB
Python
Raw Normal View History

Revise travis configuration, using cmake * Revise the travis configuration for using `cmake` for the several targets, and use "stages" instead of parallel jobs: * define three stages that are executed if the previous one suceeds: 1. "linter and pure python test": executes the linter and a test without compiling the binaries, with the idea of providing quick feedback for PRs. 2. "test": launch the test, including the compilation of binaries, under GNU/Linux Python 3.6 and 3.6; and osx Python 3.6. 3. "deploy doc and pypi": for the stable branch, deploy the docs to the landing page, and when using a specific commit message, build the GNU/Linux and osx wheels, uploading them to test.pypi. * use yaml anchors and definitions to avoid repeating code (and working around travis limitations). * Modify the `cmake``configuration to accomodate the stages flow: * allow conditional creation of compilation and QA targets, mainly for saving some time in some jobs. * move the tests to `cmake/tests.cmake`. * Update the tests: * add a `requires_qe_access` decorator that retrieves QE_TOKEN and QE_URL and appends them to the parameters in an unified manner. * add an environment variable `SKIP_ONLINE_TESTS` that allows to skip the tests that need network access. * replace `TRAVIS_FORK_PULL_REQUEST` with the previous two mechanisms, adding support for AppVeyor as well. * fix a problem with matplotlib under osx headless, effectively skipping `test_visualization.py` during the travis osx jobs. * Move Sphinx to `requirements-dev.txt`.
2018-02-13 05:11:28 +08:00
# -*- coding: utf-8 -*-
# This code is part of Qiskit.
Revise travis configuration, using cmake * Revise the travis configuration for using `cmake` for the several targets, and use "stages" instead of parallel jobs: * define three stages that are executed if the previous one suceeds: 1. "linter and pure python test": executes the linter and a test without compiling the binaries, with the idea of providing quick feedback for PRs. 2. "test": launch the test, including the compilation of binaries, under GNU/Linux Python 3.6 and 3.6; and osx Python 3.6. 3. "deploy doc and pypi": for the stable branch, deploy the docs to the landing page, and when using a specific commit message, build the GNU/Linux and osx wheels, uploading them to test.pypi. * use yaml anchors and definitions to avoid repeating code (and working around travis limitations). * Modify the `cmake``configuration to accomodate the stages flow: * allow conditional creation of compilation and QA targets, mainly for saving some time in some jobs. * move the tests to `cmake/tests.cmake`. * Update the tests: * add a `requires_qe_access` decorator that retrieves QE_TOKEN and QE_URL and appends them to the parameters in an unified manner. * add an environment variable `SKIP_ONLINE_TESTS` that allows to skip the tests that need network access. * replace `TRAVIS_FORK_PULL_REQUEST` with the previous two mechanisms, adding support for AppVeyor as well. * fix a problem with matplotlib under osx headless, effectively skipping `test_visualization.py` during the travis osx jobs. * Move Sphinx to `requirements-dev.txt`.
2018-02-13 05:11:28 +08:00
#
# (C) Copyright IBM 2017.
#
# This code is licensed under the Apache License, Version 2.0. You may
# obtain a copy of this license in the LICENSE.txt file in the root directory
# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
#
# Any modifications or derivative works of this code must retain this
# copyright notice, and modified files need to carry a notice indicating
# that they have been altered from the originals.
Revise travis configuration, using cmake * Revise the travis configuration for using `cmake` for the several targets, and use "stages" instead of parallel jobs: * define three stages that are executed if the previous one suceeds: 1. "linter and pure python test": executes the linter and a test without compiling the binaries, with the idea of providing quick feedback for PRs. 2. "test": launch the test, including the compilation of binaries, under GNU/Linux Python 3.6 and 3.6; and osx Python 3.6. 3. "deploy doc and pypi": for the stable branch, deploy the docs to the landing page, and when using a specific commit message, build the GNU/Linux and osx wheels, uploading them to test.pypi. * use yaml anchors and definitions to avoid repeating code (and working around travis limitations). * Modify the `cmake``configuration to accomodate the stages flow: * allow conditional creation of compilation and QA targets, mainly for saving some time in some jobs. * move the tests to `cmake/tests.cmake`. * Update the tests: * add a `requires_qe_access` decorator that retrieves QE_TOKEN and QE_URL and appends them to the parameters in an unified manner. * add an environment variable `SKIP_ONLINE_TESTS` that allows to skip the tests that need network access. * replace `TRAVIS_FORK_PULL_REQUEST` with the previous two mechanisms, adding support for AppVeyor as well. * fix a problem with matplotlib under osx headless, effectively skipping `test_visualization.py` during the travis osx jobs. * Move Sphinx to `requirements-dev.txt`.
2018-02-13 05:11:28 +08:00
"The Qiskit Terra setup file."
import os
import sys
from setuptools import setup, find_packages, Extension
try:
from Cython.Build import cythonize
except ImportError:
import subprocess
subprocess.call([sys.executable, '-m', 'pip', 'install', 'Cython>=0.27.1'])
from Cython.Build import cythonize
REQUIREMENTS = [
"jsonschema>=2.6",
"marshmallow>=3,<4",
"marshmallow_polyfield>=5.7,<6",
"networkx>=2.2;python_version>'3.5'",
# Networkx 2.4 is the final version with python 3.5 support.
"networkx>=2.2,<2.4;python_version=='3.5'",
"numpy>=1.13",
2018-06-13 22:21:15 +08:00
"ply>=3.10",
"psutil>=5",
"scipy>=1.0",
"sympy>=1.3",
"dill>=0.3",
]
# Add Cython extensions here
CYTHON_EXTS = ['utils', 'swap_trial']
CYTHON_MODULE = 'qiskit.transpiler.passes.routing.cython.stochastic_swap'
CYTHON_SOURCE_DIR = 'qiskit/transpiler/passes/routing/cython/stochastic_swap'
INCLUDE_DIRS = []
# Extra link args
LINK_FLAGS = []
# If on Win and not in MSYS2 (i.e. Visual studio compile)
if (sys.platform == 'win32' and os.environ.get('MSYSTEM') is None):
2019-02-24 21:07:16 +08:00
COMPILER_FLAGS = ['/O2']
# Everything else
else:
COMPILER_FLAGS = ['-O2', '-funroll-loops', '-std=c++11']
if sys.platform == 'darwin':
# These are needed for compiling on OSX 10.14+
COMPILER_FLAGS.append('-mmacosx-version-min=10.9')
LINK_FLAGS.append('-mmacosx-version-min=10.9')
EXT_MODULES = []
# Add Cython Extensions
for ext in CYTHON_EXTS:
mod = Extension(CYTHON_MODULE + '.' + ext,
sources=[CYTHON_SOURCE_DIR + '/' + ext + '.pyx'],
include_dirs=INCLUDE_DIRS,
extra_compile_args=COMPILER_FLAGS,
extra_link_args=LINK_FLAGS,
language='c++')
EXT_MODULES.append(mod)
setup(
name="qiskit-terra",
version="0.12.0",
description="Software for developing quantum computing programs",
long_description="""Terra provides the foundations for Qiskit. It allows the user to write
quantum circuits easily, and takes care of the constraints of real hardware.""",
url="https://github.com/Qiskit/qiskit-terra",
author="Qiskit Development Team",
author_email="qiskit@qiskit.org",
license="Apache 2.0",
classifiers=[
"Environment :: Console",
"License :: OSI Approved :: Apache Software License",
"Intended Audience :: Developers",
"Intended Audience :: Science/Research",
"Operating System :: Microsoft :: Windows",
"Operating System :: MacOS",
"Operating System :: POSIX :: Linux",
Add python 3.8 support and deprecate python 3.5 (#3268) * Add python 3.8 support and deprecate python 3.5 This commit adds support for running terra under python 3.8. It does this by adding the trove classifiers to the package metadata and adding a test job for python 3.8 (only travis for now this can be expanded in the future when azure pipelines adds it to their image). At the same time this commit starts the deprecation window for python 3.5. Python 3.5 goes end of life by upstream python in Sept. 2020. We should give our users running with python 3.5 (which is about 10% of our users based on pypi data) fair notice that when upstream python stops supporting it we do as well. * Fix lint * Add back empty cache detection As part of the refactors the empty stestr timing cache removal code was removed from the travis config, but the cache wasn't removed. Adding the python 3.8 job causes a failure because travis has no cached timing data but still creates the empty directory which triggers mtreinish/stestr#266. This adds back the empty cache removal to workaround it so we can use the timing data for scheduling in future runs. * Add azure-pipelines python 3.8 jobs too * Fix python 3.8 dictionary keys changed error Starting in python 3.8 a new RuntimeError is raised, RuntimeError: dictionary keys changed during iteration. This is caused by modifying an iterator while looping over it. We were doing that in the optimize_swap_before_measure pass. This commit fixes this by wrapping the iterator in list() to make a copy of it for looping. This way we don't modify the contents of what we're iterating over in the pass. * Revert "Add azure-pipelines python 3.8 jobs too" The missing matplotlib wheels are blockers for windows and osx environment. Since we do not have the necessary dependencies installed in those ci envs to compile matplotlib from source. We'll rely on just travis for 3.8 testing until the matplotlib 3.2.0 release is pushed so we don't have to compile it. This reverts commit 40157621b135a03b291b93e5d9b801237a14c015. * Add skip for failing matplotlib test The image comparison tests which are quite flaky are failing with matplotlib compiled on 3.8. Looking at the image output from these failures are very subtle (looks like resolution differences) again questioning the value of these tests. This commit just skips the test that is failing here to unblock the PR. * Add azure 3.8 test jobs * Pin to pre-release mpl for python 3.8 * Add spawn guard for python3.8 osx in examples When running examples with execute, transpile, or any other calls using parallel_map() the new default for spawn instead of fork requires that scripts have a __name__ == "__main__" check in them to function properly. If not calls to parallel_map fail errors around the bootstrapping phase. To avoid this in the ci jobs this commit adds the necessary checks to the example scripts we run in ci as part of test_examples. * Remove cryptography pin from constraints file We pinned the cryptography package version back during the cryptography 2.6 release which broke our ci. It was a temporary step to avoid a packaging issue in CI that was blocking development. However, when the issue was resolved we never circled back to fix the issue. Now trying to enable python 3.8 support to terra cryptography >=2.8 is needed for python 3.8 on windows (to get a precompiled binary). This commit removes the unecessary pin to unblock windows 3.8 ci. * Bump cibuildwheel version to build 3.8 wheels cibuildwheel 1.0.0 was released in early November [1] and added support for building python 3.8 wheels. This commit bumps the cibuildwheel version we use in the wheel build jobs at release time to also build 3.8 wheels for upload to pypi. * Add skip and release note about macos py38 issues This commit adds a skip for the failing python 3.8 test on osx and windows so that we don't block everything over a small issue in the tests. It also add a release note documenting the limitation with python 3.8 on macos with regardess to parallel_map/multiprocessing. Since this limitation is new for this release (being the first release with python 3.8 support) we should document it as a known issue in the release notes, especially since it likely won't be resolved until a python 3.8.1 release. * Revert "Add spawn guard for python3.8 osx in examples" While we can fix the tests to work on osx python3.8 by adjusting the example scripts to only call functions using parallel_map from inside a block run via if __name__ == '__main__': this unecessarily changes the scripts for the quirks of a single environment. This commit reverts the example scripts back to their original form and instead just skips the unittest that executes them on python 3.8 macOS. We already have documented this limitation in the release notes. When/if we have an alternative solution for how we launch additional processes in python 3.8 on macOS that does not require this workaround we can look at removing the skip. This reverts commit 76ae197631247f5b18eb322b1482da9b31d5391b. * Apply suggestions from code review Co-Authored-By: Kevin Krsulich <kevin@krsulich.net>
2019-12-11 04:43:58 +08:00
"Programming Language :: Python :: 3 :: Only",
"Programming Language :: Python :: 3.5",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.7",
Add python 3.8 support and deprecate python 3.5 (#3268) * Add python 3.8 support and deprecate python 3.5 This commit adds support for running terra under python 3.8. It does this by adding the trove classifiers to the package metadata and adding a test job for python 3.8 (only travis for now this can be expanded in the future when azure pipelines adds it to their image). At the same time this commit starts the deprecation window for python 3.5. Python 3.5 goes end of life by upstream python in Sept. 2020. We should give our users running with python 3.5 (which is about 10% of our users based on pypi data) fair notice that when upstream python stops supporting it we do as well. * Fix lint * Add back empty cache detection As part of the refactors the empty stestr timing cache removal code was removed from the travis config, but the cache wasn't removed. Adding the python 3.8 job causes a failure because travis has no cached timing data but still creates the empty directory which triggers mtreinish/stestr#266. This adds back the empty cache removal to workaround it so we can use the timing data for scheduling in future runs. * Add azure-pipelines python 3.8 jobs too * Fix python 3.8 dictionary keys changed error Starting in python 3.8 a new RuntimeError is raised, RuntimeError: dictionary keys changed during iteration. This is caused by modifying an iterator while looping over it. We were doing that in the optimize_swap_before_measure pass. This commit fixes this by wrapping the iterator in list() to make a copy of it for looping. This way we don't modify the contents of what we're iterating over in the pass. * Revert "Add azure-pipelines python 3.8 jobs too" The missing matplotlib wheels are blockers for windows and osx environment. Since we do not have the necessary dependencies installed in those ci envs to compile matplotlib from source. We'll rely on just travis for 3.8 testing until the matplotlib 3.2.0 release is pushed so we don't have to compile it. This reverts commit 40157621b135a03b291b93e5d9b801237a14c015. * Add skip for failing matplotlib test The image comparison tests which are quite flaky are failing with matplotlib compiled on 3.8. Looking at the image output from these failures are very subtle (looks like resolution differences) again questioning the value of these tests. This commit just skips the test that is failing here to unblock the PR. * Add azure 3.8 test jobs * Pin to pre-release mpl for python 3.8 * Add spawn guard for python3.8 osx in examples When running examples with execute, transpile, or any other calls using parallel_map() the new default for spawn instead of fork requires that scripts have a __name__ == "__main__" check in them to function properly. If not calls to parallel_map fail errors around the bootstrapping phase. To avoid this in the ci jobs this commit adds the necessary checks to the example scripts we run in ci as part of test_examples. * Remove cryptography pin from constraints file We pinned the cryptography package version back during the cryptography 2.6 release which broke our ci. It was a temporary step to avoid a packaging issue in CI that was blocking development. However, when the issue was resolved we never circled back to fix the issue. Now trying to enable python 3.8 support to terra cryptography >=2.8 is needed for python 3.8 on windows (to get a precompiled binary). This commit removes the unecessary pin to unblock windows 3.8 ci. * Bump cibuildwheel version to build 3.8 wheels cibuildwheel 1.0.0 was released in early November [1] and added support for building python 3.8 wheels. This commit bumps the cibuildwheel version we use in the wheel build jobs at release time to also build 3.8 wheels for upload to pypi. * Add skip and release note about macos py38 issues This commit adds a skip for the failing python 3.8 test on osx and windows so that we don't block everything over a small issue in the tests. It also add a release note documenting the limitation with python 3.8 on macos with regardess to parallel_map/multiprocessing. Since this limitation is new for this release (being the first release with python 3.8 support) we should document it as a known issue in the release notes, especially since it likely won't be resolved until a python 3.8.1 release. * Revert "Add spawn guard for python3.8 osx in examples" While we can fix the tests to work on osx python3.8 by adjusting the example scripts to only call functions using parallel_map from inside a block run via if __name__ == '__main__': this unecessarily changes the scripts for the quirks of a single environment. This commit reverts the example scripts back to their original form and instead just skips the unittest that executes them on python 3.8 macOS. We already have documented this limitation in the release notes. When/if we have an alternative solution for how we launch additional processes in python 3.8 on macOS that does not require this workaround we can look at removing the skip. This reverts commit 76ae197631247f5b18eb322b1482da9b31d5391b. * Apply suggestions from code review Co-Authored-By: Kevin Krsulich <kevin@krsulich.net>
2019-12-11 04:43:58 +08:00
"Programming Language :: Python :: 3.8",
"Topic :: Scientific/Engineering",
],
keywords="qiskit sdk quantum",
packages=find_packages(exclude=['test*']),
install_requires=REQUIREMENTS,
setup_requires=['Cython>=0.27.1'],
include_package_data=True,
python_requires=">=3.5",
extras_require={
'visualization': ['matplotlib>=2.1', 'ipywidgets>=7.3.0',
'pydot', "pillow>=4.2.1", "pylatexenc>=1.4",
"seaborn>=0.9.0"],
'full-featured-simulators': ['qiskit-aer>=0.1'],
'crosstalk-pass': ['z3-solver>=4.7'],
},
project_urls={
"Bug Tracker": "https://github.com/Qiskit/qiskit-terra/issues",
"Documentation": "https://qiskit.org/documentation/",
"Source Code": "https://github.com/Qiskit/qiskit-terra",
},
ext_modules=cythonize(EXT_MODULES),
zip_safe=False
)