RSoft PLTools

Contents:

  • Installation Guide
    • Prerequisites
    • Installation Methods
      • Method 1: Development Installation (Recommended)
      • Method 2: Direct Installation
    • Dependencies
    • Verification
    • RSoft CAD Configuration
    • Development Setup
    • Troubleshooting
      • Common Issues
      • Getting Help
    • Next Steps
  • Quick Start Guide
    • Basic Concepts
    • Your First Photonic Lantern
      • 1. Create a Simple Photonic Lantern
      • 2. Run a Simulation
      • 3. Analyze Results
    • Mode Selective Lantern Example
    • Parameter Sweeps
    • Configuration Management
    • Visualization
    • Command Line Interface
    • Common Patterns
      • 1. Design → Simulate → Analyze Workflow
      • 2. Batch Processing
    • Next Steps
    • Need Help?
  • Tutorials
    • Tutorial 1: Designing Your First Photonic Lantern
      • Overview
      • Step 1: Understanding the Configuration
      • Step 2: Create the Lantern
      • Step 3: Add Launch Conditions
      • Step 4: Run Simulation
    • Tutorial 2: Mode Selective Lantern Design
      • Overview
      • Step 1: Mode Analysis
      • Step 2: Create Mode Selective Lantern
      • Step 3: Optimization Loop
    • Tutorial 3: Parameter Sweep Analysis
      • Overview
      • Step 1: Define Parameter Space
      • Step 2: Execute Parameter Sweep
      • Step 3: Analyze and Visualize Results
    • Tutorial 4: Effective Index Analysis
      • Overview
      • Step 1: Set Up FemSIM Simulation
      • Step 2: Process and Visualize Results
      • Step 3: Mode Coupling Analysis
    • Tutorial 5: Custom Taper Design
      • Overview
      • Step 1: Define Custom Taper Function
      • Step 2: Apply to Lantern Design
    • Tutorial 6: Advanced Visualization
      • Overview
      • Step 1: Field Distribution Plots
      • Step 2: Animation of Field Propagation
    • Next Steps
    • Common Troubleshooting
      • Simulation Failures
      • Memory Issues
      • Convergence Problems
  • Examples
    • Basic Photonic Lantern Creation
      • Simple Photonic Lantern
      • Mode Selective Lantern
    • Configuration Management
      • Custom Configuration
    • Simulation and Analysis
      • Running BeamPROP Simulation
      • Parameter Sweep
      • Analyzing Results
    • Effective Index Analysis with FemSIM
      • FemSIM Simulation
      • Visualizing Effective Index Data
    • Layout Visualization
      • Fiber Layout Visualization
    • Command Line Interface Examples
      • FemSIM Parameter Scan
      • Plotting Effective Index Results
    • Advanced Examples
      • Custom Taper Profile
      • Batch Processing Multiple Configurations
    • Integration with External Tools
      • Exporting to Other Formats
    • Tips for Success
  • API Reference
    • Core Modules
      • rsoft_cad.lantern
        • PhotonicLantern
        • ModeSelectiveLantern
      • rsoft_cad.rsoft_circuit
        • RSoftCircuit
      • rsoft_cad.rsoft_simulations
        • Functions
      • rsoft_cad.beamprop
        • Main Functions
      • rsoft_cad.femsim
        • Main Functions
        • Analysis Modules
      • rsoft_cad.utils
        • Configuration Management
        • Fiber Layout
        • File I/O
        • Plotting
    • Advanced Modules
      • rsoft_cad.geometry
        • Classes
      • rsoft_cad.optimisation
        • Modules
      • rsoft_cad.layout
        • Functions
    • Constants and Utilities
      • rsoft_cad.constants
      • rsoft_cad.utils.lp_modes
        • Functions
    • Configuration System
      • Parameterized Expressions
    • Error Handling
      • Common Exceptions
      • Best Practices
    • Type Hints
    • Extension Points
      • Custom Lantern Types
      • Custom File Formats
    • Performance Considerations
      • Large Simulations
      • Optimization
  • Changelog
    • [Unreleased]
      • Added
      • Changed
      • Fixed
    • [0.1.0] - 2024-12-13
      • Added
      • Features
      • Dependencies
      • Known Issues
    • Development Notes
      • Version 0.1.0 Architecture
      • Future Roadmap
        • Version 0.2.0 (Planned)
        • Version 0.3.0 (Planned)
      • Contributing
      • Migration Guide
        • From Pre-Release to v0.1.0
        • Example Migration
  • rsoft_cad
    • rsoft_cad package
      • configure_logging()
      • Subpackages
        • rsoft_cad.beamprop package
        • rsoft_cad.femsim package
        • rsoft_cad.geometry package
        • rsoft_cad.lantern package
        • rsoft_cad.layout package
        • rsoft_cad.optimisation package
        • rsoft_cad.simulations package
        • rsoft_cad.utils package
      • Submodules
      • rsoft_cad.constants module
      • rsoft_cad.rsoft_circuit module
        • RSoftCircuit
        • TaperType
        • LaunchType
        • MonitorType
        • UserTaper
      • rsoft_cad.rsoft_simulations module
        • run_simulation()
        • rename_component_files()
        • copy_component_files()
RSoft PLTools
  • Search

© Copyright 2024, Kok-Wei Bong.

Built with Sphinx using a theme provided by Read the Docs.