nixpkgs-suyu/pkgs/development/python-modules/qiskit-aqua/default.nix
Drew Risinger c5b6e8a0fd python3Packages.qiskit-aqua: disable slow tests
These tests were timing out, they pass locally but can overrun the timeout threshold depending on system load and speed.

System load shouldn't cause hydra failures, so disabling.
2021-11-24 22:26:07 -05:00

185 lines
5.4 KiB
Nix

{ lib
, pythonOlder
, buildPythonPackage
, fetchFromGitHub
, cvxpy
, dlx
, docplex
, fastdtw
, h5py
, networkx
, numpy
, psutil
, qiskit-ignis
, qiskit-terra
, quandl
, scikit-learn
, yfinance
# Optional inputs
, withTorch ? false
, pytorch
, withPyscf ? false
, pyscf
, withScikitQuant ? false
, scikit-quant ? null
, withCplex ? false
, cplex ? null
# Check Inputs
, ddt
, pytestCheckHook
, pytest-timeout
, qiskit-aer
}:
buildPythonPackage rec {
pname = "qiskit-aqua";
version = "0.9.5";
disabled = pythonOlder "3.6";
# Pypi's tarball doesn't contain tests
src = fetchFromGitHub {
owner = "Qiskit";
repo = "qiskit-aqua";
rev = version;
sha256 = "sha256-7QmRwlbAVAR5KfM7tuObkb6+UgiuIm82iGWBuqfve08=";
};
# Optional packages: pyscf (see below NOTE) & pytorch. Can install via pip/nix if needed.
propagatedBuildInputs = [
cvxpy
docplex
dlx # Python Dancing Links package
fastdtw
h5py
networkx
numpy
psutil
qiskit-terra
qiskit-ignis
quandl
scikit-learn
yfinance
] ++ lib.optionals (withTorch) [ pytorch ]
++ lib.optionals (withPyscf) [ pyscf ]
++ lib.optionals (withScikitQuant) [ scikit-quant ]
++ lib.optionals (withCplex) [ cplex ];
# *** NOTE ***
# We make pyscf optional in this package, due to difficulties packaging it in Nix (test failures, complicated flags, etc).
# See nixpkgs#78772, nixpkgs#83447. You are welcome to try to package it yourself,
# or use the Nix User Repository version (https://github.com/drewrisinger/nur-packages).
# It can also be installed at runtime from the pip wheel.
# We disable appropriate tests below to allow building without pyscf installed
postPatch = ''
# Because this is a legacy/final release, the maintainers restricted the maximum
# versions of all dependencies to the latest current version. That will not
# work with nixpkgs' rolling release/update system.
# Unlock all versions for compatibility
substituteInPlace setup.py --replace "<=" ">="
sed -i 's/\(\w\+-*\w*\).*/\1/' requirements.txt
substituteInPlace requirements.txt --replace "dataclasses" ""
# Add ImportWarning when running qiskit.chemistry (pyscf is a chemistry package) that pyscf is not included
echo -e "\nimport warnings\ntry: import pyscf;\nexcept ImportError:\n " \
"warnings.warn('pyscf is not supported on Nixpkgs so some qiskit features will fail." \
"You must install it yourself via pip or add it to your environment from the Nix User Repository." \
"See https://github.com/NixOS/nixpkgs/pull/83447 for details', ImportWarning)\n" \
>> qiskit/chemistry/__init__.py
# Add ImportWarning when running qiskit.optimization that cplex (optimization package) is not included
echo -e "\nimport warnings\ntry: import cplex;\nexcept ImportError:\n " \
"warnings.warn('cplex is not supported on Nixpkgs so some qiskit features will fail." \
"You must install it yourself via pip or add it to your environment from the Nix User Repository." \
"', ImportWarning)\n" \
>> qiskit/optimization/__init__.py
'';
checkInputs = [
pytestCheckHook
ddt
pytest-timeout
qiskit-aer
];
pythonImportsCheck = [
"qiskit.aqua"
"qiskit.aqua.algorithms"
"qiskit.chemistry"
"qiskit.finance"
"qiskit.ml"
"qiskit.optimization"
];
pytestFlagsArray = [
"--timeout=30" # limit test duration to 30 seconds. Some tests previously would run indefinitely
"--durations=10"
];
disabledTestPaths = lib.optionals (!withPyscf) [
"test/chemistry/test_qeom_ee.py"
"test/chemistry/test_qeom_vqe.py"
"test/chemistry/test_vqe_uccsd_adapt.py"
"test/chemistry/test_bopes_sampler.py"
];
disabledTests = [
# TODO: figure out why failing, only fail with upgrade to qiskit-terra > 0.16.1 & qiskit-aer > 0.7.2
# In test.aqua.test_amplitude_estimation.TestSineIntegral
"test_confidence_intervals_1"
"test_statevector_1"
# fails due to approximation error with latest qiskit-aer?
"test_application"
# Fail on CI for some reason, not locally
"test_binary"
# Online tests
"test_exchangedata"
"test_yahoo"
# Disabling slow tests > 10 seconds
"TestVQE"
"TestOOVQE"
"TestVQC"
"TestQSVM"
"TestOptimizerAQGD"
"test_graph_partition_vqe"
"TestLookupRotation"
"_vqe"
"TestHHL"
"TestQGAN"
"test_evaluate_qasm_mode"
"test_measurement_error_mitigation_auto_refresh"
"test_wikipedia"
"test_shor_factoring_1__15___qasm_simulator____3__5__"
"test_readme_sample"
"test_ecev"
"test_expected_value"
"test_qubo_gas_int_paper_example"
"test_shor_no_factors_1_5"
"test_shor_no_factors_2_7"
"test_evolve_2___suzuki___1__3_"
"test_delta"
"test_swaprz"
"test_deprecated_algo_result"
"test_unsorted_grouping"
"test_ad_hoc_data"
"test_nft"
"test_oh"
"test_confidence_intervals_00001"
"test_eoh"
"test_qasm_5"
"test_uccsd_hf"
"test_lih"
"test_lih_freeze_core"
] ++ lib.optionals (!withPyscf) [
"test_validate" # test/chemistry/test_inputparser.py
];
meta = with lib; {
description = "An extensible library of quantum computing algorithms";
homepage = "https://github.com/QISKit/qiskit-aqua";
changelog = "https://qiskit.org/documentation/release_notes.html";
license = licenses.asl20;
maintainers = with maintainers; [ drewrisinger ];
};
}