Repository navigation
v0.9.1 - Python 3.13 Compatibility, Documentation & UX
█▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀█
█ ░█▀▄░█▀▀░█▀█░▀█▀░█░█░░░█▀▀░█░█░█▀▄░█▀▀░█▀▀░░░▀▀█░█▀▄░ █
█ ░█░█░█▀▀░█▀▀░░█░░█▀█░░░▀▀█░█░█░█▀▄░█░█░█▀▀░░░░▀▄░█░█░ █
█ ░▀▀░░▀▀▀░▀░░░░▀░░▀░▀░░░▀▀▀░▀▀▀░▀░▀░▀▀▀░▀▀▀░░░▀▀░░▀▀░░ █
█▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄█
🐍 Python 3.13 Compatibility
Fixed Python 3.13 compatibility issue caused by `open3d` dependency in Depth-Anything V3:
- Version guard: Added `requires-python = ">=3.9,<3.13"` in `pyproject.toml`
- Runtime check: Clear error message with GitHub issue link for users on Python 3.13+
- Compilation guide: Added comprehensive 161-line guide for advanced users who need Python 3.13
- Step-by-step instructions for Ubuntu/Debian, macOS, and Windows
- CMake and C++14 compiler requirements documented
- Troubleshooting section with common build errors
Closes: #11
📚 Documentation Improvements
VR Headset Compatibility Guide (NEW)
Comprehensive 538-line guide covering the top 10 VR headsets by market share:
- Headsets covered: Meta Quest 2/3/3S/Pro, PlayStation VR2, Valve Index, HTC Vive/Pro 2, Pico 4
- Per-device specs: Resolution per eye, IPD range, FOV, refresh rates
- Recommended CLI settings: Optimal parameters for each device
- IPD measurement guide: How to measure and configure interpupillary distance
- Official sources: Meta, Sony, Valve, HTC, Pico documentation
Performance Benchmarks Guide (NEW)
Comprehensive 597-line performance reference:
- GPU benchmarks: RTX 4070 Ti SUPER baseline with processing times
- V2 vs V3 comparison: Detailed speed and VRAM usage tables
- Resolution scaling: 720p, 1080p, 1440p, 4K processing times
- VRAM patterns: Memory usage by model size and resolution
- GPU performance tiers: High-end, mid-range, entry-level recommendations
- Optimization guide: 8 tips for faster processing with CLI examples
- Reference table: 25+ GPU models with VRAM and expected performance
🎨 UX Improvements
Colored Completion Banner (NEW)
Beautiful terminal banner when processing finishes:
```
══════════════════════════════════════════════════════════════════════
✓ PROCESSING COMPLETE
──────────────────────────────────────────────────────────────────
Output: /path/to/output/video_3D_side_by_side.mp4
Format: side_by_side
Frames: 300
Time: 2h 15m 30s
══════════════════════════════════════════════════════════════════════
```
- Lime green borders (#39ff14) matching UI theme
- Electric blue file path highlighting (#00d9ff)
- Human-readable time: Formats as "1h 23m 45s" instead of raw seconds
- Processing metrics: Frame count, VR format, output path
- Saved to settings.json: Processing time tracked for batch analysis
🧹 Technical Improvements
Error Handling Standardization
- Moved inline `import traceback` to module-level imports (5 files)
- Consistent exception handling patterns across all modules
- Specific exceptions where appropriate, broad catches for resilience
TODO Reorganization
- Created `docs/archive/completed-tasks.md` for v0.9.0-v0.9.1 history
- Moved `TODO.md` to root directory
- Simplified roadmap to show only v0.10.0+ future enhancements
- Removed legacy model references (MiDaS, ZoeDepth won't be added)
📊 Test Coverage
- 745 unit tests (+14 new console tests)
- 91% coverage (up from 90.41%)
- 100% coverage: console.py, vram_manager.py, depth_cache.py, image_processing.py
- All pre-commit checks passing (Black, Flake8, Mypy)
🔧 Installation
```bash
Python 3.9-3.12 required (NOT 3.13+)
pip install depth-surge-3d
Or from source
git clone https://github.com/Tok/depth-surge-3d.git
cd depth-surge-3d
./setup.sh
```
📖 Full Changelog
Python Compatibility:
- fix: add Python 3.13 compatibility guard (#11)
- docs: add advanced Python 3.13 compilation guide
Documentation:
- docs: add comprehensive VR headset compatibility guide
- docs: add comprehensive performance benchmarks guide
UX Improvements:
- feat: add colored completion banner with processing summary
- feat: implement RGB lerp gradient with diagonal flow and stretched margins
- feat: add balancing column after 3D in banner for symmetry
- refactor: apply gradient to entire banner and increase stretch margin
- feat: use brand lime color (#39ff14) for authentic gradient
Technical Improvements:
- refactor: standardize error handling and archive TODO
- feat: add colored completion banner and reorganize TODO
- test: add comprehensive console output tests (100% coverage)
🙏 Credits
Thanks to the community for feedback and issue reports!
🤖 Generated with Claude Sonnet 4.5