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 within the simulation environment, see: https://github.com/TATP-233/DISCOVERSE

Requirements

Python >= 3.10

Installation

uv add gaussian-renderer
# or: pip install gaussian-renderer

From source:

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

Optional extras

uv add "gaussian-renderer[viewer]"   # OpenGL viewer (glfw, PyOpenGL)
uv add "gaussian-renderer[mujoco]"   # MuJoCo integration
uv add "gaussian-renderer[motrix]"   # MotrixSim integration

# Combine as needed
uv add "gaussian-renderer[viewer,mujoco]"
# or: pip install ".[viewer,mujoco]"

Usage

Command-line tools

gs-viewer — OpenGL viewer for .ply models

gs-viewer path/to/model.ply

Controls: Left mouse = rotate, Right/Middle = pan, Scroll = zoom, Up/Down = SH degree, Drag & drop = load file

gs-compress — Compress 3DGS PLY to SuperSplat format

gs-compress input.ply
gs-compress input.ply -o output.ply
gs-compress models/          # batch

gs-transform — Apply translation/rotation/scale to a model

gs-transform input.ply -o output.ply -t 0 1 0 -s 2.0
gs-transform input.ply -r 0 0 0 1   # rotation quaternion xyzw
# --compress: save as compressed PLY

Python API

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

Development

uv pip install ".[dev]"
# or: pip install ".[dev]"
make lint       # ruff check
make format     # ruff format
make typecheck  # mypy
make test       # pytest
make ci         # all of the above

Citation

@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.2.0.tar.gz (33.4 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.2.0-py3-none-any.whl (43.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gaussian_renderer-0.2.0.tar.gz
  • Upload date:
  • Size: 33.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.9 {"installer":{"name":"uv","version":"0.10.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"22.04","id":"jammy","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for gaussian_renderer-0.2.0.tar.gz
Algorithm Hash digest
SHA256 a5068d1b58cd174d315a591cdc6e2c26b271306074a8d11cdd02c60bbe58b7de
MD5 129b8418a706a699727b90f355ee4ad4
BLAKE2b-256 f48983023e3e019aa4143d96d6fc01487d4790940e98c202f27d1ae232ddba77

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gaussian_renderer-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 43.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.9 {"installer":{"name":"uv","version":"0.10.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"22.04","id":"jammy","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for gaussian_renderer-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a22e9690ceb9aa1d945bf6d2b6c56e55cbee8eb3d8fd554c8e025e2eee642f1a
MD5 bad2f74b5e23946db0141fbc21766ded
BLAKE2b-256 402b7b3d5e49f8e79672ce1db0ecdfedca2e15f89cbbdc11ca3561fee94c2d9f

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