ARTICLE DETAIL

资讯详情

深耕郑州网站建设与运营推广的一线实战洞察。

Rerun 安装完全指南:Python / Rust / C++ SDK 与独立 Viewer 的一站式安装手册

Rerun 安装完全指南:Python / Rust / C++ SDK 与独立 Viewer 的一站式安装手册 Rerun 安装完全指南Python / Rust / C SDK 与独立 Viewer 的一站式安装手册【免费下载链接】rerunVisualize, query, and stream to train on multimodal robotics data.项目地址: https://gitcode.com/GitHub_Trending/re/rerunRerun 是一套面向多模态机器人数据图像、点云、变换、时间序列、关节状态、视频等的可视化与数据处理工具链提供 Python、Rust、C 三种语言 SDK以及功能完备的独立 Viewer。本文以仓库官方安装文档 docs/content/getting-started/install-rerun.md 为主体完整覆盖三种 SDK 的安装方式、独立 Viewer 的全部安装途径以及从 Linux 系统依赖、WSL2 图形环境、pip 版本问题到 wgpu 渲染后端、多 GPU 与视频解码卡顿的完整故障排查手册并辅以仓库源码佐证帮助你一步到位完成环境搭建。安装方式总览按你的语言选择入口官方安装指南是一个导航枢纽它不重复罗列细节而是按语言将安装文档拆分为四份子文档你只需要做一次选择你的技术栈主安装文档附带内容PythonPython SDK 安装SDK 与 Viewer 一次装齐RustRust SDK 安装仅 SDK需另行安装 ViewerCC SDK 安装仅 SDK需另行安装 Viewer仅需可视化任意语言Viewer 安装独立 Viewer安装方式最丰富如果你在安装过程中遇到任何问题可以直接查阅 Troubleshooting 指南下文故障排查一节完整继承了该文档的全部内容。方式一Python SDK——一条命令同时拿到 SDK 和 ViewerPython SDK 是上手最快的路径它同时包含 SDK 与 Viewer一次安装即可开始记录和可视化数据这一设计也体现在仓库中rerun_py会打包rerun-cli二进制到 wheel 中。pip 安装基础版pip install rerun-sdkConda 安装conda install -c conda-forge rerun-sdkConda 渠道的包始终自带全部功能支持而使用 pip 时部分功能以可选特性extras的形式按需安装# 嵌入式 Notebook 工具在 Jupyter 中嵌入 Rerun Viewer pip install rerun-sdk[notebook] # 查询 API 工具Rerun Catalog 查询能力 pip install rerun-sdk[catalog] # 模型训练工具PyTorch Dataset 数据加载器 pip install rerun-sdk[dataloader]从源码可以确认这些 extras 的真实依赖在 rerun_py/pyproject.toml 的[project.optional-dependencies]中notebook对应rerun-notebook包catalog依赖datafusion与pandas用于数据帧查询与纳秒时间戳转换dataloader则声明了torch2.5、torchvision、avPyAV与pillow8.0.0用于将 Rerun 数据直接以 PyTorchDataset形式喂给训练流程——这与项目stream to train on multimodal robotics data的定位一致。快速验证安装安装完成后在任意 Python 文件中即可导入import rerun as rr更完整的 Hello World摘自 README.mdimport rerun as rr # pip install rerun-sdk rr.init(rerun_example_app) rr.spawn() # 启动一个 Viewer 子进程并连接 # rr.save(recording.rrd) # 将所有日志流写入磁盘 # rr.connect_grpc() # 连接远程 Viewer rr.set_time(frame, sequence42) rr.log(path/to/points, rr.Points3D(positions, colorscolors))rr.init使用稳定的ApplicationId命名本次记录Viewer 会据此在多次运行间保留 UI 状态关于 Recording 与 ApplicationId 的语义可参考 Recordings 概念文档。下一步安装完成后按照 Python 项目配置 搭建项目骨架然后进入 Log and Ingest 数据摄入教程 开始记录第一批数据。方式二Rust SDK——cargo 一条命令接入Rust SDK 使用 Cargo 管理依赖安装非常轻量cargo add rerun这条命令会将reruncrate 添加为项目的依赖对应仓库中的 crates/top/rerun 目录。需要注意Rust SDK 不附带 Viewer你需要额外安装 Viewer安装方法见下一节。Rust 工具链版本要求如果选择从源码构建 Viewercargo install rerun-cli --locked需要Rust 1.96 及以上。仓库根目录的 rust-toolchain 文件确认了当前开发基线channel 1.96.0并包含rustfmt、clippy组件与wasm32-unknown-unknown目标。可选在应用内直接嵌入 ViewerRust SDK 还支持通过rerun::native_viewer::show在进程内直接托管 Viewer需要在Cargo.toml中启用native_viewerfeature适用于从内存数据直接展示完整录制的场景详见 Log and Ingest 教程 中的Rust-only: showing the Viewer in-process一节。下一步按照 Rust 项目配置 创建项目cargo newcargo add rerun然后进入 Log and Ingest 教程。方式三C SDK——CMake FetchContent 集成C SDK 通过 CMake 的FetchContent模块集成到现有构建系统中官方推荐写法如下完整继承自 C SDK 安装文档include(FetchContent) FetchContent_Declare(rerun_sdk URL https://github.com/rerun-io/rerun/releases/latest/download/rerun_cpp_sdk.zip) FetchContent_MakeAvailable(rerun_sdk)构建配置的更多细节如 Arrow C 库的下载与构建策略见 C 参考文档中的 Build Distribution 章节。与 Rust 一样C SDK 不附带 Viewer需另行安装 Viewer。版本与标准要求Rerun 要求C17 或更高链接 SDK 会自动确保启用 C17更完整的项目模板含target_link_libraries(example_project PRIVATE rerun_sdk)与#include rerun.hpp见 C 项目配置从源码层面看仓库的 rerun_cpp/CMakeLists.txt 通过target_compile_features(rerun_sdk PUBLIC cxx_std_17)强制了 C17 标准并在 MSVC 下开启/MP多线程编译SDK 头文件位于 rerun_cpp/src/rerun.hpp。下一步按照 C 项目配置 搭建 CMake 工程然后进入 Log and Ingest 教程。安装独立 Viewer七种途径任选Viewer 可以独立于任何语言 SDK 安装适用于只想打开.rrd/.mcap等文件做可视化的场景。官方文档给出了多种安装途径按你的环境任选其一途径命令 / 方式说明预编译二进制从官方 Release 产物下载rerun-cli按平台选择对应压缩包开箱即用Cargo 下载二进制cargo binstall rerun-cli通过cargo-binstall直接下载预编译产物无需编译Cargo 源码编译cargo install rerun-cli --locked从源码构建要求 Rust 1.96Snap社区维护snap install rerun从 Snap Store 安装随 Python SDK 附带pip3 install rerun-sdk安装 Python SDK 即获得rerun命令随 Python SDK 附带conda install -c conda-forge rerun-sdkConda 渠道同样附带 Viewer随 Python SDK 附带pixi global install rerun-sdk通过 Pixi 全局安装安装完成后运行rerun即可启动 Viewer首屏是概览页可以直接跳转进入示例。版本匹配提醒请确保库SDK版本与 Viewer 版本一致Rerun 的数据格式在不同版本间尚未稳定官方 issue 中明确记录了这一限制混用版本可能导致无法正确打开录制数据。rerun-cli 的组成与内置能力从 crates/top/rerun-cli/Cargo.toml 可以看清rerun二进制的功能构成默认特性为web_viewerbase其中base包含native_viewer原生 Viewer、map_view地图视图、oss_server进程内 Rerun Server、perf_telemetryOpenTelemetry 遥测预发布产物release_full额外启用lanceLance 表支持与nasm汇编优化的视频解码--locked参数保证按Cargo.lock锁定版本依赖树构建结果可复现。此外Viewer 内置了对 RRD、MCAP、图片、视频、点云等多种文件格式的支持——这一点可以从 re_viewer/Cargo.toml 得到佐证Viewer 显式依赖re_importer并启用features [all]即打包了仓库中全部导入器importer。如果你需要打开 Rerun 尚未支持的文件类型可以按 打开任意文件 所述扩展导入能力无需修改 Rerun 本体。故障排查从 Linux 依赖到渲染后端的完整清单本节完整继承 Troubleshooting 指南并补充源码级的说明。开启调试日志在运行前设置环境变量可获得更详细的日志输出RUST_LOGdebug rerunLinux 系统依赖Debian / Ubuntu 系Rerun 在 macOS 与 Windows 上开箱即用但Linux 需要先安装系统依赖sudo apt-get -y install \ libclang-dev \ libatk-bridge2.0 \ libfontconfig1-dev \ libfreetype6-dev \ libglib2.0-dev \ libgtk-3-dev \ libssl-dev \ libxcb-render0-dev \ libxcb-shape0-dev \ libxcb-xfixes0-dev \ libxkbcommon-dev \ patchelfFedora Rawhide 系统依赖sudo dnf install \ clang \ clang-devel \ clang-tools-extra \ libxcb-devel \ libxkbcommon-devel \ openssl-devel \ pkg-configWayland 窗口管理器兼容问题在 Wayland 窗口管理器下运行 Rerun 有时会导致崩溃官方 issue 跟踪中可尝试以下变通方案unset WAYLAND_DISPLAY # 或 WAYLAND_DISPLAYUbuntu 24 上也观察到 Wayland 相关问题可额外安装兼容库并同样取消 Wayland displaysudo apt install libxkbcommon-x11-0WSL2Ubuntu图形环境WSL 自带的图形驱动无法开箱即用需要更新到较新版本。安装最新稳定版 Mesa Vulkan 驱动sudo add-apt-repository ppa:kisak/kisak-mesa sudo apt-get update sudo apt-get install -y mesa-vulkan-drivers由于 WSL 上的 Mesa 驱动会转发到 Windows 宿主机的图形驱动务必保持 Windows 驱动为最新例如已观察到 Windows 侧 AMD 驱动过旧时在 WSL 中运行会出现线条渲染问题官方 issue 记录。pip 安装失败找不到 rerun-sdk如果执行pip install rerun-sdk或pip install rerun-notebook时报错ERROR: Could not find a version that satisfies the requirement rerun-sdk (from versions: none) ERROR: No matching distribution found for rerun-sdk这通常意味着pip 版本过旧。先用pip --version检查版本若为 pip 20 或更早升级即可pip install --upgrade pip[!WARNING] 视系统配置而定升级命令可能升级的是pip3别名对应的 pip 安装而非pip对应的那个。启动问题重置 Viewer 内存如果 Rerun 启动异常可尝试重置其持久化内存rerun reset图形问题渲染后端与驱动首先确保图形驱动保持最新。Rerun 的图形渲染基于Wgpure_viewer依赖eframe的wgpu特性见 re_viewer/Cargo.tomlWgpu 维护了一份已知驱动问题与规避方案清单。Wgpu 的配置可通过以下方式干预--rendererbackend启动参数backend必须是vulkan、metal或gl原生 Viewer或webgl、webgpuWeb Viewer配合--web-viewer参数。默认后端在除 macOS 外均为vulkanmacOS 使用metalWeb 端优先 WebGPU检测不到时自动回退 WebGL。例如rerun --rendererglWeb Viewer 则为rerun --web-viewer --rendererwebgl原生 Viewer 也可用环境变量WGPU_BACKEND指定同样的取值Web Viewer 通过 URL 参数rendererbackend配置。WGPU_POWER_PREF覆盖图形适配器选择的功耗偏好取值必须为high或low默认high。这些设置在源码中有直接对应rerun二进制的 wgpu 配置由 crates/top/re_viewer/src/lib.rs 的wgpu_options与customize_eframe_and_setup_renderer负责组装其中instance_descriptor依据force_wgpu_backend决定可用的后端集合Web 端则在 crates/top/re_viewer/src/web.rs 的AppOptions中通过render_backend、video_decoder等字段接收 URL 参数该结构需与 rerun_js/web-viewer/index.ts 的接口保持同步。[!NOTE] 官方建议仅在被告知尝试或明确知道自己在做什么时才修改这些设置因为并非所有配置都得到同等程度的支持。多 GPU 环境强制指定显卡在使用 Wgpu 的 Vulkan 后端Windows 与 Linux 默认且机器同时具有集显与独显时Vulkan 可能运行时选错 GPU或与其他驱动选择技术如 NVIDIA Optimus冲突导致崩溃、渲染 artifacts 或性能下降。可尝试用VK_ICD_FILENAMES环境变量强制 Vulkan 选择集显或独显两种都可以试试# 强制 Intel 集显Linux export VK_ICD_FILENAMES/usr/share/vulkan/icd.d/intel.json # 强制 NVIDIA 独显Linux export VK_ICD_FILENAMES/usr/share/vulkan/icd.d/nvidia.json # 强制 NVIDIA 独显Windows set VK_ICD_FILENAMES\windows\system32\nv-vk64.json视频卡顿强制软件解码部分浏览器默认的视频解码器可能导致卡顿例如 Windows 上的 Chrome 129 曾出现此问题。可以通过 Viewer 的选项菜单配置软件解码也可以在启动时覆盖Web ViewerURL 参数加video_decoderprefer_software原生 Viewer以及通过命令行--web-viewer启动的 Web Viewer传--video-decoderprefer_software。关于 Rerun 的视频解码与编码方式Image、EncodedImage、AssetVideo、VideoStream等不同选择在画质与体积之间的权衡可参考 视频解码概念文档。安装之后下一步怎么走环境就绪后官方推荐的路径是搭建项目Python 无需额外配置即可import rerun as rrRust 执行cargo newcargo add rerunC 编写最小CMakeLists.txt。对应文档见 Python 项目配置、Rust 项目配置、C 项目配置记录第一批数据跟随 Log and Ingest 教程用几十行代码完成从点云、线段到带时间轴的动画场景该教程还覆盖了通过 gRPC 联网传输数据Viewer 默认监听0.0.0.0:9876SDK 侧用connect_grpc连接、通过save将数据流写入.rrd文件以及 Rust 进程内嵌 Viewer 等进阶用法直接打开已有文件Viewer 可打开 RRD、MCAP、图片、视频、点云等格式详见 打开任意文件熟悉界面首次启动后可通过 Viewer 总览 了解 Blueprint、Selection、Timeline、Viewport 四大面板与命令面板Ctrl/Cmd P的使用方式。【免费下载链接】rerunVisualize, query, and stream to train on multimodal robotics data.项目地址: https://gitcode.com/GitHub_Trending/re/rerun创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表