Skip to content

[infra] Document PyCuVSLAM install for cuvslam_app - #73

Open
slepichev wants to merge 1 commit into
mainfrom
slepichev/docs-cuvslam-app-pycuvslam-install
Open

[infra] Document PyCuVSLAM install for cuvslam_app#73
slepichev wants to merge 1 commit into
mainfrom
slepichev/docs-cuvslam-app-pycuvslam-install

Conversation

@slepichev

@slepichev slepichev commented Jul 28, 2026

Copy link
Copy Markdown
Collaborator

tools/cuvslam_app/README.md told users to run ./create_env.sh and nothing else, but that script only creates .env and installs requirements.txt. PyCuVSLAM is not in requirements.txt, so following the README verbatim left the app failing with ModuleNotFoundError: No module named 'cuvslam'.

Expand the Requirements section to cover the missing steps: activating .env in the caller's shell (create_env.sh runs in a subshell, so its own source does not persist), installing PyCuVSLAM inside the environment from either a release wheel or python/ with CUVSLAM_BUILD_DIR, and a verification command. Link to the main README for the wheel compatibility matrix and CUDA prerequisites.

Summary by CodeRabbit

  • Documentation
    • Replaced the minimal setup instructions with a step-by-step environment setup workflow.
    • Added guidance for creating and activating the environment.
    • Documented installation options for the cuVSLAM Python bindings.
    • Added a verification step to confirm the installation and version.

tools/cuvslam_app/README.md told users to run ./create_env.sh and nothing
else, but that script only creates .env and installs requirements.txt.
PyCuVSLAM is not in requirements.txt, so following the README verbatim
left the app failing with ModuleNotFoundError: No module named 'cuvslam'.

Expand the Requirements section to cover the missing steps: activating
.env in the caller's shell (create_env.sh runs in a subshell, so its own
source does not persist), installing PyCuVSLAM inside the environment
from either a release wheel or python/ with CUVSLAM_BUILD_DIR, and a
verification command. Link to the main README for the wheel
compatibility matrix and CUDA prerequisites.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 28, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The cuVSLAM application README now provides step-by-step instructions for creating and activating an environment, installing the cuvslam bindings, and verifying the installation.

Changes

cuVSLAM application setup

Layer / File(s) Summary
Document the setup workflow
tools/cuvslam_app/README.md
Replaces the single setup command with instructions for creating the environment, activating .env, installing bindings from a wheel or local build, and checking the installed version.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested reviewers: hrabeti-nvidia, vikuznetsov-nvidia

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main change: documenting PyCuVSLAM installation for cuvslam_app.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch slepichev/docs-cuvslam-app-pycuvslam-install

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@tools/cuvslam_app/README.md`:
- Around line 7-10: Add blank lines immediately before and after every fenced
code block in the README sections referenced, including the block following
“Create the virtual environment and install the third-party dependencies,” while
preserving all commands and surrounding text.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: 99b7e049-cea8-4b77-bc7b-2b8b57716344

📥 Commits

Reviewing files that changed from the base of the PR and between 57f42cc and eabb06c.

📒 Files selected for processing (1)
  • tools/cuvslam_app/README.md

Comment thread tools/cuvslam_app/README.md
@github-actions

Copy link
Copy Markdown

Test Results

Status Platform Language Total Passed Failed Errors Skipped
Orin C++ 16 16 0 0 0
Orin Python 71 70 0 0 1
Thor C++ 16 16 0 0 0
Thor Python 71 70 0 0 1
x86_64 C++ 16 16 0 0 0
x86_64 Python 71 70 0 0 1

cuVSLAM Evaluation KPIs

Config Dataset ATE,% ARE,º/m Kabsch, Losts, diff ATE,% diff ARE,º/m diff Kabsch, diff Losts, FPS,Hz
x86_64-cuda12.6.3-ubuntu24.04 KITTI-STEREO_ODOM 0.8404 0.0023 2.8381 0 NA NA NA NA 305.7
x86_64-cuda12.6.3-ubuntu24.04 KITTI-STEREO_SLAM 0.7587 0.002 1.9929 0 NA NA NA NA 187.4

Artifacts

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant