Merge pull request #59 from Langhaarzombie/feature/buildkite-python

Add miniconda setup and python specific configurations, and update the qutip benchmark collection paths.

Author: hodgestar

.buildkite/benchmark.yml

@@ -22,8 +22,14 @@ steps:
 
   - label: "Run QuTiP benchmarks"
     command: |
-      apt-get update -y
-      apt-get install -y python3-pip
+      mkdir -p ~/miniconda3
+      wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh -O ~/miniconda3/miniconda.sh
+      bash ~/miniconda3/miniconda.sh -b -u -p ~/miniconda3
+      source ~/miniconda3/bin/activate
+      conda init --all
+
+      conda create -y -n qutip-benchmark python
+      conda activate qutip-benchmark
 
       python3 --version
       pip3 --version
@@ -32,7 +38,7 @@ steps:
 
       python3 -m benchmark.qutip.runbenchmark -v -s
     artifact_paths:
-      - "benchmark/results/*"
+      - "benchmark/results/qutip/*"
     agents:
       queue: "juliagpu"
       cuda: "*"

benchmark/qutip/runbenchmark.py

@@ -1,23 +1,35 @@
 import sys
+import argparse
 import pytest
 
-def run_benchmarks():
+def run_benchmarks(args):
+    """Run pytest benchmarks with defaults and optional additional args."""
+
     return pytest.main(
         [
             "benchmark/qutip/scripts",
             "--benchmark-only",
             "--benchmark-columns=Mean,StdDev,rounds,Iterations",
             "--benchmark-sort=name",
             "--benchmark-autosave",
-            "--benchmark-storage=./benchmark/results/"
+            "--benchmark-storage=./benchmark/results/qutip/",
+            "--durations=0",
+            "--durations-min=1.0",
+            "-Wdefault",
         ]
+        + args
     )
 
-
 def main():
-    exit_code = run_benchmarks()
-    return exit_code
-
+    pars = argparse.ArgumentParser(
+        description="""
+            Run the benchmarks for QuTiP. The script also accepts the same
+            arguments as pytest/pytest-benchmark. Run the script from the
+            root directory of the repository.
+        """
+    )
+    _, other_args = pars.parse_known_args()
+    return run_benchmarks(other_args)
 
 if __name__ == "__main__":
     sys.exit(main())

benchmark/qutip/scripts/conftest.py

@@ -0,0 +1,19 @@
+from importlib.metadata import version, PackageNotFoundError
+
+def pkg_version(package):
+    try:
+        return version(package)
+    except PackageNotFoundError:
+        return None
+
+def pytest_benchmark_update_json(config, benchmarks, output_json):
+    """Adds the version of selected packages to the benchmarks' output JSON."""
+
+    output_json["package_versions"] = {}
+    output_json["package_versions"]["scipy"] = pkg_version("scipy")
+    output_json["package_versions"]["numpy"] = pkg_version("numpy")
+    output_json["package_versions"]["cython"] = pkg_version("cython")
+    output_json["package_versions"]["qutip"] = pkg_version("qutip")
+    output_json["package_versions"]["qutip-jax"] = pkg_version("qutip-jax")
+    output_json["package_versions"]["jax"] = pkg_version("jax")
+    output_json["package_versions"]["pytest"] = pkg_version("pytest")