Installa la Python API

Prerequisiti

Per prima cosa, crea un ambiente minimale con solo Python installato. Usa gli ambienti virtuali Python.

python3 -m venv /path/to/virtual/environment

Attiva il tuo nuovo ambiente.

source /path/to/virtual/environment/bin/activate

Ci sono due modi principali per installare questo pacchetto: da PyPI o dai sorgenti. Il metodo preferito è installare da PyPI:

Installare da PyPI

pip install qiskit-fermions

Installare dai sorgenti

Se prevedi di sviluppare nel repository, dovresti installare dai sorgenti.

Per prima cosa, Qiskit deve essere installato nello stesso ambiente Python in cui installi qiskit-fermions. Il modo più semplice è da PyPI, ma puoi installare Qiskit dai sorgenti se lo desideri.

$ pip install qiskit

Poi clona il repository qiskit-fermions.

git clone git@github.com:Qiskit/qiskit-fermions.git

Ora installa la toolchain Rust, aggiorna pip ed entra nel repository. Consulta la documentazione di Rust per le istruzioni sull'installazione della toolchain.

### <INSTALL RUST HERE> ###
pip install --upgrade pip
cd qiskit-fermions

Installa le restanti dipendenze build. Se prevedi di sviluppare nel repository, installa le dipendenze dev.

pip install --group build
pip install --group dev  # optional

Il passo successivo è installare qiskit-fermions nell'ambiente virtuale.

pip install .

Suggerimento

Puoi anche eseguire un'installazione modificabile compilando comunque il crate Rust sottostante in modalità release:

SETUPTOOLS_RUST_CARGO_PROFILE=release pip install -e .

Suggerimento

Alcune funzionalità dipendono da dipendenze opzionali. Per installarle tutte, usa l'extra all:

pip install ".[all]"

Consulta la sezione [project.optional-dependencies] di pyproject.toml per vedere quali gruppi di dipendenze sono disponibili.

Puoi facoltativamente verificare che l'installazione sia riuscita. Il test più semplice è provare a importare una delle classi fornite dal pacchetto qiskit-fermions, come nell'esempio seguente:

python -c "from qiskit_fermions.circuit import FermionicCircuit"

Se si completa con successo, la tua installazione ha funzionato.

Suggerimento

Puoi anche eseguire l'intera suite di test Python:

pip install --group test
make testpython

Per eseguire inoltre i test che coinvolgono le dipendenze opzionali, installa gli extra e usa il target testoptional:

pip install -e ".[all]"
make testoptional