Welcome to Prismo’s documentation!

Prismo is a high-performance Python-based FDTD (Finite-Difference Time-Domain) solver specifically designed for waveguide photonics simulations.

Quick Links

• Quick Start - Get started in 5 minutes

• Tutorials - Step-by-step tutorials

• API Reference - Complete API reference

• Examples - Example simulations

Key Features

• High Performance: GPU acceleration with CuPy, vectorized NumPy operations

• Waveguide-Optimized: Built-in mode solver, mode sources, S-parameter extraction

• Easy to Use: Intuitive API, comprehensive documentation

• Extensible: Plugin architecture, custom sources and monitors

• Well-Tested: Extensive validation against analytical solutions

Table of Contents

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
• Tutorials
  • Tutorial Overview
  • What You’ll Learn
  • Prerequisites
  • Tutorial Format
  • Getting Help

User Guide

• User Guide
  • Getting Started
  • Core Concepts
  • Advanced Features
  • Analysis and Output
• Examples
  • Overview
  • TFSF Plane Wave Example
  • Basic Waveguide Example
  • Plane Wave Validation Example
  • Common Patterns
  • Running Examples
  • Next Steps

API Reference

• API Reference
  • Backends API
  • Solvers API
  • Materials API
  • Boundaries API
  • Sources API
  • Monitors API
  • Mode Solver API
  • Analysis API
  • Input/Output API
  • Optimization API
  • Geometry API

Developer Documentation

• Developer Guide
  • Overview
  • Getting Started
  • Contents
  • Additional Resources

Indices and tables

• Index

• Module Index

• Search Page

Community

• GitHub: https://github.com/rithulkamesh/prismo

• Issues: Report bugs or request features

• Discussions: Ask questions and share ideas

License

Prismo is released under the MIT License. See the LICENSE file for details.