{"id":37629799,"url":"https://github.com/zivid/zivid-python","last_synced_at":"2026-01-16T10:55:48.416Z","repository":{"id":37451170,"uuid":"194618293","full_name":"zivid/zivid-python","owner":"zivid","description":"Official Python package for Zivid 3D cameras","archived":false,"fork":false,"pushed_at":"2026-01-14T10:46:07.000Z","size":1183,"stargazers_count":60,"open_issues_count":21,"forks_count":17,"subscribers_count":20,"default_branch":"master","last_synced_at":"2026-01-14T14:35:02.375Z","etag":null,"topics":["python","zivid"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zivid.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2019-07-01T07:05:37.000Z","updated_at":"2026-01-13T10:06:41.000Z","dependencies_parsed_at":"2024-04-01T13:30:25.367Z","dependency_job_id":"6a0b8d79-3e82-454b-af9f-d1032221bcfa","html_url":"https://github.com/zivid/zivid-python","commit_stats":null,"previous_names":[],"tags_count":35,"template":false,"template_full_name":null,"purl":"pkg:github/zivid/zivid-python","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zivid%2Fzivid-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zivid%2Fzivid-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zivid%2Fzivid-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zivid%2Fzivid-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zivid","download_url":"https://codeload.github.com/zivid/zivid-python/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zivid%2Fzivid-python/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28478096,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-16T06:30:42.265Z","status":"ssl_error","status_checked_at":"2026-01-16T06:30:16.248Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["python","zivid"],"created_at":"2026-01-16T10:55:48.346Z","updated_at":"2026-01-16T10:55:48.407Z","avatar_url":"https://github.com/zivid.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Zivid Python\n\nZivid Python is the official Python package for Zivid 3D cameras. Read more about Zivid\nat [zivid.com](https://www.zivid.com/).\n\n[![Build Status][ci-badge]][ci-url] [![PyPI Package][pypi-badge]][pypi-url]\n![Zivid Image][header-image]\n\n---\n\n*Contents:* **[Installation](#installation)** | **[Quick Start](#quick-start)** | **[Examples](#examples)** |\n**[Versioning](#versioning)** | **[License](#license)** | **[Support](#support)** | **[Test Matrix](#test-matrix)**\n\n---\n\n## Installation\n\n### Dependencies\n\n* [Python](https://www.python.org/) version 3.7 or higher\n* [Zivid SDK][zivid-download-software-url] version 2.17.2 (see [docs][zivid-software-installation-url] for help)\n* [Compiler](doc/CompilerInstallation.md) with C++17 support\n\n*Ubuntu users must install Python headers (`apt install python3-dev`) in addition to the regular `python3` package.*\n\n*Windows users also needs to make sure that the Zivid SDK installation folder is in system `PATH` before using the\npackage, not only the terminal PATH variable. The default install location that should be added to system `PATH`\nis `C:\\Program Files\\Zivid\\bin`.*\n\n### Installing official version from PyPI using PIP\n\nAfter having installed the latest Zivid SDK, the easiest way to install Zivid Python is to use PIP to fetch the latest\nofficial version from PyPI:\n\n```shell\npip install zivid\n```\n\nNote:\n\n\u003e If you don't use the latest Zivid SDK version you need to manually specify the version. See [Versioning](#versioning).\n\nInstallation may take some time since the `setup.py` script will download additional dependencies and compile C++ source\ncode in the background.\n\nOn some systems Python 3 `pip` is called `pip3`. In this guide we assume it is called `pip`. When using PIP version 19\nor higher build dependencies are handled automatically.\n\n#### Old PIP\n\nIf you are using a version of PIP older than version 19 please manually install the dependencies listed\nin [pyproject.toml](pyproject.toml) before installing zivid.\n\n```shell\npip install \u003cpackages listed in pyproject.toml\u003e\npip install zivid\n```\n\n### Installing from source\n\n```shell\ngit clone \u003czivid-python clone URL\u003e\ncd zivid-python\npip install .\n```\n\nThe above `pip install .` command may give permission issues on some Windows machines. If so, try the following instead:\n\n```shell\npython continuous-integration/windows/create_binary_distribution.py\npip install ./dist/*.whl\n```\n\nYou may want to build Zivid Python against a different (but compatible) version of Zivid SDK. An example would be if\nZivid SDK 2.1 was released but the official\nZivid Python still formally only supports SDK 2.0. Since all the features of the 2.0 API exist in the 2.1 API, Zivid\nPython can still be built with the new SDK\n(but without wrapping the latest features). In order to achieve this, edit `sdk_version.json` to target the new SDK\nversion before doing `pip install .`. Note that this option is considered experimental/unofficial.\n\n## Quick Start\n\n### Point cloud capture\n\nTo quickly capture a point cloud using default settings, run the following code:\n\n```python\nimport zivid\n\napp = zivid.Application()\ncamera = app.connect_camera()\nsettings = zivid.Settings(\n    acquisitions=[zivid.Settings.Acquisition()],\n    color=zivid.Settings2D(acquisitions=[zivid.Settings2D.Acquisition()]),\n)\nframe = camera.capture_2d_3d(settings)\nframe.save(\"result.zdf\")\n```\n\nInstead of using the API to define capture settings, it is also possible to load them from YML files that\nhave been exported from [Zivid Studio][zivid-studio-guide-url] or downloaded from the Zivid Knowledge Base\n[settings library][zivid-two-standard-settings-url]. This can be done by providing the filesystem path to\nsuch a file, for example:\n\n```python\nsettings = Settings.load(\"ZividTwo_Settings_2xHDR_Normal.yml\")\nframe = camera.capture_2d_3d(settings)\n```\n\n### Point cloud data access\n\nData can easily be accessed in the form of Numpy arrays:\n\n```python\nimport zivid\n\napp = zivid.Application()\ncamera = app.connect_camera()\nsettings = zivid.Settings(\n    acquisitions=[zivid.Settings.Acquisition()],\n    color=zivid.Settings2D(acquisitions=[zivid.Settings2D.Acquisition()]),\n)\nframe = camera.capture_2d_3d(settings)\nxyz = frame.point_cloud().copy_data(\"xyz\")  # Get point coordinates as [Height,Width,3] float array\nrgba = frame.point_cloud().copy_data(\"rgba\")  # Get point colors as [Height,Width,4] uint8 array\nbgra = frame.point_cloud().copy_data(\"bgra\")  # Get point colors as [Height,Width,4] uint8 array\n```\n\n### Capture Assistant\n\nInstead of manually adjusting settings, the Capture Assistant may be used to find the optimal settings for your scene:\n\n```python\nimport zivid\n\napp = zivid.Application()\ncamera = app.connect_camera()\ncapture_assistant_params = zivid.capture_assistant.SuggestSettingsParameters()\nsettings = zivid.capture_assistant.suggest_settings(camera, capture_assistant_params)\nframe = camera.capture_2d_3d(settings)\nframe.save(\"result.zdf\")\n```\n\n### Using camera emulation\n\nIf you do not have a camera, you can use the `FileCameraZivid2M70.zfc` file in\nthe [Sample Data][zivid-download-sampledata-url] to emulate a camera.\n\n```python\nimport zivid\n\napp = zivid.Application()\ncamera = app.create_file_camera(\"path/to/FileCameraZivid2M70.zfc\")\nsettings = zivid.Settings(acquisitions=[zivid.Settings.Acquisition()])\nframe = camera.capture_3d(settings)\nframe.save(\"result.zdf\")\n```\n\n## Examples\n\nBasic example programs can be found in the [samples](samples) directory.\nMany more advanced example programs may be found in the separate\n[zivid-python-samples](https://github.com/zivid/zivid-python-samples) repository.\n\n## Versioning\n\nThis python module is released with the same version number as the Zivid SDK that it supports. The Zivid SDK is using\n[semantic versioning](https://semver.org/) with major, minor, and patch versions.\n\nIf a patch is released to fix an issue with this python module separately from a Zivid SDK patch release, then a fourth\nnumber signifying the patch version of the python module will be added to the end:\n\n### Version breakdown\n\n```text\n                              Zivid SDK version = 2.16.0\n                              v vv v\nZivid Python module version = 2.16.0.1\n                                     ^\n                                     Zivid Python module patch version (omitted if 0)\n```\n\n\u003e [!NOTE]\n\u003e **Versioning Prior to 2.16.0**\n\u003e\n\u003e Before version 2.16.0, this python module used a similar but different versioning scheme with six numbers. In this\n\u003e scheme, the first three numbers specified the semantic version of the python module while the next three numbers\n\u003e specified the semantic version of the supported Zivid SDK. In some early versions of the python module, these semantic\n\u003e versions could be different, but eventually they were synced up, and from version 2.16.0 the versioning system was\n\u003e simplified as explained above.\n\n### PyPI\n\nWhen installing using PIP it is possible to specify the required version. This can be useful if using an older version\nof the Zivid SDK.\n\nTo see the complete list of released versions of this python module, see [zivid-python-releases-url] or run\n`pip index versions zivid`.\n\nNote that as explained above, the versioning system was simplified starting with version 2.16.0 such that the Zivid\nPython is the same as the supported Zivid SDK version. Older releases used a different versioning scheme, which is also\nexplained above.\n\n#### Install latest version of Zivid Python using latest available version of Zivid SDK\n\n```shell\npip install zivid\n```\n\nNote: The installation may fail if the latest available version of Zivid SDK is not installed on the system. See\n[Installation](#installation).\n\n#### Install a specific version of Zivid Python\n\n```shell\npip install zivid==2.16.0\n```\n\nThis requires Zivid SDK version 2.16.0 to be installed on the system.\n\n#### Using the old versioning scheme, install version 2.6.0 of the Zivid Python wrapper supporting Zivid SDK 2.7.0\n\n```shell\npip install zivid==2.6.0.2.7.0\n```\n\nThis requires Zivid SDK version 2.7.0 to be installed on the system.\n\n## License\n\nThis project is licensed, see the [LICENSE](LICENSE) file for details. The licenses of dependencies are\nlisted [license dependencies](./licenses-dependencies).\n\n## Support\n\nPlease visit [Zivid Knowledge Base][zivid-knowledge-base-url] for general information on using Zivid 3D cameras. If you\ncannot find a solution to your issue, please contact \u003ccustomersuccess@zivid.com\u003e.\n\n## Test matrix\n\nThe test matrix shows which Python versions and operating systems are tested in CI.\nCheck [text matrix here](continuous-integration/TestMatrix.md) to go to the test matrix.\n\n[header-image]: https://www.zivid.com/hubfs/softwarefiles/images/zivid-generic-github-header.png\n\n[ci-badge]: https://img.shields.io/github/actions/workflow/status/zivid/zivid-python/main.yml?branch=master\n\n[ci-url]: https://github.com/zivid/zivid-python/actions?query=workflow%3A%22Main+CI+workflow%22+branch%3Amaster\n\n[pypi-badge]: https://img.shields.io/pypi/v/zivid.svg\n\n[pypi-url]: https://pypi.org/project/zivid\n\n[zivid-knowledge-base-url]: http://support.zivid.com\n\n[zivid-software-installation-url]: https://support.zivid.com/latest/getting-started/software-installation.html\n\n[zivid-download-software-url]: https://www.zivid.com/downloads\n\n[zivid-download-sampledata-url]: https://support.zivid.com/en/latest/api-reference/samples/sample-data.html\n\n[zivid-python-releases-url]: https://pypi.org/project/zivid/#history\n\n[zivid-studio-guide-url]: https://support.zivid.com/en/latest/getting-started/studio-guide.html\n\n[zivid-two-standard-settings-url]: https://support.zivid.com/en/latest/reference-articles/standard-acquisition-settings-zivid-two.html\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzivid%2Fzivid-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzivid%2Fzivid-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzivid%2Fzivid-python/lists"}