Qiskit / qiskit-fermions / 29343908179
98%

DEFAULT BRANCH: main
Ran
Jobs 1
Files 80
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 97.785%. Remained the same
29343908179

push

github

web-flow 
docs: refresh developer docs and drop a stale Makefile export (#179)

* docs: add CLAUDE.md contributor guide

Add a CLAUDE.md guide for working in this repository, covering the
bare-repo/worktree layout, the three-layer crate architecture and its
FFI backends, the Makefile-based build & test workflow (including the
QISKIT_LIB/QISKIT_INCLUDE requirements per backend), where docs and
docstrings live, the testing structure, the transpiler synthesis
plugins, the versioning scheme, and the project conventions.

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>

* docs: correct FFI backend model in crate READMEs

Commit 61f00af ("Leverage qiskit-pyo3-ffi") removed the `python_binding`
feature from `qiskit-sys` and reworked how the Qiskit FFI backend is
selected. Update the crate READMEs to match:

- crates/README.md: document that the backend is feature-gated on
  `qiskit-fermions-core` — the `cext` feature pulls in `qiskit-sys`, the
  `pyext` feature pulls in `qiskit-pyo3-ffi`, both are optional, and the
  two are mutually exclusive (guarded by a `compile_error!`). Drop the
  stale `python_binding` references from the `pyext`/`cext` sections.
- crates/qiskit-sys/README.md: remove the now-inaccurate claim that the
  vendored code was modified "to get the Python interface working" — the
  Python interface now goes through `qiskit-pyo3-ffi`, and `qiskit-sys`
  is the C-extension backend.

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>

* docs: document QISKIT_LIB/QISKIT_INCLUDE requirements per FFI backend

The C API and Rust-core builds (`make cext`, `make testc`, `make
testrust`) link `qiskit-sys` against the compiled Qiskit C library and
therefore require `QISKIT_LIB`/`QISKIT_INCLUDE` to point at it. The
Makefile's automatic fallback (deriving these from the installed
`qiskit` package) is only appropriate for the Python extension, which
links Qiskit through `qiskit-pyo3-ffi` instead — using it for the C
build would incorrectly link against ... (continued)

7682 of 7856 relevant lines covered (97.79%)

161.79 hits per line

Jobs
ID Job ID Ran Files Coverage
1 29343908179.1 80
97.79
 GitHub Action Run
Source Files on build 29343908179