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.4.tar.gz (30.5 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.4-py3-none-any.whl (41.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gaussian_renderer-0.1.4.tar.gz
  • Upload date:
  • Size: 30.5 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.4.tar.gz
Algorithm Hash digest
SHA256 a438fdb3cb4df6eec944d79dd09a99f3684d879f95814d1901d07606adabe6e9
MD5 90c548d098db9bcb07699bb1c4b18f6f
BLAKE2b-256 8d81a119732d4526604dac713fc967caacb5c3fa245b9fd0f2699255deda4178

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for gaussian_renderer-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 527c9bc880a0d9296df6813ef829db8f2f90c0ec2001bfd6dd5fd6e4abe8e4c3
MD5 86d70b5be4d4cc65cd5dbf64cb90407b
BLAKE2b-256 5ae44bdc89c9f3047fd39f76b599449d4f178d7605945378def083369414f581

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