Instruções de instalação

Esta página explica como instalar a API Python. Uma API em C ainda não está disponível para este pacote.

Pré-requisitos

Primeiro, crie um ambiente mínimo com apenas o Python instalado. Use ambientes virtuais Python.

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

Ative seu novo ambiente.

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

Há duas formas principais de instalar este pacote: pelo PyPI ou a partir do código-fonte. O método preferido é instalar pelo PyPI:

Instalar pelo PyPI

pip install qiskit-bosons

Instalar a partir do código-fonte

Se você pretende desenvolver no repositório, deve instalar a partir do código-fonte.

Primeiro, o Qiskit precisa estar instalado no mesmo ambiente Python em que você instala o qiskit-bosons. A forma mais simples é pelo PyPI, mas você pode instalar o Qiskit a partir do código-fonte se quiser.

$ pip install qiskit

Em seguida, clone o repositório qiskit-bosons.

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

Agora, instale a toolchain do Rust, atualize o pip e entre no repositório. Consulte a documentação do Rust para instruções de instalação da toolchain.

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

Instale as demais dependências de build. Se você pretende desenvolver no repositório, instale as dependências de dev.

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

O próximo passo é instalar o qiskit-bosons no ambiente virtual.

pip install .

Dica

Você também pode fazer uma instalação editável e ainda compilar o crate Rust subjacente no modo release:

SETUPTOOLS_RUST_CARGO_PROFILE=release pip install -e .

Dica

Alguns recursos dependem de dependências opcionais. Para instalar todas elas, use o extra all:

pip install ".[all]"

Consulte a seção [project.optional-dependencies] do pyproject.toml para ver quais grupos de dependências estão disponíveis.

Opcionalmente, você pode verificar se a instalação foi bem-sucedida. O teste mais simples é tentar importar uma das classes fornecidas pelo pacote qiskit-bosons, como no exemplo a seguir:

python -c "from qiskit_bosons.circuit import BosonicCircuit"

Se isso for concluído com sucesso, sua instalação funcionou.

Dica

Você também pode executar toda a suíte de testes do Python:

pip install --group test
make testpython

Para executar também os testes que exercitam dependências opcionais, instale os extras e use o alvo testoptional:

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