f2q 🎇

Fermion-to-qubit mappings. High-octane representation of Pauli Hamiltonians with up to 64 qubits.

This is a software library and a command line tool to parse and convert quantum chemistry Hamiltonians into a form suitable for quantum hardware based on qubit gates.

How to use it

Make sure you have the Rust compiler installed, in version at least 1.70: 🦀

rustc --version

If not, update Rust:

rustup update

or check out the official Rust website on how to get started.

If you only want to use the accompanying command line tool: f2q, install the executable like this:

cargo install f2q
f2q --help

To include the software library into you Rust project, use the package available on crates.io:

cargo add f2q

The full documentation is available online at docs.rs. 📚

Testing

To run the library's test suite, make sure you have the nightly Rust toolchain installed:

rustup install nightly

Clone the f2q repository to your local system:

git clone https://github.com/Quantum-for-Life/f2q.git
cd f2q

and set nightly Rust as the default toolchain for this repo:

rustup override set nightly

Now, you can run the tests: ⚙️🪛

cargo test

Contributing

All contributions are welcome. 💐

Before submitting patches, please reformat your code as specified in rustfmt.toml by running:

cargo clippy --fix
cargo fmt

or if you have just installed:

just lint