API Overview
This page highlights the primary user-facing entry points and where to find details.
Core Concepts
Envelope and CompositeEnvelope orchestration (photon_weave.state.envelope, photon_weave.state.composite_envelope).
Operations (photon_weave.operation): Fock, Polarization, Custom, and Composite operations.
Configuration (photon_weave.photon_weave.Config and Session) for seeds, contractions, and JIT flags.
Measurement
Current APIs: - Envelope.measure, Envelope.measure_POVM, Envelope.measure_expectation - CompositeEnvelope measurement methods - Utility functions in photon_weave.state.utils.measurements
Near-term roadmap: - Unified MeasurementSpec/MeasurementResult and shot support (see measurement_api_todo.md).
Operations
High-level: Envelope.apply_operation, Envelope.apply_kraus, CompositeEnvelope.apply_operation
Low-level helpers: photon_weave.state.utils.operations (documented NumPy-style) and adapters in photon_weave.core.adapters.
Reference
- Full API (autodoc)
- Core Internals
- State API (envelopes & composites)
- Subpackages
- Submodules
- photon_weave.state.base_state module
- photon_weave.state.composite_envelope module
- photon_weave.state.custom_state module
- photon_weave.state.envelope module
- photon_weave.state.exceptions module
- photon_weave.state.expansion_levels module
- photon_weave.state.fock module
- photon_weave.state.polarization module
- Module contents
- State Utilities
- Operation API
- Operation Helpers
- Constants
- Extras & Interop