Qiskit / qiskit-slc / 39769118272

96%

push

github

feat: support Windows with a Rust Davidson eigensolver (#101)

* build: add a Rust Davidson eigensolver built with maturin

* feat: compute the extremal eigenvalue with the Rust backend

* ci: build the Rust extension on all runners and test on windows-latest

* docs: announce Windows support and the Rust backend

* refactor: some opinionated source restructuring

This change is to follow other Qiskit addon source layout patterns more
closely.

* ci: bulid package before attempting to run tests

* ci: fix package build location in workflows

* ci: update release workflow

* refactor: make kwargs explicit

* fix: module name in stub-file docstring

* fix: converge the Davidson solver on a residual and value criterion

* fix: use a fixed-seed initial guess for reproducible bounds

* test: regenerate forward-bound fixtures for the fixed solver

* fix: gate Davidson convergence on the operator scale

* build: move the package source under python/

With the package at the repository root, anything that put the root on
`sys.path` imported the source tree, which has no compiled `_accelerate`
extension, instead of the installed wheel: pytest (via the `tests` package),
Sphinx's autodoc (via `docs/conf.py`) and cibuildwheel's test run. CI papered
over this by compiling the extension a second time into the tree with
`pip install -e .` before every tox run.

Under `python/` (maturin `python-source = "python"`, as in qiskit-fermions and
pauli-prop) the tests, notebooks and docs import the wheel tox installs, so the
in-place build steps are gone from the workflows, `docs/conf.py` no longer
edits `sys.path`, and cibuildwheel no longer needs `--import-mode=importlib`.

The doctests are the exception: pytest imports the modules it collects them
from by path, so they always run against the source tree. The `doctest` and
`coverage` tox environments therefore use `package = editable`, which builds
the extension into that tree once, inside tox. Coverage needs this anyway,... (continued)

61 of 61 new or added lines in 1 file covered. (100.0%)

1308 of 1364 relevant lines covered (95.89%)

0.96 hits per line