Tutorial

Getting Started with Splatkit

A simple tutorial to help you create your first dynamic gaussian splat in minutes

Installation

Choose your preferred package manager and install Splatkit

Step 1: Install via pip
Install the Splatkit Python package using pip
$ pip install splats
Step 2: Create your first splat
Generate a gaussian splat from your capture directory
$ splats create ./splat_capture
✓ output.dgs

This command will process your capture directory and generate a dynamic gaussian splat file (output.dgs)

Tutorial Steps

Follow these steps to create your first dynamic gaussian splat

1
Prepare Your Capture Data
Organize your images or video capture into a directory. The data should contain multiple views of the scene you want to create a gaussian splat from.
2
Run the Create Command
Use the splats create command with your capture directory to generate the gaussian splat file. The tool will automatically process your data using state-of-the-art techniques.
3
View and Share
Use the play command (npm) or open your .dgs file in a viewer to see your creation. You can now share your dynamic gaussian splat with others.

Next Steps

Continue your journey with Splatkit

Read the Documentation
Dive deeper into the technical details and explore advanced features
Explore Examples
See what others have created and get inspired for your own projects