Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/aurora-opensource/xviz

A protocol for real-time transfer and visualization of autonomy data
https://github.com/aurora-opensource/xviz

3d protocol robotics self-driving-car

Last synced: about 2 months ago
JSON representation

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

Host: GitHub
URL: https://github.com/aurora-opensource/xviz
Owner: aurora-opensource
License: apache-2.0
Created: 2018-07-11T18:27:10.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2023-07-18T20:19:50.000Z (about 1 year ago)
Last Synced: 2024-04-13T13:06:43.000Z (6 months ago)
Topics: 3d, protocol, robotics, self-driving-car
Language: JavaScript
Homepage: http://xviz.io
Size: 9.7 MB
Stars: 986
Watchers: 56
Forks: 225
Open Issues: 171
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

awesome-robotic-tooling - xviz - A protocol for real-time transfer and visualization of autonomy data (Interaction / Storage and Record)

README

# XVIZ

[![Coverage Status](https://coveralls.io/repos/github/uber/xviz/badge.svg?branch=master)](https://coveralls.io/github/uber/xviz?branch=master)

XVIZ is a protocol for real-time transfer and visualization of autonomy data. Learn more in the
[docs and specification](http://avs.auto/#/xviz).

![High Level Overview](docs/overview/images/high-level.png)

## 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](http://www.cvlibs.net/datasets/kitti/raw_data.php) and [Nutonomy](https://nuscenes.org) to
the XVIZ protocol.

## Quick start

You need [Node.js](https://nodejs.org/en/) and [yarn](https://yarnpkg.com/lang/en/docs/install) to
run the examples.

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

# Install dependencies
$ yarn bootstrap
```

Convert and serve KITTI example data:

```bash
# 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
```