Primeiros Passos¶

Instalação¶

Iniciar localmente

Qiskit suporta Python 3.6 ou posterior. No entanto, tanto o Python quanto o Qiskit são ecossistemas em evolução, e às vezes quando ocorrem novas versões em um ou outro, pode haver problemas com a compatibilidade.

Recomendamos a instalação do Anaconda, uma distribuição de Python independente de plataforma para computação científica. O Jupyter, incluído no Anaconda, é recomendado para interagir com o Qiskit.

O Qiskit é testado e suportado nos seguintes sistemas 64-bit:

Ubuntu 16.04 ou posterior
macOS 10.12.6 ou posterior
Windows 7 ou posterior

Recomendamos usar os ambientes virtuais do Python para separar o Qiskit de outras aplicações e melhorar sua experiência.

A maneira mais simples de usar os ambientes é usando o comando conda incluído com a Anaconda. Um ambiente Conda permite que você especifique uma versão específica do Python e conjunto de bibliotecas. Abra uma janela de terminal no diretório onde você deseja trabalhar.

É preferível que você instale o comando Anaconda junto com o Anaconda. Tudo que você precisa fazer é criar um ambiente virtual dentro do Anaconda, e ativar esse ambiente. Esses comandos podem ser executados no Anaconda prompt independentemente do uso de um computador com Windows ou Linux.

Crie um ambiente mínimo, apenas com o Python instalado nele.

conda create -n ENV_NAME python=3

Ative seu novo ambiente.

conda activate ENV_NAME

Em seguida, instale o pacote Qiskit.

pip install qiskit

Se os pacotes foram instalados corretamente, você pode executar conda list para ver os pacotes ativos em seu ambiente virtual.

Se você pretende utilizar a funcionalidade de visualização ou Jupyter notebooks, é recomendado instalar Qiskit com suporte extra de visualization:

pip install qiskit[visualization]

Vale a pena ressaltar que se você é um usuário zsh (que é o shell padrão em versões mais recentes do macOS), você vai precisar colocar qiskit[visualization] entre aspas:

pip install 'qiskit[visualization]'

Começar na nuvem

Os fornecedores de nuvem a seguir têm Qiskit pré-instalado em seus ambientes:

IBM Quantum Lab

Build quantum applications and experiments with Qiskit in a cloud programming environment.

Strangeworks

A platform that enables users and organizations to easily apply quantum computing to their most pressing problems and research.

Instalando da Fonte

A instalação dos elementos do código fonte permite que você acesse a versão mais recente do Qiskit em vez de usar a versão do repositório Python Package Index (PyPI). Isso lhe dará a capacidade de inspecionar e estender a versão mais recente do código Qiskit de forma mais eficiente.

Ao instalar os elementos e componentes da fonte, por padrão sua versão development (que corresponde a branch master no git) será usada, ao contrário da versão stable (que contém a mesma base de código que os pacotes pip publicados). Uma vez que as versões development de um elemento ou componente geralmente incluem novas características e mudanças, normalmente elas exigem usar a versão development ao resto dos itens também.

Ambos os pacotes Terra e Aer requerem um compilador para fazer o build a partir da fonte antes da instalação. Ignis, Aqua e o provedor IBM Quantum não exigem um compilador.

Instalar elementos da fonte requer a seguinte ordem de instalação para evitar a instalação de versões de elementos que podem ser menores do que as desejadas se a versão pip estiver atrás das versões fonte:

qiskit-terra
qiskit-aer
qiskit-ignis
qiskit-aqua
:ref:` qiskit-ibmq-provider <install-qiskit-ibmq-provider>` (se você quiser conectar-se aos dispositivos IBM Quantum ou simulador online)

Para trabalhar com vários componentes e elementos simultaneamente, use as seguintes etapas para cada elemento.

Nota

Devido ao uso de empacotamento por namespace em Python, é preciso ter cuidado com a forma como você instala os pacotes. Se você está planejando instalar algum elemento a partir da fonte, não use o meta-package qiskit. Além disso, siga este guia e use um ambiente virtual separado para desenvolvimento. Se você optar por misturar uma instalação existente com o seu desenvolvimento, consulte https://github.com/pypa/sample-namespace-packages/blob/master/table.md para o conjunto de combinações de métodos de instalação que funcionam juntos.

Set up the Virtual Development Environment

conda create -y -n QiskitDevenv python=3
conda activate QiskitDevenv

Installing Terra from Source

Instalar a partir do código fonte requer que você tenha um compilador C++ em seu sistema que suporte C++11.

Compilador para Linux

