Merge pull request #115 from QuanEstimation/lib

Lib

.github/workflows/CI_NVMagnetometer.yml

@@ -4,7 +4,7 @@ on:
       branches:
         - main
       paths:
-        - "src/NVMagnetometer/**"
+        - "lib/NVMagnetometer/**"
         - ".github/workflows/CI_NVMagnetometer.yml"
   push:
     branches:
@@ -53,10 +53,10 @@ jobs:
           Pkg.Registry.update()
           # Install packages present in subdirectories
           dev_pks = Pkg.PackageSpec[]
-          for path in ("src/QuanEstimationBase",)
+          for path in ("lib/QuanEstimationBase",)
               push!(dev_pks, Pkg.PackageSpec(; path))
           end
           Pkg.develop(dev_pks)
           Pkg.instantiate()
           Pkg.test(; coverage="user")
-        shell: julia --color=yes --code-coverage=user --depwarn=yes --project=src/NVMagnetometer {0}
+        shell: julia --color=yes --code-coverage=user --depwarn=yes --project=lib/NVMagnetometer {0}

.github/workflows/CI_QuanEstimation.yml

@@ -5,6 +5,7 @@ on:
         - main
       paths:
         - "src/**"
+        - "lib/**"
         - "ext/**"
         - "test/**"
         - "Project.toml"
@@ -58,7 +59,7 @@ jobs:
           Pkg.Registry.update()
           # Install packages present in subdirectories
           dev_pks = Pkg.PackageSpec[]
-          for path in ("src/QuanEstimationBase", "src/NVMagnetometer")
+          for path in ("lib/QuanEstimationBase", "lib/NVMagnetometer")
               push!(dev_pks, Pkg.PackageSpec(; path))
           end
           Pkg.develop(dev_pks)
@@ -67,7 +68,7 @@ jobs:
         shell: julia --color=yes --code-coverage=user --depwarn=yes --project=. {0}
       - uses: julia-actions/julia-processcoverage@v1
         with:
-          directories: src
+          directories: src,ext,lib/QuanEstimationBase/src,lib/NVMagnetometer/src
       - uses: codecov/codecov-action@v5
         with:
           files: lcov.info

.github/workflows/CI_QuanEstimationBase.yml

@@ -4,7 +4,7 @@ on:
       branches:
         - main
       paths:
-        - "src/QuanEstimationBase/**"
+        - "lib/QuanEstimationBase/**"
         - ".github/workflows/CI_QuanEstimationBase.yml"
   push:
     branches:
@@ -51,4 +51,6 @@ jobs:
         run: |
           import Pkg
           Pkg.Registry.update()
-        shell: julia --color=yes --code-coverage=user --depwarn=yes --project=src/QuanEstimationBase {0}
+          Pkg.instantiate()
+          Pkg.test(; coverage="user")
+        shell: julia --color=yes --code-coverage=user --depwarn=yes --project=lib/QuanEstimationBase {0}

Makefile

@@ -0,0 +1,29 @@
+JL = julia --project
+
+default: init test
+
+init:
+	$(JL) -e 'using Pkg; Pkg.develop([Pkg.PackageSpec(path = joinpath("lib", pkg)) for pkg in ["QuanEstimationBase", "NVMagnetometer"]]); Pkg.precompile()'
+
+update:
+	$(JL) -e 'using Pkg; Pkg.update(); Pkg.precompile()'
+update-docs:
+	$(JL) -e 'using Pkg; Pkg.activate("docs"); Pkg.update(); Pkg.precompile()'
+
+test:
+	$(JL) -e 'using Pkg; Pkg.test("QuanEstimation")'
+
+test-%:
+	$(JL) -e 'using Pkg; Pkg.test("$*")'
+
+coverage:
+	$(JL) -e 'using Pkg; Pkg.test(["QuanEstimation", "QuanEstimationBase", "NVMagnetometer"]; coverage=true)'
+
+servedocs:
+	$(JL) -e 'using Pkg; Pkg.activate("docs"); using LiveServer; servedocs(;skip_dirs=["docs/src/assets", "docs/src/generated"])'
+
+clean:
+	rm -rf docs/build
+	find . -name "*.cov" -type f -print0 | xargs -0 /bin/rm -f
+
+.PHONY: init test

src/QuanEstimationBase/test/algorithms/test_AD.jl → lib/QuanEstimationBase/test/algorithms/test_AD.jl

@@ -21,7 +21,7 @@ end
 function test_Mopt_Projection()
     M = QuanEstimationBase.SIC(2)
     seed = 1234
-    opt = Mopt_Projection(; M = M, seed = seed)
+    opt = MeasurementOpt(; mtype = :Projection, M = M, seed = seed)
     @test opt.M == M
     @test opt.rng == MersenneTwister(seed)
 end
@@ -31,7 +31,7 @@ function test_Mopt_LinearComb()
     POVM_basis = QuanEstimationBase.SIC(2)
     M_num = 2
     seed = 1234
-    opt = Mopt_LinearComb(POVM_basis = POVM_basis, M_num = M_num, seed = seed)
+    opt = MeasurementOpt(; mtype = :LC,POVM_basis = POVM_basis, M_num = M_num, seed = seed)
     @test opt.POVM_basis == POVM_basis
     @test opt.M_num == M_num
     @test opt.rng == MersenneTwister(seed)
@@ -41,7 +41,7 @@ end
 function test_Mopt_Rotation()
     POVM_basis = QuanEstimationBase.SIC(2)
     seed = 1234
-    opt = Mopt_Rotation(POVM_basis = POVM_basis, seed = seed)
+    opt = MeasurementOpt(; mtype = :Rotation, POVM_basis = POVM_basis, seed = seed)
     @test opt.POVM_basis == POVM_basis
     @test opt.rng == MersenneTwister(seed)
 end

src/QuanEstimationBase/test/algorithms/test_DE.jl → lib/QuanEstimationBase/test/algorithms/test_DE.jl

@@ -16,10 +16,10 @@ function test_StateOpt()
     @test opt.rng == MersenneTwister(seed)
 end
 
-function test_Mopt_Projection()
+function test_MeasurementOpt(; mtype = :Projection,)
     M = QuanEstimationBase.SIC(2)
     seed = 1234
-    opt = Mopt_Projection(M = M, seed = seed)
+    opt = MeasurementOpt(; mtype = :Projection,M = M, seed = seed)
     @test opt.M == M
     @test opt.rng == MersenneTwister(seed)
 end
@@ -28,7 +28,7 @@ function test_Mopt_LinearComb()
     POVM_basis = QuanEstimationBase.SIC(2)
     M_num = 2
     seed = 1234
-    opt = Mopt_LinearComb(POVM_basis = POVM_basis, M_num = M_num, seed = seed)
+    opt = MeasurementOpt(; mtype = :LC, POVM_basis = POVM_basis, M_num = M_num, seed = seed)
     @test opt.POVM_basis == POVM_basis
     @test opt.M_num == M_num
     @test opt.rng == MersenneTwister(seed)
@@ -37,7 +37,7 @@ end
 function test_Mopt_Rotation()
     POVM_basis = QuanEstimationBase.SIC(2)
     seed = 1234
-    opt = Mopt_Rotation(POVM_basis = POVM_basis, seed = seed)
+    opt = MeasurementOpt(; mtype = :Rotation,POVM_basis = POVM_basis, seed = seed)
     @test opt.POVM_basis == POVM_basis
     @test opt.rng == MersenneTwister(seed)
 end
@@ -52,7 +52,7 @@ function test_OptScenario()
     end
 
     @testset "Mopt_Projection" begin
-        test_Mopt_Projection()
+        test_MeasurementOpt()
     end
 
     @testset "Mopt_LinearComb" begin

src/QuanEstimationBase/test/algorithms/test_PSO.jl → lib/QuanEstimationBase/test/algorithms/test_PSO.jl

@@ -19,7 +19,7 @@ end
 function test_Mopt_Projection()
     M = QuanEstimationBase.SIC(2)
     seed = 1234
-    opt = Mopt_Projection(M = M, seed = seed)
+    opt = MeasurementOpt(; mtype = :Projection,M = M, seed = seed)
     @test opt.M == M
     @test opt.rng == MersenneTwister(seed)
 end
@@ -28,7 +28,7 @@ function test_Mopt_LinearComb()
     POVM_basis = QuanEstimationBase.SIC(2)
     M_num = 2
     seed = 1234
-    opt = Mopt_LinearComb(POVM_basis = POVM_basis, M_num = M_num, seed = seed)
+    opt = MeasurementOpt(; mtype = :LC, POVM_basis = POVM_basis, M_num = M_num, seed = seed)
     @test opt.POVM_basis == POVM_basis
     @test opt.M_num == M_num
     @test opt.rng == MersenneTwister(seed)
@@ -37,7 +37,7 @@ end
 function test_Mopt_Rotation()
     POVM_basis = QuanEstimationBase.SIC(2)
     seed = 1234
-    opt = Mopt_Rotation(POVM_basis = POVM_basis, seed = seed)
+    opt = MeasurementOpt(; mtype = :Rotation, POVM_basis = POVM_basis, seed = seed)
     @test opt.POVM_basis == POVM_basis
     @test opt.rng == MersenneTwister(seed)
 end

src/QuanEstimationBase/test/optimization/test_opt_scenario.jl → lib/QuanEstimationBase/test/optimization/test_opt_scenario.jl

@@ -35,7 +35,7 @@ end
 function test_Mopt_Projection()
     M = QuanEstimationBase.SIC(2)
     seed = 1234
-    opt = Mopt_Projection(M = M, seed = seed)
+    opt = MeasurementOpt(; mtype = :Projection,M = M, seed = seed)
     @test opt.M == M
     @test opt.rng == MersenneTwister(seed)
 end
@@ -45,7 +45,7 @@ function test_Mopt_LinearComb()
     POVM_basis = QuanEstimationBase.SIC(2)
     M_num = 2
     seed = 1234
-    opt = Mopt_LinearComb(POVM_basis = POVM_basis, M_num = M_num, seed = seed)
+    opt = MeasurementOpt(; mtype = :LC, POVM_basis = POVM_basis, M_num = M_num, seed = seed)
     @test opt.POVM_basis == POVM_basis
     @test opt.M_num == M_num
     @test opt.rng == MersenneTwister(seed)

src/QuanEstimationBase/test/runtests.jl → lib/QuanEstimationBase/test/runtests.jl

@@ -51,10 +51,6 @@ end
         include("algorithms/test_DE.jl")
     end
 
-    @testset "NM" begin
-        include("algorithms/test_NM.jl")
-    end
-
     @testset "PSO" begin
         include("algorithms/test_PSO.jl")
     end