Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
symop documentation
symop documentation

Install

  • Installation

Examples

  • Example Gallery
    • Number State Source Example
    • Spectral Filter Example
    • Ideal Beam-Splitter Example
    • Phase Shifter and Mach-Zehnder Interferometer Example
    • Number Detector Example
    • HOM Coincidence Observation Example

Concepts

  • Overview
    • Core symbolic terms
      • Symbolic terms
    • Modes
      • Mode labels
      • Envelopes
      • Transfer functions
      • Polarization
      • Path
    • CCR algebra
      • Ket algebra
      • Density algebra
      • Operator algebra
      • Normal ordering, expectation values, and trace

Architecture

  • Architecture
    • Device Execution and Kernel Dispatch
  • Packages
  • Coverage

Citation

  • Citing SymOp

API Reference

  • API Reference
    • Core
      • symop.core.terms
      • symop.core.types
      • symop.core.monomial
      • symop.core.operators
    • Modes
      • symop.modes.envelopes
        • symop.modes.envelopes.base
        • symop.modes.envelopes.filtered
        • symop.modes.envelopes.gaussian
        • symop.modes.envelopes.gaussian_mixture
      • symop.modes.labels
        • symop.modes.labels.mode
        • symop.modes.labels.path
        • symop.modes.labels.polarization
      • symop.modes.transfer
        • symop.modes.transfer.apply
        • symop.modes.transfer.base
        • symop.modes.transfer.cascade
        • symop.modes.transfer.gaussian
          • symop.modes.transfer.gaussian.bandpass
          • symop.modes.transfer.gaussian.base
          • symop.modes.transfer.gaussian.constant_phase
          • symop.modes.transfer.gaussian.formalism
          • symop.modes.transfer.gaussian.highpass
          • symop.modes.transfer.gaussian.lowpass
          • symop.modes.transfer.gaussian.time_delay
        • symop.modes.transfer.quadratic_dispersion
        • symop.modes.transfer.rect_bandpass
        • symop.modes.transfer.supergaussian_bandpass
      • symop.modes.types
    • CCR
      • symop.ccr.algebra.density
        • symop.ccr.algebra.density.apply_left
        • symop.ccr.algebra.density.apply_right
        • symop.ccr.algebra.density.combine
        • symop.ccr.algebra.density.expand_monomial_times_word
        • symop.ccr.algebra.density.expand_word_times_monomial
        • symop.ccr.algebra.density.inner
        • symop.ccr.algebra.density.multiply
        • symop.ccr.algebra.density.normalize_trace
        • symop.ccr.algebra.density.overlap_right_left
        • symop.ccr.algebra.density.partial_trace
        • symop.ccr.algebra.density.poly
        • symop.ccr.algebra.density.pure
        • symop.ccr.algebra.density.purity
        • symop.ccr.algebra.density.scale
        • symop.ccr.algebra.density.trace
      • symop.ccr.algebra.ket
        • symop.ccr.algebra.ket.apply
        • symop.ccr.algebra.ket.combine
        • symop.ccr.algebra.ket.from_ops
        • symop.ccr.algebra.ket.from_word
        • symop.ccr.algebra.ket.identity_coeff
        • symop.ccr.algebra.ket.inner
        • symop.ccr.algebra.ket.multiply
        • symop.ccr.algebra.ket.poly
        • symop.ccr.algebra.ket.scale
      • symop.ccr.algebra.op
        • symop.ccr.algebra.op.combine
        • symop.ccr.algebra.op.from_words
        • symop.ccr.algebra.op.multiply
        • symop.ccr.algebra.op.poly
      • symop.ccr.common
        • symop.ccr.common.keys
        • symop.ccr.common.signatures
    • Polynomial
      • symop.polynomial.channels
        • symop.polynomial.channels.models
          • symop.polynomial.channels.models.amplifier
          • symop.polynomial.channels.models.beamsplitter
          • symop.polynomial.channels.models.mzi
          • symop.polynomial.channels.models.phase
          • symop.polynomial.channels.models.pure_loss
        • symop.polynomial.channels.primitives
          • symop.polynomial.channels.primitives.bogoliubov
          • symop.polynomial.channels.primitives.linear_mode_unitary
          • symop.polynomial.channels.primitives.unitary_dilation
        • symop.polynomial.channels.unitaries
          • symop.polynomial.channels.unitaries.beamsplitter
          • symop.polynomial.channels.unitaries.blockdiag
          • symop.polynomial.channels.unitaries.conventions
          • symop.polynomial.channels.unitaries.mzi
          • symop.polynomial.channels.unitaries.phase
          • symop.polynomial.channels.unitaries.swap
      • symop.polynomial.kernels
        • symop.polynomial.kernels.devices
          • symop.polynomial.kernels.devices.beamsplitter
          • symop.polynomial.kernels.devices.filter
          • symop.polynomial.kernels.devices.number_state_source
          • symop.polynomial.kernels.devices.phase_shifter
          • symop.polynomial.kernels.devices.registry
        • symop.polynomial.kernels.measurements
          • symop.polynomial.kernels.measurements.number
            • symop.polynomial.kernels.measurements.number.common
            • symop.polynomial.kernels.measurements.number.detect
            • symop.polynomial.kernels.measurements.number.observe
            • symop.polynomial.kernels.measurements.number.postselect
          • symop.polynomial.kernels.measurements.registry
      • symop.polynomial.rewrites
        • symop.polynomial.rewrites.relabel_modes
        • symop.polynomial.rewrites.substitution
      • symop.polynomial.state
        • symop.polynomial.state.density
        • symop.polynomial.state.ket
    • Devices
      • symop.devices.models
        • symop.devices.models.base
        • symop.devices.models.beamsplitters
          • symop.devices.models.beamsplitters.beamsplitter
        • symop.devices.models.detectors
          • symop.devices.models.detectors.coincidence_detector
          • symop.devices.models.detectors.number_detector
          • symop.devices.models.detectors.povm_detector
        • symop.devices.models.filters
          • symop.devices.models.filters.polarizing_filter
          • symop.devices.models.filters.spectral_filter
        • symop.devices.models.paths
          • symop.devices.models.paths.delay
        • symop.devices.models.phase_shifters
          • symop.devices.models.phase_shifters.phase_shifter
        • symop.devices.models.sources
          • symop.devices.models.sources.number_state_source
      • symop.devices.types
        • symop.devices.types.device_kind
        • symop.devices.types.measurement
        • symop.devices.types.ports
      • symop.devices.action
      • symop.devices.dispatch
      • symop.devices.ports
      • symop.devices.registry
      • symop.devices.runtime
Back to top
View this page

Coverage¶

The HTML coverage report is available here:

  • Coverage report

Next
Citing SymOp
Previous
Packages
Copyright © 2026, Simon Sekavčnik
Made with Sphinx and @pradyunsg's Furo