User Guide

This guide will help you get started with Prismo and learn how to use its various features for FDTD simulations of photonic waveguides.

Getting Started

• Installation
  • Requirements
  • Installation from PyPI (Recommended)
  • Installation from Source
  • Verifying Installation
  • Running Tests
  • Optional Dependencies
  • Troubleshooting
  • Next Steps
• Quick Start
  • Your First Simulation
  • Understanding the Output
  • Basic Visualization
  • Key Concepts
  • Common Patterns
  • Complete Example Scripts
  • Next Steps
  • Troubleshooting

Core Concepts

• Simulations
  • The Simulation Class
  • Grid Setup
  • Boundary Conditions
  • Time Stepping
  • Simulation Workflow
  • Advanced Configuration
  • Performance Optimization
  • Numerical Stability
  • Best Practices
  • Troubleshooting
  • Next Steps
• Sources and Monitors
  • Overview
  • Sources
  • Waveforms
  • Monitors
  • Best Practices
  • Advanced Topics
  • Examples
  • Next Steps
• Boundary Conditions
  • Overview
  • PML (Perfectly Matched Layer)
  • Periodic Boundaries
  • Perfect Conductors
  • Symmetry Boundaries
  • Mixed Boundaries
  • Choosing the Right Boundary
  • Common Issues and Solutions
  • Performance Considerations
  • Validation Tests
  • See Also
• Materials and Dispersion
  • Material Library
  • Dispersion Models
  • Anisotropic Materials
  • Time-Domain Integration

Advanced Features

• Waveguide Mode Analysis
  • Overview
  • Basic Mode Solving
  • Mode Types
  • Using Modes in Simulations
  • Mode-Based S-Parameters
  • Tips
• Mode Ports
  • Overview
  • Basic Workflow
  • Advanced Features
  • Using ModePort Boundary Condition
  • Validation and Best Practices
  • Complete Example
  • See Also
• GPU Acceleration
  • Backend Selection
  • Performance
  • Installation
  • Usage in Simulations
  • Memory Management
  • Best Practices
• Advanced Features
  • Frequency-Domain Monitors
  • Mode Solver
  • S-Parameter Extraction
  • Data Export
  • Parameter Sweeps
  • Lumerical Import

Analysis and Output

• Data Export and Analysis
  • Export Formats
  • CSV Export
  • Parquet Export
  • Touchstone Export
  • Metadata
  • Best Practices
• Visualization
  • Field Visualization
  • Spectrum Visualization
  • Using Polars for Analysis
  • Animation
• Simulation Validation
  • Why Validate?
  • Validation Hierarchy
  • 1. Basic Sanity Checks
  • 2. Analytical Validation
  • 3. Convergence Tests
  • 4. Physical Consistency Checks
  • 5. Common Validation Examples
  • Validation Checklist
  • Automated Validation Script
  • When to Suspect Problems
  • See Also