Skip to main content

A Gaussian Splatting Renderer and Tools

Project description

Gaussian Renderer

A Gaussian Splatting Renderer and Tools package.

中文文档

This repository primarily provides rendering capabilities for Gaussian Splatting models. It is developed as a component of the DISCOVERSE project.

For detailed usage of the renderer within the simulation environment, please refer to: https://github.com/TATP-233/DISCOVERSE

Installation

Basic Installation

To install the core package (without viewer dependencies):

pip install gaussian-renderer

Or from source:

git clone https://github.com/TATP-233/GaussainRenderer.git
cd GaussainRenderer
pip install .

With Viewer Support

To install with viewer dependencies (glfw, PyOpenGL):

pip install ".[viewer]"

Usage

This package provides three command-line tools:

1. Simple Viewer (gs-viewer)

A simple OpenGL-based viewer for Gaussian Splatting models (.ply files).

Usage:

# Open a specific model
gs-viewer path/to/model.ply

# Or just run and drag-drop files
gs-viewer

Controls:

  • Left Mouse: Rotate
  • Right/Middle Mouse: Pan
  • Scroll: Zoom
  • Up/Down Key: Adjust SH Degree
  • Drag & Drop: Load PLY file

2. SuperSplat Compressor (gs-compress)

Compress 3DGS PLY models to the SuperSplat format.

Usage:

# Compress a single file
gs-compress input.ply

# Specify output file
gs-compress input.ply -o output.ply

# Batch compress a directory
gs-compress models/

3. Model Transformer (gs-transform)

Apply transformations (translation, rotation, scaling) to Gaussian Splatting models.

Usage:

# Basic transformation
gs-transform input.ply -o output.ply -t 0 1 0 -s 2.0

# Rotate (quaternion xyzw)
gs-transform input.ply -r 0 0 0 1

# Options:
# -t x y z      : Translation vector
# -r x y z w    : Rotation quaternion
# -s scale      : Scale factor
# --compress    : Save as compressed PLY

Python API

You can also use the tools as Python modules:

python -m gaussian_renderer.simple_viewer path/to/model.ply
python -m gaussian_renderer.supersplat_compress input.ply
python -m gaussian_renderer.transform_gs_model input.ply

Citation

If you find this package helpful, please consider citing our work:

@article{jia2025discoverse,
      title={DISCOVERSE: Efficient Robot Simulation in Complex High-Fidelity Environments},
      author={Yufei Jia and Guangyu Wang and Yuhang Dong and Junzhe Wu and Yupei Zeng and Haonan Lin and Zifan Wang and Haizhou Ge and Weibin Gu and Chuxuan Li and Ziming Wang and Yunjie Cheng and Wei Sui and Ruqi Huang and Guyue Zhou},
      journal={arXiv preprint arXiv:2507.21981},
      year={2025},
      url={https://arxiv.org/abs/2507.21981}
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gaussian_renderer-0.1.5.tar.gz (30.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gaussian_renderer-0.1.5-py3-none-any.whl (41.7 kB view details)

Uploaded Python 3

File details

Details for the file gaussian_renderer-0.1.5.tar.gz.

File metadata

  • Download URL: gaussian_renderer-0.1.5.tar.gz
  • Upload date:
  • Size: 30.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.16

File hashes

Hashes for gaussian_renderer-0.1.5.tar.gz
Algorithm Hash digest
SHA256 503c2af37b8d0b53bf6d757c1011adfe4b2a230e0f181ac07636e3d3df10ff5f
MD5 b110b967b95e2cb950264164bfaf2bf2
BLAKE2b-256 328fc2e2925e02eef7185d421c03b406f2989a989be1755eaa724bee851f4c6d

See more details on using hashes here.

File details

Details for the file gaussian_renderer-0.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for gaussian_renderer-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 2956b2066a277a6f3de8607474a0f768af6e59732d45b8c1332197039b6f9891
MD5 100df9331275c8b7be060099c9f1c73a
BLAKE2b-256 9711152c5d67ddb9374eaad33aeafb073ddb5fd19984e9d3f69154d837fd4d6a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page