Skip to content
A protocol for real-time transfer and visualization of autonomy data
Branch: master
Clone or download
Latest commit 8057767 Apr 23, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.buildkite Update buildkite agent queues (#426) Apr 12, 2019
docs [builder] Add links from documentation to playground (#423) Apr 6, 2019
examples Update readme.md for the streaming server example (#381) Feb 28, 2019
flow-typed
ide Emacs specific settings (#47) Sep 4, 2018
modules v1.0.0-beta.8 Apr 23, 2019
scripts Add git hook to add copyright on js & sh files if missing (#344) Feb 22, 2019
test Upgrade loaders.gl to v1 (#429) Apr 23, 2019
website Merge pull request #376 from uber/jlisee/xviz-cli-docs Feb 28, 2019
.eslintignore
.eslintrc Fix test coverage (#62) Sep 6, 2018
.flowconfig initial commit Aug 7, 2018
.gitattributes
.gitignore Docs and gitignore cleanups (#308) Feb 7, 2019
.nycrc Move to using @loaders.gl for glTF handling (#318) Feb 14, 2019
.prettierignore Move converter and server examples from streetscape (#237) Dec 6, 2018
.prettierrc Lint website and part of docs with prettier (#154) Oct 19, 2018
CHANGELOG.md v1.0.0-beta.8 Apr 23, 2019
CREDITS.md Add clear banner image to README (#319) Feb 15, 2019
Dockerfile
LICENSE
README.md
aliases.js Make schema validators work in the browser (#322) Feb 16, 2019
babel.config.js xviztool and middleware framework (#290) Jan 28, 2019
docker-compose.yml Implement Buildkite for CI (#80) Sep 12, 2018
lerna.json
package.json Upgrade probe.gl (#427) Apr 22, 2019
yarn.lock Upgrade loaders.gl to v1 (#429) Apr 23, 2019

README.md

XVIZ

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/parser - Client-side decoder and synchronizer for consuming XVIZ data.
  • @xviz/schema - Validation and schemas for the XVIZ protocol.

And examples:

  • Sample converters that convert open datasets such as KITTI and Nutonomy to the XVIZ protocol.
  • A minimal Node.js-based XVIZ stream server.

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
You can’t perform that action at this time.