Warning
This package is under active development! If you have feedback, please open an issue.
This package extends Qiskit with tools for working on fermionic systems. It follows a similar design philosophy as Qiskit itself:
- the core functionality is written in Rust
- first-party language bindings are provided for both, Python and C
- the APIs are designed to "feel" similar to Qiskit
The scope of this package includes the following functionality:
- several operator data structures
- a framework to develop operator conversion methods
- a library of common operator converters
- a framework to develop quantum circuit synthesis methods
- a library of common quantum circuit synthesizers
All documentation is available at https://qiskit.github.io/qiskit-fermions/.
First, follow the installation setup instructions. Then, you can follow the language specific installation steps linked below:
Please refer to the C installation instructions.
Please refer to the Python installation instructions.
Important
This policy does not apply yet. Until the first release is tagged, qiskit-fermions is in
early development: main is unstable, breaking changes may happen at any time without notice, and
release notes are not being tracked. The policy below takes effect with the first tagged release.
We follow semantic versioning and are guided by the principles in Qiskit's deprecation policy. We may occasionally make breaking changes in order to improve the user experience. When possible, we will keep old interfaces and mark them as deprecated, as long as they can co-exist with the new ones. Each substantial improvement, breaking change, or deprecation will be documented in the release notes.
If you use this package in your research, use the CITATION.bib file in this project’s repository to cite the appropriate reference(s).
The source code is available on GitHub.
The developer guide is located at CONTRIBUTING.md in the root of this project's repository. By participating, you are expected to uphold Qiskit's code of conduct.
We use GitHub issues for tracking requests and bugs.