Skip to content

Commit

Permalink
Pull request #77: Expand pip install description
Browse files Browse the repository at this point in the history
Merge in HSW_SDK/vmbpy from feature/add-specific-install-command-for-installing-extras to dev

* commit '26dec5716e922374819259e19e3755f64b3b86d1':
  Add note about possibility of command being `pip3`
  Expand `pip install` description
  • Loading branch information
NiklasKroeger-AlliedVision committed Nov 10, 2023
2 parents 0ec3613 + 26dec57 commit ce307e2
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,11 @@ allowing for rapid development of applications.
To use VmbPy an installation of Vimba X and Python >= 3.7 are required. A ready-to-install packaged
`.whl` file of VmbPy can be found as part of the Vimba X installation, or be downloaded from our
[github release page](https://github.com/alliedvision/VmbPy/releases). The `.whl` can be installed
as usual via the `pip install` command.
as usual via the [`pip install`](https://pip.pypa.io/en/stable/cli/pip_install/) command.

> [!NOTE]
> Depending on the some systems the command might instead be called `pip3`. Check your systems
> Python documentation for details.
## Optional dependencies

Expand All @@ -24,6 +28,13 @@ tools that are used in our full test suite. The following extras are defined for
- test: Additional tools such as `flake8`, `mypy`, and `coverage` only necessary for executing
`run_tests.py`

> [!NOTE]
> Installing these extra dependencies is possible by defining them as part of the installation
> command like so (note the single quotes around the filename and extras):
> ```
> pip install '/path/to/vmbpy-X.Y.Z-py-none-any.whl[numpy,opencv]'
> ```
### Yocto on NXP i.MX8 and OpenCV

The GPU in i.MX8 systems requires using the system-wide opencv-python package. When you create the
Expand Down

0 comments on commit ce307e2

Please sign in to comment.