pulsesuite Logo

Getting Started

  • PulseSuite
  • Examples Gallery

Simulation Guide

  • Building Simulations
  • Parameter Files Reference

References

  • Bibliography

Community

  • Contributing
  • Contributors
  • Citing PulseSuite
  • Code of Conduct for the PulseSuite community
pulsesuite
  • PulseSuite Documentation
  • View page source

PulseSuite logo

PulseSuite Documentation¶

Welcome to PulseSuite’s documentation!

Getting Started

  • PulseSuite
    • Features
    • Installation
    • Package Structure
    • Requirements
    • Running a Simulation
    • Contributing
    • Citation
    • Authors
    • License
    • Links
    • Acknowledgments
  • Examples Gallery
    • Quickstart: Your First SBE Simulation
    • Architecture: How the SBE Solver Works
    • Deep Dive: Coulomb Interactions
    • Deep Dive: Phonon Interactions
    • Deep Dive: Quantum Wire Optics
    • Deep Dive: DC Transport and Emission

Simulation Guide

  • Building Simulations
    • The Simulation Driver
    • Physics Regimes
    • Optional Output Flags
    • Combining with Different Materials
    • Running Your First Custom Simulation
  • Parameter Files Reference
    • File Overview
    • qw.params — Quantum Wire Properties
    • mb.params — Many-Body Physics Flags
    • pulse.params — Optical Pulse Configuration
    • space.params — Spatial Grid
    • qwarray.params — Quantum Wire Array
    • pstd_abc.params — Absorbing Boundary Conditions
    • How Parameters Flow into the Simulation
    • Template Files

References

  • Bibliography

Community

  • Contributing
  • Contributors
  • Citing PulseSuite
  • Code of Conduct for the PulseSuite community

Indices and Tables¶

  • Index

  • Module Index

  • Search Page

Next

© Copyright 2026, Rahul R. Sah and PulseSuite Developers.

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