| layout | default |
|---|---|
| title | Documentation Index |
Welcome to the Optiverse documentation! This directory contains comprehensive guides for users and developers.
- macOS Installation Guide
Step-by-step instructions for setting up Optiverse on macOS with native app bundle support.
-
Component Editor: Interface Color Guide
Learn how optical interfaces are color-coded in the component editor for easy identification. -
Component Editor: Refractive Index Labels
Understanding how refractive index labels (n₁, n₂) are displayed and used in the component editor. -
Component Editor: Ruler Visual Guide
Visual guide to using rulers and coordinate systems in the component editor.
-
Zemax Import Guide
Complete guide to importing optical designs from Zemax (.zmx) files into Optiverse. -
Collaboration Guide
Real-time collaborative editing with multiple users via WebSocket connections. -
Inspect Tool
How to use the inspect (eyedropper) tool to view detailed ray properties.
-
Raytracing Physics ⭐
Comprehensive mathematical description of raytracing algorithms, Snell's law, Fresnel equations, thin lens approximation, and optical interface structure. Includes detailed equations and derivations. -
Dichroic Mirrors and Wavelength System
Implementation details for wavelength-dependent optical elements and color representation. -
Polarizing Interfaces
Architecture and usage of polarization-modifying optical elements (waveplates, polarizers). -
Waveplate Directionality
Physics implementation of directional waveplate behavior and polarization transformations.
-
Unified Interface System
Design document explaining the unified interface-based component system. -
Testing Architecture
Comprehensive guide to the testing framework, patterns, and best practices. -
Error Handling System
Documentation for the global error handling system and error management patterns. -
Error Handling Quick Reference
Quick reference code examples for using the error handling system. -
Logging System
Guide to using the centralized logging system and log window.
-
Parallel Raytracing
Numba JIT compilation and threading optimizations for 4-8x raytracing speedup. -
macOS Trackpad Optimization
Mac-specific performance improvements and native trackpad gesture support.
- Start with macOS Installation Guide (if on Mac)
- Learn about Component Editor features
- Try importing a Zemax file
- Read Testing Architecture for testing guidelines
- Understand Unified Interface System architecture
- Review Error Handling for error management patterns
- Explore Polarizing Interfaces for polarization optics
- Understand Waveplate Directionality physics
- Learn about Dichroic Mirrors and wavelength systems
Installation & Setup
- macOS: MACOS_SETUP.md
Component Editor
Import/Export
Collaboration
Physics & Optics
Development
Performance
When adding new documentation:
- User Guides: Focus on step-by-step instructions with examples
- Architecture Docs: Explain design decisions and system structure
- API Docs: Include code examples and usage patterns
- Update this index: Add new files to the appropriate section above
- Main README - Project overview and quick start
- GitHub Repository - Source code and issues
- Examples - Example assemblies and demos
Last updated: Documentation organized and cleaned up for GitHub Pages