Na maioria das plataformas Linux, o compilador GCC necessário já está instalado.

Compilador para macOS

Se você usa macOS, você pode instalar o compilador Clang instalando o XCode. Verifique se você tem XCode e Clang instalados abrindo uma janela do terminal e entrando o seguinte comando.

clang --version

Instale o XCode e Clang usando o seguinte comando.

xcode-select --install

Compilador para Windows

No Windows, é mais fácil instalar o compilador Visual C ++ a partir da Build Tools for Visual Studio 2017. Você pode instalar também o Visual Studio versão 2015 ou 2017, certificando-se de selecionar as opções para instalar o compilador C++.

Quando os compiladores estiverem instalados, você estará pronto para instalar o Qiskit Terra.

Clone o repositório Terra.

git clone https://github.com/Qiskit/qiskit-terra.git

Clonar o repositório criará uma pasta local chamada qiskit-terra.
```
cd qiskit-terra
```
Instale as bibliotecas Python requeridas pelo seu diretório qiskit-terra.
```
pip install cython
```
Se você quiser executar testes ou análise de código, instale os requisitos de desenvolvedor.
```
pip install -r requirements-dev.txt
```
Instale o qiskit-terra.
```
pip install .
```

Se você quiser instalá-lo em modo editável, o que significa que as alterações ao código no projeto não requerem que uma reinstalação seja aplicada, você pode fazer isso com:

pip install -e .

Você pode então executar os código de exemplo após instalar o Terra. Você pode executar o código de exemplo com o seguinte comando.

python examples/python/using_qiskit_terra_level_0.py

Nota

Se você não pretende instalar outros componentes, qiskit-terra irá emitir um alerta de RuntimeWarning de que ambos qiskit-aer e qiskit-ibmq-provider não estão instalados. Isso é feito porque os usuários comumente pretendem usar os elementos adicionais, mas não percebem que eles não estão instalados, ou que a instalação da Aer ou do Provedor IBM Quantum falhou por alguma razão. Se você deseja suprimir estes avisos, adicione:

import warnings
warnings.filterwarnings('ignore', category=RuntimeWarning,
                        module='qiskit')

antes de qualquer importação qiskit no seu código. Isto irá suprimir o aviso sobre o qiskit-aer e qiskit-ibmq-provider, mas seguirá exibindo quaisquer outros avisos do qiskit ou de outros pacotes.

Installing Aer from Source

Clone o repositório Aer.

git clone https://github.com/Qiskit/qiskit-aer

Instalar requisitos de compilação.
```
pip install cmake scikit-build cython
```

Depois disso, os passos para instalar o Aer dependem de qual sistema operacional você está usando. Uma vez que Aer é um programa compilado em C++ com uma interface em Python, existem dependências não-Python para fazer o build do binário Aer, que não podem ser instaladas universalmente dependendo do sistema operacional.

O Qiskit Aer é um framework de simulador de alto desempenho para circuitos quânticos. Ele fornece diversos backends para alcançar diferentes objetivos de simulação.

conda install --update-deps -c conda-forge -y openblas cmake

Faça a criação dos pacotes e instale o qiskit-aer diretamente

Se você tiver o pip <19.0.0 instalado e seu ambiente não requer um build personalizado, execute:
```
cd qiskit-aer
pip install .
```
Isto irá fazer o build dos binários e instalar o Aer.

Alternativamente, se você tiver um pip mais recente instalado ou tiver um requisito personalizado, você pode fazer a criação dos pacotes do Python wheel manualmente.
```
cd qiskit-aer
python ./setup.py bdist_wheel
```
Se você precisar definir uma opção personalizada durante a criação dos pacotes da wheel, consulte Opções personalizadas durante builds de wheel.

Depois de feito a criação dos pacotes do Python wheel, ela será armazenada no diretório dist/ no repositório Aer. A versão exata dependerá
```
cd dist
pip install qiskit_aer-*.whl
```
O nome exato do arquivo da wheel de saída depende da versão atual do Aer em desenvolvimento.

Custom options

O sistema de empacotamento Aer usa o scikit-build para executar a compilação ao fazer o build com a interface do Python. Ele atua como uma interface para setuptools para chamar o CMake e compilar os binários para o seu sistema local.

Devido à complexidade de compilar os binários, você pode precisar passar opções para uma determinada parte do processo de empacotamento. A maneira de passar variáveis é:

python setup.py bdist_wheel [skbuild_opts] [-- [cmake_opts] [-- build_tool_opts]]

