start hodgepodge subrepository and add to list of contributors

code_metadata.jl

@@ -8,6 +8,8 @@ const eᵐⁱⁿ = 0.00001
 const eᵐᵃˣ = 0.3
 const steps = 20
 
+include("hodgepodge/hodgepodge_codes.jl")
+
 const code_metadata = Dict(
     Gottesman => Dict(
         :family => [(3,),(4,),(5,),(6,)],
@@ -57,5 +59,20 @@ const code_metadata = Dict(
         :errrange => (eᵐⁱⁿ, eᵐᵃˣ, steps),
         :description => "The famous toric code, the first topological code. Terrible rate, ok-ish distance, awesome locality -- a tradeoff that will turn out to be fundamental to codes with only 2D connectivity.",
     ),
-
+    Surface => Dict(
+        :family => [(3,3), (4,4), (6,6), (8,8), (10,10), (12,12)],
+        :decoders => [TableDecoder, PyMatchingDecoder],
+        :setups => [CommutationCheckECCSetup],
+        :ecczoo => "https://errorcorrectionzoo.org/c/surface",
+        :errrange => (eᵐⁱⁿ, eᵐᵃˣ, steps),
+        :description => "An open-boundary version of the famous toric code, the first topological code. Terrible rate, ok-ish distance, awesome locality -- a tradeoff that will turn out to be fundamental to codes with only 2D connectivity.",
+    ),
+    Hodgepodge.NithinCode => Dict(
+        :family => [()],
+        :decoders => [TableDecoder, PyBeliefPropDecoder, PyBeliefPropOSDecoder],
+        :setups => [CommutationCheckECCSetup],
+        :ecczoo => "",
+        :errrange => (eᵐⁱⁿ, eᵐᵃˣ, steps),
+        :description => "My friend Nithin made this one. It is here as an example placeholder as we built out the page for this code family.",
+    ),
 )

codes/NithinCode/index.md

@@ -0,0 +1,75 @@
++++
+title = "The Code Family `NithinCode`"
++++
+
+# The Code Family `NithinCode`
+
+My friend Nithin made this one. It is here as an example placeholder as we built out the page for this code family.
+
+![summary of all evaluations that have been executed for this code family](./totalsummary.png)
+
+@@card
+@@card-header
+References
+@@
+@@card-body
+[ECC Zoo entry]()~~~<br>~~~
+[QuantumClifford.jl docs](https://quantumsavory.github.io/QuantumClifford.jl/dev/ECC_API/#QuantumClifford.ECC.NithinCode)
+@@
+@@
+
+
+## A Few Examples from this Family
+
+@@small
+Click on the &#9654; marker to expand
+@@
+
+
+~~~
+<details>
+<summary>
+~~~
+### NithinCode()
+~~~
+</summary>
+~~~
+
+#### Parity Check Tableau
+
+![the parity check tableau of the NithinCode() instance of this code family](./NithinCode().png)
+
+#### Encoding Circuit
+
+@@small
+can be generated with [`QuantumClifford.naive_encoding_circuit`](https://quantumsavory.github.io/QuantumClifford.jl/dev/ECC_API/#QuantumClifford.ECC.naive_encoding_circuit)
+@@
+
+![the encoding circuit of the NithinCode() instance of this code family](./NithinCode()_encoding.png)
+
+#### Naive Syndrome Extraction Circuit
+
+@@small
+can be generated with [`QuantumClifford.naive_syndrome_circuit`](https://quantumsavory.github.io/QuantumClifford.jl/dev/ECC_API/#QuantumClifford.ECC.naive_syndrome_circuit)
+@@
+
+![the naive syndrome extraction circuit of the NithinCode() instance of this code family](./NithinCode()_encoding.png)
+
+#### Shor Syndrome Extraction Circuit
+
+@@small
+can be generated with [`QuantumClifford.shor_syndrome_circuit`](https://quantumsavory.github.io/QuantumClifford.jl/dev/ECC_API/#QuantumClifford.ECC.shor_syndrome_circuit)
+@@
+
+![the Shor syndrome extraction circuit of the NithinCode() instance of this code family](./NithinCode()_shor.png)
+
+~~~
+</details>
+~~~
+
+
+
+## Performance of Specific Decoders
+
+TODO
+