설치 안내

이 페이지에서는 Python API를 설치하는 방법을 설명합니다. 이 패키지의 C API는 아직 제공되지 않습니다.

사전 요건

먼저 Python만 설치된 최소한의 환경을 만드세요. Python 가상 환경을 사용하세요.

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

새 환경을 활성화하세요.

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

이 패키지를 설치하는 주요 방법은 PyPI에서 설치하거나 소스에서 설치하는 두 가지입니다. 권장 방법은 PyPI에서 설치하는 것입니다.

pip install qiskit-bosons

저장소에서 개발할 계획이라면 소스에서 설치해야 합니다.

먼저 qiskit-bosons를 설치하는 것과 같은 Python 환경에 Qiskit이 설치되어 있어야 합니다. 가장 간단한 방법은 PyPI에서 설치하는 것이지만, 원한다면 소스에서 Qiskit을 설치할 수도 있습니다.

$ pip install qiskit

다음으로 qiskit-bosons 저장소를 클론하세요.

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

이제 Rust 툴체인을 설치하고, pip를 업그레이드한 뒤, 저장소로 이동하세요. 툴체인 설치 방법은 Rust 문서를 참조하세요.

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

나머지 build 의존성을 설치하세요. 저장소에서 개발할 계획이라면 dev 의존성도 설치하세요.

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

다음 단계는 qiskit-bosons를 가상 환경에 설치하는 것입니다.

pip install .

힌트

기반이 되는 Rust 크레이트를 release 모드로 컴파일하면서 편집 가능 설치를 수행할 수도 있습니다.

SETUPTOOLS_RUST_CARGO_PROFILE=release pip install -e .

힌트

일부 기능은 선택적 의존성에 의존합니다. 모두 설치하려면 all extra를 사용하세요.

pip install ".[all]"

사용 가능한 의존성 그룹은 pyproject.toml의 [project.optional-dependencies] 섹션을 참조하세요.

설치가 성공했는지 선택적으로 확인할 수 있습니다. 가장 간단한 테스트는 다음 예제처럼 qiskit-bosons 패키지가 제공하는 클래스 중 하나를 가져와 보는 것입니다.

python -c "from qiskit_bosons.circuit import BosonicCircuit"

이 과정이 오류 없이 완료되면 설치가 제대로 된 것입니다.

힌트

전체 Python 테스트 스위트를 실행할 수도 있습니다.

pip install --group test
make testpython

선택적 의존성을 사용하는 테스트까지 실행하려면 extra를 설치하고 testoptional 타깃을 사용하세요.

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