PhotoSplat3D

https://github.com/zlinoliver/photosplat3d
Admin
PhotoSplat3D is a desktop application that turns 2D photos into 3D Gaussian Splat models instantly...
Tokens:1,484
Snippets:31
Trust Score:7.8
License:MIT
Update:2 months ago
Show doc for...
Tokens:
Raw
### Manual Installation

Source: https://github.com/zlinoliver/photosplat3d/blob/main/README.md

Manually configure the virtual environment and install dependencies from requirements.txt.

```bash
python3 -m venv venv
source venv/bin/activate
pip install --upgrade pip
pip install -r requirements.txt
pip install -e .
```

--------------------------------

### Automated Installation

Source: https://github.com/zlinoliver/photosplat3d/blob/main/README.md

Use the bootstrap script to handle virtual environment creation and dependency installation automatically.

```bash
git clone https://github.com/zlinoliver/PhotoSplat3D.git
cd ml-sharp
bash scripts/bootstrap.sh
```

--------------------------------

### Install Project Dependencies

Source: https://github.com/zlinoliver/photosplat3d/blob/main/CONTRIBUTING.md

Install the required Python packages listed in the requirements file.

```bash
pip install -r requirements.txt
```

--------------------------------

### Verify Environment

Source: https://github.com/zlinoliver/photosplat3d/blob/main/README.md

Check that Git, Python, venv, and tkinter are correctly installed and available in your environment.

```bash
git --version
python3 --version
python3 -m venv --help
python3 -m tkinter
```

--------------------------------

### Launch GUI Application

Source: https://github.com/zlinoliver/photosplat3d/blob/main/README.md

Start the graphical user interface using the CLI command or the Python module launcher.

```bash
sharp gui
```

```bash
PYTHONPATH=src python3 -m sharp.gui.launcher
```

--------------------------------

### CLI Prediction Examples

Source: https://github.com/zlinoliver/photosplat3d/blob/main/README.md

Common usage patterns for the predict command, including panorama detection and hardware acceleration.

```bash
# Auto-detect panoramas
sharp predict -i photos/ -o output/ --panorama auto

# Force 360° panorama with Ring8 strategy
sharp predict -i pano.jpg -o output/ --panorama 360 --panorama-strategy ring8

# Use CUDA and render preview
sharp predict -i input/ -o output/ --device cuda --render
```

--------------------------------

### Build Desktop Application

Source: https://github.com/zlinoliver/photosplat3d/blob/main/README.md

Commands to bootstrap the environment and build the standalone macOS application.

```bash
bash scripts/bootstrap.sh
source venv/bin/activate
python build_release.py --mode full
```

--------------------------------

### Command Line Interface Operations

Source: https://github.com/zlinoliver/photosplat3d/blob/main/README.md

Use the CLI to generate 3D models from images or render trajectory videos.

```bash
# Generate 3D .ply from image(s)
sharp predict -i input/ -o output/

# Render trajectory video (requires CUDA)
sharp render -i output/ -o output/renderings/
```

--------------------------------

### Project Directory Structure

Source: https://github.com/zlinoliver/photosplat3d/blob/main/README.md

Overview of the project file organization.

```text
ml-sharp/
├── src/sharp/
│   ├── cli/          # Command-line interface (predict, render, gui)
│   ├── gui/          # Desktop GUI application
│   ├── models/       # SHARP model definitions
│   └── utils/        # I/O, camera, Gaussian, rendering utilities
├── scripts/          # Setup and build scripts
└── requirements.txt  # Python dependencies
```

--------------------------------

### CLI Usage Syntax

Source: https://github.com/zlinoliver/photosplat3d/blob/main/README.md

Basic command structure for the sharp predict command.

```bash
sharp predict -i INPUT -o OUTPUT [OPTIONS]
```

--------------------------------

### Run Code Quality Checks

Source: https://github.com/zlinoliver/photosplat3d/blob/main/CONTRIBUTING.md

Execute linting and formatting checks using ruff before submitting changes.

```bash
ruff check src
ruff format src
```
Tokens:
Raw