xviz

A protocol for real-time transfer and visualization of autonomy data

Github stars Tracking Chart

XVIZ

Coverage Status

XVIZ is a protocol for real-time transfer and visualization of autonomy data. Learn more in the
docs and specification.

High Level Overview

Tools and examples

This repo contains the following submodules:

  • @xviz/builder - Node.js utilities for converting data to the XVIZ protocol.
  • @xviz/cli - CLI utilities for the XVIZ protocol.
  • @xviz/io - Library for loading, accessing, and manipulating XVIZ data.
  • @xviz/parser - Client-side decoder and synchronizer for consuming XVIZ data.
  • @xviz/schema - Validation and schemas for the XVIZ protocol.
  • @xviz/server - A complete server module supporting the full XVIZ protocol.

And examples:

  • Sample converters that convert open datasets such as
    KITTI and Nutonomy to
    the XVIZ protocol.

Quick start

You need Node.js and yarn to
run the examples.

# Clone XVIZ
$ git clone https://github.com/uber/xviz.git
$ cd xviz

# Install dependencies
$ yarn bootstrap

Convert and serve KITTI example data:

# Download KITTI data
$ ./scripts/download-kitti-data.sh

# Convert KITTI data if necessary and run the XVIZ Server and Client
$ ./scripts/run-kitti-example.sh

NPM Scripts

  • bootstrap - install dependencies
  • build - rebuild all modules
  • test - run full tests (lint, unit tests in node and headless browser)
  • test bench, bench - run benchmark tests
  • test bench-browser - run benchmark tests in browser
  • test node - run unit tests in Node
  • test browser - run tests in browser
  • test browser-headless - run tests in headless browser
  • lint - run lint
  • lint fix - run prettier
  • publish beta - publish beta release
  • publish prod - publish production release

Requirements for Contribution

The pre-commit hook yarn test-fast requires you to have jq installed:

brew install jq

Main metrics

Overview
Name With Owneraurora-opensource/xviz
Primary LanguageJavaScript
Program languageShell (Language Count: 5)
Platform
License:Apache License 2.0
所有者活动
Created At2018-07-11 18:27:10
Pushed At2024-07-05 18:03:23
Last Commit At2024-07-05 11:03:23
Release Count58
Last Release Namev1.0.13 (Posted on 2022-06-02 20:05:06)
First Release Namev2.0.0-alpha (Posted on 2018-08-15 13:19:38)
用户参与
Stargazers Count1k
Watchers Count55
Fork Count230
Commits Count429
Has Issues Enabled
Issues Count303
Issue Open Count143
Pull Requests Count345
Pull Requests Open Count29
Pull Requests Close Count58
项目设置
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private