I-install ang Python API

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 iyong bagong 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 ang pag-install mula sa PyPI:

I-install mula sa PyPI

pip install qiskit-fermions

I-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-fermions. 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-fermions.

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

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

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

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

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

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

pip install .

Hint

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 .

Hint

Umaasa ang ilang feature sa mga opsyonal 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 mo ring opsyonal na i-verify kung matagumpay ang installation. Ang pinakasimpleng pagsubok ay subukang mag-import ng isa sa mga class na ibinibigay ng package na qiskit-fermions, tulad ng sa sumusunod na halimbawa:

python -c "from qiskit_fermions.circuit import FermionicCircuit"

Kung matagumpay itong natapos, gumana ang iyong installation.

Hint

Maaari mo ring patakbuhin ang buong Python test suite:

pip install --group test
make testpython

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

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