Skip to content

Added nanovdb-editor as an optional dependency#559

Merged
swahtz merged 3 commits into
openvdb:mainfrom
swahtz:optional_depends
Mar 25, 2026
Merged

Added nanovdb-editor as an optional dependency#559
swahtz merged 3 commits into
openvdb:mainfrom
swahtz:optional_depends

Conversation

@swahtz

@swahtz swahtz commented Mar 24, 2026

Copy link
Copy Markdown
Contributor

This pull request updates the documentation and package configuration to clarify supported software versions and add an optional dependency for the viewer feature.

Documentation updates:

  • Updated the software requirements section in docs/installation.rst to include a compatibility matrix that specifies supported versions of fVDB alongside compatible versions of PyTorch, Python, CUDA, and Vulkan for each minor release. This provides clearer guidance for users on which software versions are officially supported.

Packaging improvements:

  • Added an optional dependency group viewer in pyproject.toml for the nanovdb-editor package, allowing users to install viewer-related dependencies only when needed.

Also added a compatibility matrix of software similar to PyTorch (https://github.com/pytorch/pytorch/blob/main/RELEASE.md#release-compatibility-matrix)

Signed-off-by: Jonathan Swartz <jonathan@jswartz.info>
@swahtz swahtz requested a review from a team as a code owner March 24, 2026 04:39
@swahtz swahtz added documentation Improvements or additions to documentation cmake/build Issues related to building and CMake labels Mar 24, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates fVDB’s installation documentation to better communicate supported platform/software combinations per release, and extends Python packaging metadata with an install-time optional dependency for the visualization/viewer functionality.

Changes:

  • Added a viewer optional dependency group to the Python package metadata (pyproject.toml) to install nanovdb-editor only when needed.
  • Replaced the prior single-row requirements table in docs/installation.rst with a per-minor-release compatibility matrix (PyTorch/Python/CUDA/Vulkan).

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
pyproject.toml Introduces a viewer optional dependency extra for nanovdb-editor.
docs/installation.rst Adds a compatibility matrix and clarifies supported software versions per fVDB minor release.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/installation.rst
Comment thread docs/installation.rst Outdated
Comment thread docs/installation.rst Outdated
Signed-off-by: Jonathan Swartz <jonathan@jswartz.info>
@swahtz swahtz enabled auto-merge (squash) March 25, 2026 04:53
Signed-off-by: Jonathan Swartz <jonathan@jswartz.info>
@swahtz swahtz merged commit c0bbbd6 into openvdb:main Mar 25, 2026
35 checks passed
swahtz added a commit that referenced this pull request Mar 25, 2026
This pull request updates the documentation and package configuration to
clarify supported software versions and add an optional dependency for
the viewer feature.

**Documentation updates:**

* Updated the software requirements section in `docs/installation.rst`
to include a compatibility matrix that specifies supported versions of
fVDB alongside compatible versions of PyTorch, Python, CUDA, and Vulkan
for each minor release. This provides clearer guidance for users on
which software versions are officially supported.

**Packaging improvements:**

* Added an optional dependency group `viewer` in `pyproject.toml` for
the `nanovdb-editor` package, allowing users to install viewer-related
dependencies only when needed.

---------

Signed-off-by: Jonathan Swartz <jonathan@jswartz.info>
@swahtz swahtz added this to the v0.5 milestone Mar 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cmake/build Issues related to building and CMake documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants