added error for breaking change in randomcircuit

Project.toml

@@ -1,7 +1,7 @@
 name = "PastaQ"
 uuid = "30b07047-aa8b-4c78-a4e8-24d720215c19"
 authors = ["Giacomo Torlai <[email protected]>", "Matthew Fishman <[email protected]>"]
-version = "0.0.15"
+version = "0.0.16"
 
 [deps]
 Convex = "f65535da-76fb-5f13-bab9-19810c17039a"

src/circuits/circuits.jl

@@ -226,10 +226,16 @@ end
 
 Generate a 2D random quantum circuit
 """
-function randomcircuit(Lx::Int, Ly::Int; rotated::Bool=false, kwargs...)
+function randomcircuit(size::Tuple; rotated::Bool=false, kwargs...)
+  Lx, Ly = size
   return randomcircuit(squarearray(Lx, Ly; rotated=rotated); kwargs...)
 end
 
+function randomcircuit(L::Int, depth::Int; rotated::Bool=false, kwargs...)
+  error("randomcircuit(N::Int, depth::Int; kwargs...) is depracated\n
+         - for a 1d random circuit: randomcircuit(N::Int; depth = depth, kwargs...)\n
+         - for a 2d random circuit: randomcircuit((Lx, Ly); depth = depth, kwargs...)")
+end
 
 ITensors.dag(single_gate::Tuple{String,Union{Int,Tuple}}) = 
   (single_gate[1], single_gate[2], (dag = true,))

test/circuits.jl

@@ -133,12 +133,12 @@ end
 
   Lx = 5
   Ly = 5
-  circuit = randomcircuit(Lx,Ly; depth = depth, twoqubitgates="RandomUnitary", onequbitgates=["Rn", "X"])
+  circuit = randomcircuit((Lx,Ly); depth = depth, twoqubitgates="RandomUnitary", onequbitgates=["Rn", "X"])
   @test nqubits(circuit) == Lx*Ly
 
   Lx = 5
   Ly = 5
-  circuit = randomcircuit(Lx,Ly; depth = depth,  twoqubitgates="RandomUnitary", onequbitgates=["Rn", "X"], rotated = true)
+  circuit = randomcircuit((Lx,Ly); depth = depth,  twoqubitgates="RandomUnitary", onequbitgates=["Rn", "X"], rotated = true)
   @test nqubits(circuit) == Lx*Ly
 end