Convert ASV files for use on Terra

The configuration is rewritten because several components of it needed
to changes as it came other, and it was mostly autogenerated or
out-of-date anyway.

We may want to tweak how requirements are managed and installed in the
future.

Black is applied to the test files, and various tweaks needed to satisfy
Terra's lint requirements.

Author: jakelishman

.gitignore

@@ -98,6 +98,7 @@ celerybeat-schedule
 .env
 
 # virtualenv
+.asv/
 .venv
 venv/
 ENV/

asv.conf.json

@@ -1,172 +1,25 @@
 {
-    // The version of the config file format.  Do not change, unless
-    // you know what you are doing.
     "version": 1,
-
-    // The name of the project being benchmarked
-    "project": "qiskit-terra",
-
-    // The project's homepage
+    "project": "qiskit",
     "project_url": "https://qiskit.org",
-
-    // The URL or local path of the source code repository for the
-    // project being benchmarked
-    "repo": "https://github.com/Qiskit/qiskit-terra.git",
-
-    // The Python project's subdirectory in your repo.  If missing or
-    // the empty string, the project is assumed to be located at the root
-    // of the repository.
-    // "repo_subdir": "",
-
-    // Customizable commands for building, installing, and
-    // uninstalling the project. See asv.conf.json documentation.
-    //
+    "repo": ".",
     "install_command": [
-        "return-code=any python -c \"import shutil; shutil.rmtree('{build_dir}/build')\"",
-        "return-code=any python -c \"import shutil; shutil.rmtree('{build_dir}/qiskit_terra.egg-info')\"",
-        "python -mpip install seaborn",
-        "python -mpip install pygments",
-        "python -mpip install {wheel_file}",
-        "python -mpip install -U qiskit-experiments==0.3.0",
-        "python -mpip install -U python-constraint"
+        "in-dir={env_dir} python -mpip install {wheel_file}[all] python-constraint qiskit-experiments==0.3.0"
       ],
     "uninstall_command": [
-        "return-code=any python -mpip uninstall -y {project}",
-        "return-code=any python -mpip uninstall -y qiskit-experiments"
+        "return-code=any python -mpip uninstall -y {project}"
     ],
     "build_command": [
-        "pip install -U Cython setuptools-rust",
+        "pip install -U setuptools-rust",
         "python setup.py build_rust --release",
         "PIP_NO_BUILD_ISOLATION=false python -mpip wheel --no-deps --no-index -w {build_cache_dir} {build_dir}"
     ],
-
-    // List of branches to benchmark. If not provided, defaults to "master"
-    // (for git) or "default" (for mercurial).
-    "branches": ["main"], // for git
-    // "branches": ["default"],    // for mercurial
-
-    // The DVCS being used.  If not set, it will be automatically
-    // determined from "repo" by looking at the protocol in the URL
-    // (if remote), or by looking for special directories, such as
-    // ".git" (if local).
+    "branches": ["main"],
     "dvcs": "git",
-
-    // The tool to use to create environments.  May be "conda",
-    // "virtualenv" or other value depending on the plugins in use.
-    // If missing or the empty string, the tool will be automatically
-    // determined by looking for tools on the PATH environment
-    // variable.
     "environment_type": "virtualenv",
-
-    // timeout in seconds for installing any dependencies in environment
-    // defaults to 10 min
-    //"install_timeout": 600,
-
-    // the base URL to show a commit for the project.
     "show_commit_url": "http://github.com/Qiskit/qiskit-terra/commit/",
-
-    // The Pythons you'd like to test against.  If not provided, defaults
-    // to the current version of Python used to run `asv`.
-    "pythons": ["3.7", "3.8", "3.9", "3.10"],
-
-    // The list of conda channel names to be searched for benchmark
-    // dependency packages in the specified order
-    // "conda_channels": ["conda-forge", "defaults"]
-
-    // The matrix of dependencies to test.  Each key is the name of a
-    // package (in PyPI) and the values are version numbers.  An empty
-    // list or empty string indicates to just test against the default
-    // (latest) version. null indicates that the package is to not be
-    // installed. If the package to be tested is only available from
-    // PyPi, and the 'environment_type' is conda, then you can preface
-    // the package name by 'pip+', and the package will be installed via
-    // pip (with all the conda available packages installed first,
-    // followed by the pip installed packages).
-    //
-    // "matrix": {
-    //     "numpy": ["1.6", "1.7"],
-    //     "six": ["", null],        // test with and without six installed
-    //     "pip+emcee": [""],   // emcee is only available for install with pip.
-    // },
-
-    // Combinations of libraries/python versions can be excluded/included
-    // from the set to test. Each entry is a dictionary containing additional
-    // key-value pairs to include/exclude.
-    //
-    // An exclude entry excludes entries where all values match. The
-    // values are regexps that should match the whole string.
-    //
-    // An include entry adds an environment. Only the packages listed
-    // are installed. The 'python' key is required. The exclude rules
-    // do not apply to includes.
-    //
-    // In addition to package names, the following keys are available:
-    //
-    // - python
-    //     Python version, as in the *pythons* variable above.
-    // - environment_type
-    //     Environment type, as above.
-    // - sys_platform
-    //     Platform, as in sys.platform. Possible values for the common
-    //     cases: 'linux2', 'win32', 'cygwin', 'darwin'.
-    //
-    // "exclude": [
-    //     {"python": "3.2", "sys_platform": "win32"}, // skip py3.2 on windows
-    //     {"environment_type": "conda", "six": null}, // don't run without six on conda
-    // ],
-    //
-    // "include": [
-    //     // additional env for python2.7
-    //     {"python": "2.7", "numpy": "1.8"},
-    //     // additional env if run on windows+conda
-    //     {"platform": "win32", "environment_type": "conda", "python": "2.7", "libpython": ""},
-    // ],
-
-    // The directory (relative to the current directory) that benchmarks are
-    // stored in.  If not provided, defaults to "benchmarks"
+    "pythons": ["3.8", "3.9", "3.10", "3.11"],
     "benchmark_dir": "test/benchmarks",
-
-    // The directory (relative to the current directory) to cache the Python
-    // environments in.  If not provided, defaults to "env"
     "env_dir": ".asv/env",
-
-    // The directory (relative to the current directory) that raw benchmark
-    // results are stored in.  If not provided, defaults to "results".
-    "results_dir": ".asv/results",
-
-    // The directory (relative to the current directory) that the html tree
-    // should be written to.  If not provided, defaults to "html".
-    // "html_dir": "html",
-
-    // The number of characters to retain in the commit hashes.
-    // "hash_length": 8,
-
-    // `asv` will cache results of the recent builds in each
-    // environment, making them faster to install next time.  This is
-    // the number of builds to keep, per environment.
-    // "build_cache_size": 2,
-
-    // The commits after which the regression search in `asv publish`
-    // should start looking for regressions. Dictionary whose keys are
-    // regexps matching to benchmark names, and values corresponding to
-    // the commit (exclusive) after which to start looking for
-    // regressions.  The default is to start from the first commit
-    // with results. If the commit is `null`, regression detection is
-    // skipped for the matching benchmark.
-    //
-    // "regressions_first_commits": {
-    //    "some_benchmark": "352cdf",  // Consider regressions only after this commit
-    //    "another_benchmark": null,   // Skip regression detection altogether
-    // },
-
-    // The thresholds for relative change in results, after which `asv
-    // publish` starts reporting regressions. Dictionary of the same
-    // form as in ``regressions_first_commits``, with values
-    // indicating the thresholds.  If multiple entries match, the
-    // maximum is taken. If no entry matches, the default is 5%.
-    //
-    // "regressions_thresholds": {
-    //    "some_benchmark": 0.01,     // Threshold of 1%
-    //    "another_benchmark": 0.5,   // Threshold of 50%
-    // },
+    "results_dir": ".asv/results"
 }