onde os elementos dentro de colchetes [] são opcionais, e skbuild_opts, cmake_opts, build_tool_opts serão substituídos por flags de sua escolha. Uma lista das opções CMake está disponível aqui: https://cmake.org/cmake/help/v3.6/manual/cmake.1.html#options. Por exemplo, você pode executar algo como:

python setup.py bdist_wheel -- -- -j8

Isso está passando a flag -j8 para o sistema de empacotamento subjacente (que neste caso é Automake), dizendo que você deseja fazer o empacotamento em paralelo usando 8 processos.

Por exemplo, um caso de uso comum para essas flags no linux é para especificar uma versão específica do compilador C++ para usar (normalmente se o padrão for muito antigo):

python setup.py bdist_wheel -- -DCMAKE_CXX_COMPILER=g++-7

que vai dizer ao CMake para usar o comando g++-7 em vez do g++ padrão ao compilar o Aer.

Outro caso de uso comum para isso, dependendo do seu ambiente, é que você pode precisar especificar o nome da sua plataforma e desativar a linkagem estática.

python setup.py bdist_wheel --plat-name macosx-10.9-x86_64 \
-- -DSTATIC_LINKING=False -- -j8

Aqui --plat-name é uma flag para as ferramentas de configuração, para especificar o nome da plataforma a utilizar nos metadados do pacote, -DSTATIC_LINKING é uma flag para usar o CMake para desabilitar links estáticos, e -j8 é uma flag para fazer o Automake usar 8 processos para a compilação.

Uma lista de opções comuns dependendo da plataforma é:

Plataforma	Ferramenta	Opção	Caso de uso
Todas	Automake	-j	Seguido por um número, define o número de processos a serem usados para compilação.
Linux	CMake	-DCMAKE_CXX_COMPILER	Usado para especificar um compilador C++ específico; isto é frequentemente necessário se seu g++ padrão for muito antigo.
OSX	setuptools	–plat-name	Usado para especificar o nome da plataforma no pacote de saída Python.
OSX	CMake	-DSTATIC_LINKING	Usado para especificar se deve ou não ser utilizada linkagem estática.

Nota

Algumas dessas opções não são específicas da plataforma. Essas plataformas em particular são listadas porque são comumente usadas no ambiente. Consulte a documentação da ferramenta para obter mais informações.

Installing Ignis from Source

Clone o repositório Ignis.

git clone https://github.com/Qiskit/qiskit-ignis.git

Clonar o repositório cria uma pasta local chamada qiskit-ignis.
```
cd qiskit-ignis
```
Se você quiser executar testes ou análise de código, instale os requisitos de desenvolvedor. Isso não é necessário para instalar ou usar o pacote qiskit-ignis quando instalando a partir do código fonte.
```
pip install -r requirements-dev.txt
```
Instale Ignis.
```
pip install .
```

Se você quiser instalá-lo em modo editável, o que significa que as alterações ao código do projeto não requerem uma reinstalação para serem aplicadas:

pip install -e .

Installing Aqua from Source

Clone o repositório Aqua.

git clone https://github.com/Qiskit/qiskit-aqua.git

Clonar o repositório cria uma pasta local chamada qiskit-aqua.
```
cd qiskit-aqua
```
Se você quiser executar testes ou análise de código, instale os requisitos de desenvolvedor. Isso não é necessário para instalar ou usar o pacote qiskit-aqua quando instalando do código fonte.
```
pip install -r requirements-dev.txt
```
Instalar Aqua.
```
pip install .
```

Se você quiser instalá-lo em modo editável, o que significa que as alterações ao código do projeto não requerem uma reinstalação para serem aplicadas:

pip install -e .

Installing IBM Quantum Provider from Source

Clone o repositório qiskit-ibmq-provider.

git clone https://github.com/Qiskit/qiskit-ibmq-provider.git

Clonar o repositório cria um diretório local chamado qiskit-ibmq-provider.
```
cd qiskit-ibmq-provider
```
Se você quiser executar testes ou análise de código, instale os requisitos de desenvolvedor. Isso não é necessário para instalar ou usar o pacote qiskit-ibmq-provider quando instalando do código fonte.
```
pip install -r requirements-dev.txt
```
Instalar o qiskit-ibmq-provider.
```
pip install .
```

Se você quiser instalá-lo em modo editável, o que significa que as alterações ao código do projeto não requerem uma reinstalação para serem aplicadas:

pip install -e .

Pronto para começar?…¶

Qiskit from the ground up

Learn how to build, execute, and post-process quantum circuits with Qiskit.

Start learning Qiskit

Dive into the tutorials

Find out how to leverage Qiskit for everything from single-circuits to full quantum application development.

Qiskit tutorials