Mga tagubilin sa pag-install

Ipinapaliwanag ng page na ito kung paano i-install ang Python API. Wala pang available na C API para sa package na ito.

Mga kinakailangan

Una, gumawa ng minimal na environment na Python lang ang naka-install. Gumamit ng Python virtual environments.

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

I-activate ang bago mong environment.

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

May dalawang pangunahing paraan para i-install ang package na ito: mula sa PyPI o mula sa source. Ang inirerekomendang paraan ay mag-install mula sa PyPI:

Mag-install mula sa PyPI

pip install qiskit-bosons

Mag-install mula sa source

Kung plano mong mag-develop sa repository, dapat kang mag-install mula sa source.

Una, dapat naka-install ang Qiskit sa parehong Python environment kung saan mo ini-install ang qiskit-bosons. Ang pinakasimpleng paraan ay mula sa PyPI, pero maaari mo ring i-install ang Qiskit mula sa source kung gusto mo.

$ pip install qiskit

Susunod, i-clone ang repository ng qiskit-bosons.

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

Ngayon, i-install ang Rust toolchain, i-upgrade ang pip, at pumasok sa repository. Tingnan ang dokumentasyon ng Rust para sa mga tagubilin sa pag-install ng toolchain.

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

I-install ang natitirang build dependencies. Kung plano mong mag-develop sa repository, i-install ang dev dependencies.

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

Ang susunod na hakbang ay i-install ang qiskit-bosons sa virtual environment.

pip install .

Pahiwatig

Maaari ka ring gumawa ng editable install habang kino-compile pa rin ang pinagbabatayang Rust crate sa release mode:

SETUPTOOLS_RUST_CARGO_PROFILE=release pip install -e .

Pahiwatig

Ang ilang feature ay umaasa sa mga optional na dependency. Para i-install ang lahat ng mga ito, gamitin ang all extra:

pip install ".[all]"

Tingnan ang seksyong [project.optional-dependencies] ng pyproject.toml para makita kung aling mga dependency group ang available.

Maaari mong opsyonal na i-verify kung matagumpay ang pag-install. Ang pinakasimpleng test ay subukang mag-import ng isa sa mga class na ibinibigay ng package na qiskit-bosons, tulad ng sa sumusunod na halimbawa:

python -c "from qiskit_bosons.circuit import BosonicCircuit"

Kung matagumpay itong natapos, gumana ang pag-install mo.

Pahiwatig

Maaari mo ring patakbuhin ang buong Python test suite:

pip install --group test
make testpython

Para patakbuhin din ang mga test na gumagamit ng mga optional na dependency, i-install ang mga extra at gamitin ang testoptional target:

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