Instalar la API de Python

Requisitos previos

Primero, crea un entorno mínimo con solo Python instalado. Usa entornos virtuales de Python.

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

Activa tu nuevo entorno.

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

Hay dos formas principales de instalar este paquete: desde PyPI o desde el código fuente. El método preferido es instalar desde PyPI:

Instalar desde PyPI

pip install qiskit-fermions

Instalar desde el código fuente

Si planeas desarrollar en el repositorio, debes instalar desde el código fuente.

Primero, Qiskit debe estar instalado en el mismo entorno de Python en el que instales qiskit-fermions. La forma más sencilla de hacerlo es desde PyPI, pero puedes instalar Qiskit desde el código fuente si lo deseas.

$ pip install qiskit

A continuación, clona el repositorio qiskit-fermions.

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

Ahora, instala la cadena de herramientas de Rust, actualiza pip y entra en el repositorio. Consulta la documentación de Rust para ver las instrucciones de instalación de la cadena de herramientas.

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

Instala las dependencias build restantes. Si planeas desarrollar en el repositorio, instala las dependencias dev.

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

El siguiente paso es instalar qiskit-fermions en el entorno virtual.

pip install .

Sugerencia

También puedes realizar una instalación editable y seguir compilando el crate de Rust subyacente en modo release:

SETUPTOOLS_RUST_CARGO_PROFILE=release pip install -e .

Sugerencia

Algunas funciones dependen de dependencias opcionales. Para instalarlas todas, usa el extra all:

pip install ".[all]"

Consulta la sección [project.optional-dependencies] de pyproject.toml para ver qué grupos de dependencias están disponibles.

Opcionalmente, puedes verificar que la instalación se haya realizado correctamente. La prueba más sencilla es intentar importar una de las clases que proporciona el paquete qiskit-fermions, como en el siguiente ejemplo:

python -c "from qiskit_fermions.circuit import FermionicCircuit"

Si esto se completa correctamente, tu instalación funcionó.

Sugerencia

También puedes ejecutar toda la suite de pruebas de Python:

pip install --group test
make testpython

Para ejecutar además las pruebas que ejercitan las dependencias opcionales, instala los extras y usa el objetivo testoptional:

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