Instruções de instalação

Para instalar, primeiro crie um novo ambiente Python:

Pré-requisitos

Crie um ambiente mínimo com apenas o Python instalado. Recomendamos usar ambientes virtuais Python.

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

Ative seu novo ambiente.

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

No Windows, execute \path\to\virtual\environment\Scripts\activate.

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

Instalar pelo PyPI

pip install 'qiskit-addon-sqd'

Os extras opcionais sbd e fulqrum, e o extra notebook-dependencies que os inclui, são suportados apenas no Linux e no macOS.

Instalar pelo código-fonte

Instale pelo código-fonte se quiser desenvolver no repositório ou executar os notebooks localmente.

O primeiro passo é clonar o repositório qiskit-addon-sqd.

git clone git@github.com:Qiskit/qiskit-addon-sqd.git

Em seguida, atualize o pip e entre no repositório.

pip install --upgrade pip
cd qiskit-addon-sqd

O próximo passo é instalar o qiskit-addon-sqd no ambiente virtual. Se você pretende executar os notebooks, instale as dependências dos notebooks para poder executar todas as visualizações neles. Instale as dependências dev se pretende desenvolver no repositório.

Ajuste as opções abaixo conforme suas necessidades.

pip install tox notebook -e '.[notebook-dependencies,dev]'

Se você instalou as dependências dos notebooks, pode começar executando os notebooks da documentação.

cd docs/
jupyter lab