buildkite (#7)

* buildkite

* update Project.toml

* doc update

* spelling

* downgrade compat

Author: Krastanov

.buildkite/pipeline.yml

@@ -0,0 +1,14 @@
+env:
+  CODECOV_TOKEN: 61f19b8a-59a0-4120-b30a-6b0cb93452c2
+  JULIA_NUM_THREADS: auto
+  QUANTUMSAVORY_PLOT_TEST: true
+  
+steps:
+  - label: "CI Buildkite"
+    plugins:
+      - JuliaCI/julia#v1:
+          version: "1"
+      - QuantumSavory/julia-xvfb#v1:
+      - JuliaCI/julia-test#v1: ~
+      - JuliaCI/julia-coverage#v1:
+          codecov: true

.github/workflows/ci.yml

@@ -36,6 +36,10 @@ jobs:
             ${{ runner.os }}-test-${{ env.cache-name }}-
             ${{ runner.os }}-test-
             ${{ runner.os }}-
+      - uses: cjdoris/julia-downgrade-compat-action@v1
+        if: ${{ matrix.version == '1.9' }}
+        with:
+          skip: Pkg, Random
       - uses: julia-actions/julia-buildpkg@v1
       - uses: julia-actions/julia-runtest@v1
         env:

.github/workflows/spelling.yml

@@ -0,0 +1,15 @@
+name: Spell Check
+
+on: [pull_request]
+
+jobs:
+  typos-check:
+    name: Spell Check with Typos
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Actions Repository
+        uses: actions/checkout@v4
+      - name: Check spelling
+        uses: crate-ci/typos@master
+        with:
+            config: .typos.toml

.typos.toml

@@ -0,0 +1,2 @@
+[default.extend-words]
+ket = "ket"

Project.toml

@@ -1,12 +1,13 @@
 name = "BPGates"
 uuid = "2c1a90cd-bec4-4415-ae35-245016909a8f"
-authors = ["ShuGe-MIT <[email protected]>", "Stefan Krastanov <[email protected]>"]
-version = "1.0.0"
+authors = ["Shu Ge <[email protected]>", "Stefan Krastanov <[email protected]>"]
+version = "1.0.1"
 
 [deps]
 QuantumClifford = "0525e862-1e90-11e9-3e4d-1b39d7109de1"
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
 
 [compat]
 QuantumClifford = "0.8"
+Random = "1"
 julia = "1.9"

README.md

@@ -10,7 +10,8 @@
     <tr>
         <td>Continuous integration</td>
         <td>
-            <a href="https://github.com/QuantumSavory/BPGates.jl/actions?query=workflow%3ACI+branch%3Amaster"><img src="https://img.shields.io/github/actions/workflow/status/QuantumSavory/BPGates.jl/ci.yml?branch=main" alt="GitHub Workflow Status"></a>
+            <a href="https://github.com/QuantumSavory/BPGates.jl/actions?query=workflow%3ACI+branch%3Amaster"><img src="https://github.com/QuantumSavory/BPGates.jl/actions/workflows/ci.yml/badge.svg" alt="GitHub Workflow Status"></a>
+            <a href="https://buildkite.com/quantumsavory/bpgates"><img src="https://badge.buildkite.com/158b11c71354091501f5e7d3b81d53e13afc493dbb679ed580.svg" alt="Buildkite Workflow Status"></a>
         </td>
     </tr><tr></tr>
     <tr>

docs/make.jl

@@ -12,6 +12,7 @@ makedocs(
 #bib,
 doctest = false,
 clean = true,
+warnonly = :missing_docs,
 sitename = "BPGates.jl",
 format = Documenter.HTML(),
 modules = [BPGates],

docs/src/index.md

@@ -65,7 +65,7 @@ All of these methods would require a Monte Carlo Quantum Trajectories simulation
 
 ## Short Example
 
-You can initialize a Bell State by specifing the phases and convert it to stabilizer representation.
+You can initialize a Bell State by specifying the phases and convert it to stabilizer representation.
 ```
 julia> bell_state = BellState([0,1,1,0])
 BellState(Bool[0, 1, 1, 0])

src/BPGates.jl

@@ -158,7 +158,7 @@ end
 """
 Coincidence measurement on Bell pairs.
 
-The first argument, `midx`, spefies the X, Y, Z basis respectively.
+The first argument, `midx`, specifies the X, Y, Z basis respectively.
 The second argument, `sidx`, indicates which Bell pair is being measured.
 
 The state will be reset to `00` after being applied measurement.
@@ -371,7 +371,7 @@ end
 # Typically good operations
 ##############################
 
-"""A bilateral CNOT preceeded by permutations on each of the pairs that map the `00` state to itself."""
+"""A bilateral CNOT preceded by permutations on each of the pairs that map the `00` state to itself."""
 struct CNOTPerm <: BellOp
     single1::Int
     single2::Int
@@ -611,7 +611,7 @@ end
 ##############################
 
 """
-Convert a Bell perserving gate from `BPGates` representation to a sequence of Clifford gate from `QuantumClifford`.
+Convert a Bell preserving gate from `BPGates` representation to a sequence of Clifford gate from `QuantumClifford`.
 
 Translating [`BellMeasure`](@ref) is not precise,
 because a real Bell measurement would destroy the Bell pair,