Python Installation Instructions¶

Warning

Windows is not yet fully supported by the Python API of qiskit-fermions. We are actively working on resolving this. Stay tuned for updates!

Requirements¶

You need to have installed Qiskit in the same Python environment as the one you intend to install qiskit-fermions in. The simplest way of doing so is from PyPI, but you are free to install Qiskit from source if you wish to.

$ pip install qiskit

Steps¶

Assuming that you have already installed Qiskit into your Python environment (see here), the remaining installation process is fairly simple:

Ensure that you are in the right directory:
```
$ cd path/to/qiskit-fermions
```
Install the Python installation tooling:
```
$ pip install --group build
```
Install the qiskit-fermions Python package into your environment with --no-build-isolation to ensure that qiskit is available correctly:
```
$ pip install --no-build-isolation .
```
Hint

You can also perform an editable install while still compiling the underlying Rust crate in release mode like so:
```
$ SETUPTOOLS_RUST_CARGO_PROFILE=release pip install --no-build-isolation -e .
```

(optional) Verify the installation by running the Python unittests:
```
$ pip install --group test
$ make testpython
```