test/benchmarks/__init__.py

@@ -0,0 +1,11 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2023
+#
+# 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.

test/benchmarks/assembler.py

@@ -1,8 +1,6 @@
-# -*- coding: utf-8 -*-
-
 # This code is part of Qiskit.
 #
-# (C) Copyright IBM 2019.
+# (C) Copyright IBM 2023
 #
 # 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
@@ -22,34 +20,28 @@
 
 
 class AssemblerBenchmarks:
-    params = ([8],
-              [4096],
-              [1, 100])
-    param_names = ['n_qubits', 'depth', 'number of circuits']
+    params = ([8], [4096], [1, 100])
+    param_names = ["n_qubits", "depth", "number of circuits"]
     timeout = 600
     version = 2
 
     def setup(self, n_qubits, depth, number_of_circuits):
         seed = 42
-        self.circuit = random_circuit(n_qubits, depth, measure=True,
-                                      conditional=True, seed=seed)
+        self.circuit = random_circuit(n_qubits, depth, measure=True, conditional=True, seed=seed)
         self.circuits = [self.circuit] * number_of_circuits
 
     def time_assemble_circuit(self, _, __, ___):
         assemble(self.circuits)
 
 
 class DisassemblerBenchmarks:
-    params = ([8],
-              [4096],
-              [1, 100])
-    param_names = ['n_qubits', 'depth', 'number of circuits']
+    params = ([8], [4096], [1, 100])
+    param_names = ["n_qubits", "depth", "number of circuits"]
     timeout = 600
 
     def setup(self, n_qubits, depth, number_of_circuits):
         seed = 424242
-        self.circuit = random_circuit(n_qubits, depth, measure=True,
-                                      conditional=True, seed=seed)
+        self.circuit = random_circuit(n_qubits, depth, measure=True, conditional=True, seed=seed)
         self.circuits = [self.circuit] * number_of_circuits
         self.qobj = assemble(self.circuits)
 

