Correction for #46

docs/make.jl

@@ -48,6 +48,7 @@ function main()
         "references.md",
         "API" => "API.md",
         "CircuitZoo API" => "API_CircuitZoo.md",
+        "StatesZoo API" => "API_StatesZoo.md",
         "Bibliography" => "bibliography.md",
     ],
     ]

docs/src/API_CircuitZoo.md

@@ -9,7 +9,7 @@
 </style>
 ```
 
-## Autogenerated API list for `QuantumClifford.CircuitZoo`
+## Autogenerated API list for `QuantumSavory.CircuitZoo`
 
 ```@autodocs
 Modules = [QuantumSavory.CircuitZoo]

docs/src/API_StatesZoo.md

@@ -0,0 +1,17 @@
+# Available States
+
+```@raw html
+<style>
+    .content table td {
+        padding-top: 0 !important;
+        padding-bottom: 0 !important;
+    }
+</style>
+```
+
+## Autogenerated API list for `QuantumSavory.StatesZoo`
+
+```@autodocs
+Modules = [QuantumSavory.StatesZoo]
+Private = false
+```

src/StatesZoo/StatesZoo.jl

@@ -1,5 +1,6 @@
 module StatesZoo
 
+using DocStringExtensions
 using QuantumSymbolics, QuantumOpticsBase
 using QuantumSymbolics: withmetadata, @withmetadata, Metadata
 import QuantumSymbolics: express_nolookup

src/StatesZoo/single_dual_rail_midswap/single_dual_rail_midswap.jl

@@ -28,13 +28,27 @@ function midswap_dual_rail(eA,eB,gA,gB,Pd,Vis)
 end
 
 """
+$TYPEDEF
+
+Fields:
+
+$FIELDS
+
 Generates the spin-spin density matrix for linear photonic entanglement swap 
 with emissive memories emitting single rail photonic qubits from the paper [prajit2023entangling](@cite)
 It takes the following parameters:
 - eA, eB: Link efficiencies for memories A and B upto the swap (include link loss, detector efficiency, etc.)
 - gA, gB: Memory initialization parameter for memories A and B
 - Pd: Detector dark count probability per photonic mode (assumed to be the same for both detectors)
 - Vis: Interferometer visibility for the midpoint swap' can be complex to account for phase instability
+
+```jldoctest
+julia> r = Register(2)
+
+julia> initialize!(r[1:2], SingleRailMidSwapBell(0.9, 0.9, 0.5, 0.5, 1e-8, 0.99))
+
+julia> observable(r[1:2], Z⊗Z)
+```
 """
 @withmetadata struct SingleRailMidSwapBell <: AbstractTwoQubitState
     eA::Float64
@@ -49,13 +63,27 @@ symbollabel(x::SingleRailMidSwapBell) = "ρˢʳᵐˢ"
 
 
 """
+$TYPEDEF
+
+Fields:
+
+$FIELDS
+
 Generates the spin-spin density matrix for linear photonic entanglement swap with emissive
  memories emitting dual rail photonic qubits from the paper [prajit2023entangling](@cite).
  It takes the following parameters:
  - eA, eB: Link efficiencies for memories A and B upto the swap (include link loss, detector efficiency, etc.)
 - gA, gB: Memory initialization parameter for memories A and B 
 - Pd: Detector dark count probability per photonic mode (assumed to be the same for both detectors)
 - Vis: Interferometer visibility for the midpoint swap 
+
+```jldoctest
+julia> r = Register(2)
+
+julia> initialize!(r[1:2], DualRailMidSwapBell(0.9, 0.9, 0.5, 0.5, 1e-8, 0.99))
+
+julia> observable(r[1:2], Z⊗Z)
+```
 """
 @withmetadata struct DualRailMidSwapBell <: AbstractTwoQubitState
     eA::Float64

src/StatesZoo/zalm_pair/zalm_pair.jl

@@ -562,6 +562,12 @@ end
 
 
 """
+$TYPEDEF
+
+Fields:
+
+$FIELDS
+
 Generate symbolic object for the spin-spin density matrix for a 
 cascaded source swapped with emissive spin memories. The cascaded 
 source from papers [prajit2022heralded](@cite) and [kevin2023zero](@cite) 
@@ -579,6 +585,13 @@ It takes the following parameters:
 - Pdo1: dark click probability per photonic mode on Alice side swap 
 - Pdo2: dark click probability per photonic mode on Bob side swap
 - VisF: product of visibilities of all three  interferometers (Allowed range: [0,1])
+
+```jldoctest
+julia> r = Register(2)
+
+julia> initialize!(r[1:2], ZALMSpinPair(1e-3, 0.5, 0.5, 1, 1, 1, 1, 0.9, 1e-8, 1e-8, 1e-8, 0.99))
+
+juilia> observable(r[1:2], Z⊗Z)
 ```
 """
 @withmetadata struct ZALMSpinPair <: AbstractTwoQubitState