test/benchmarks/circuit_construction.py

@@ -1,8 +1,6 @@
-# -*- coding: utf-8 -*
-
 # This code is part of Qiskit.
 #
-# (C) Copyright IBM 2018, 2019.
+# (C) Copyright IBM 2023
 #
 # 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
@@ -28,15 +26,15 @@ def build_circuit(width, gates):
     while len(qc) < gates:
         for k in range(width):
             qc.h(qr[k])
-        for k in range(width-1):
-            qc.cx(qr[k], qr[k+1])
+        for k in range(width - 1):
+            qc.cx(qr[k], qr[k + 1])
 
     return qc
 
 
 class CircuitConstructionBench:
     params = ([1, 2, 5, 8, 14, 20], [8, 128, 2048, 8192, 32768, 131072])
-    param_names = ['width', 'gates']
+    param_names = ["width", "gates"]
     timeout = 600
 
     def setup(self, width, gates):
@@ -54,7 +52,7 @@ def time_circuit_copy(self, _, __):
 
 
 def build_parameterized_circuit(width, gates, param_count):
-    params = [Parameter('param-%s' % x) for x in range(param_count)]
+    params = [Parameter("param-%s" % x) for x in range(param_count)]
     param_iter = itertools.cycle(params)
 
     qr = QuantumRegister(width)
@@ -64,17 +62,16 @@ def build_parameterized_circuit(width, gates, param_count):
         for k in range(width):
             param = next(param_iter)
             qc.u2(0, param, qr[k])
-        for k in range(width-1):
+        for k in range(width - 1):
             param = next(param_iter)
-            qc.crx(param, qr[k], qr[k+1])
+            qc.crx(param, qr[k], qr[k + 1])
 
     return qc, params
 
 
 class ParameterizedCircuitConstructionBench:
-    params = ([20], [8, 128, 2048, 8192, 32768, 131072],
-              [8, 128, 2048, 8192, 32768, 131072])
-    param_names = ['width', 'gates', 'number of params']
+    params = ([20], [8, 128, 2048, 8192, 32768, 131072], [8, 128, 2048, 8192, 32768, 131072])
+    param_names = ["width", "gates", "number of params"]
     timeout = 600
 
     def setup(self, _, gates, params):
@@ -86,17 +83,14 @@ def time_build_parameterized_circuit(self, width, gates, params):
 
 
 class ParameterizedCircuitBindBench:
-    params = ([20], [8, 128, 2048, 8192, 32768, 131072],
-              [8, 128, 2048, 8192, 32768, 131072])
-    param_names = ['width', 'gates', 'number of params']
+    params = ([20], [8, 128, 2048, 8192, 32768, 131072], [8, 128, 2048, 8192, 32768, 131072])
+    param_names = ["width", "gates", "number of params"]
     timeout = 600
 
     def setup(self, width, gates, params):
         if params > gates:
             raise NotImplementedError
-        self.circuit, self.params = build_parameterized_circuit(width,
-                                                                gates,
-                                                                params)
+        self.circuit, self.params = build_parameterized_circuit(width, gates, params)
 
     def time_bind_params(self, _, __, ___):
         self.circuit.bind_parameters({x: 3.14 for x in self.params})

test/benchmarks/converters.py

@@ -1,8 +1,6 @@
-# -*- coding: utf-8 -*-
-
 # This code is part of Qiskit.
 #
-# (C) Copyright IBM 2019.
+# (C) Copyright IBM 2023
 #
 # 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
@@ -23,7 +21,7 @@
 
 class ConverterBenchmarks:
     params = ([1, 2, 5, 8, 14, 20, 32, 53], [8, 128, 2048, 8192])
-    param_names = ['n_qubits', 'depth']
+    param_names = ["n_qubits", "depth"]
     timeout = 600
 
     def setup(self, n_qubits, depth):
@@ -38,8 +36,7 @@ def setup(self, n_qubits, depth):
         elif n_qubits == 14:
             if depth > 2048:
                 raise NotImplementedError
-        self.qc = random_circuit(n_qubits, depth, measure=True,
-                                 conditional=True, seed=seed)
+        self.qc = random_circuit(n_qubits, depth, measure=True, conditional=True, seed=seed)
         self.dag = converters.circuit_to_dag(self.qc)
         self.qasm = qasm.Qasm(data=self.qc.qasm()).parse()
 

test/benchmarks/import.py

@@ -1,8 +1,6 @@
-# -*- coding: utf-8 -*-
-
 # This code is part of Qiskit.
 #
-# (C) Copyright IBM 2019.
+# (C) Copyright IBM 2023
 #
 # 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
@@ -23,4 +21,4 @@
 
 class QiskitImport:
     def time_qiskit_import(self):
-        call((executable, '-c', 'import qiskit'))
+        call((executable, "-c", "import qiskit"))