Merge branch 'main' into dev/dimensions

Author: ytdHuang

.github/workflows/CI.yml

@@ -10,7 +10,7 @@ on:
       - 'ext/**'
       - 'test/runtests.jl'
       - 'test/core-test/**'
-      - 'test/ext-test/cairomakie_ext.jl'
+      - 'test/ext-test/cairomakie/**'
       - 'Project.toml'
   pull_request:
     branches:
@@ -21,7 +21,7 @@ on:
       - 'ext/**'
       - 'test/runtests.jl'
       - 'test/core-test/**'
-      - 'test/ext-test/cairomakie_ext.jl'
+      - 'test/ext-test/cairomakie/**'
       - 'Project.toml'
     types:
       - opened

Project.toml

@@ -70,9 +70,8 @@ julia = "1.10"
 
 [extras]
 Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
-CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"
 JET = "c3a54625-cd67-489e-a8e7-0a5a0ff4e31b"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
-test = ["Aqua", "CairoMakie", "JET", "Test"]
+test = ["Aqua", "JET", "Test"]

README.md

@@ -176,3 +176,25 @@ Here we provide a brief performance comparison between `QuantumToolbox.jl` and o
 You are most welcome to contribute to `QuantumToolbox.jl` development by forking this repository and sending pull requests (PRs), or filing bug reports at the issues page. You can also help out with users' questions, or discuss proposed changes in the [QuTiP discussion group](https://groups.google.com/g/qutip).
 
 For more information about contribution, including technical advice, please see the [Contributing to QuantumToolbox.jl](https://qutip.org/QuantumToolbox.jl/stable/resources/contributing) section of the documentation.
+
+## Acknowledgements
+
+### Fundings
+
+`QuantumToolbox.jl` is supported by the [Unitary Fund](https://unitary.fund), a grant program for quantum technology projects.
+
+<div align="center">
+  <a href="https://unitary.fund">
+    <img src="https://raw.githubusercontent.com/unitaryfund/unitary.fund/refs/heads/main/src/assets/svg/logo.svg" alt="Unitary Fund logo" width="200">
+  </a>
+</div>
+
+### Other Acknowledgements
+
+We are also grateful to the [Zulip](https://zulip.com) team for providing a free chat service for open-source projects.
+
+<div align="center">
+  <a href="https://zulip.com">
+    <img src="https://zulip.com/static/images/logo/zulip-org-logo.svg" alt="Zulip logo" width="200">
+  </a>
+</div>

docs/make.jl

@@ -76,6 +76,7 @@ const PAGES = [
         "Bibliography" => "resources/bibliography.md",
         "ChangeLog" => "resources/changelog.md",
         "Contributing to QuantumToolbox.jl" => "resources/contributing.md",
+        "Acknowledgements" => "resources/acknowledgements.md",
     ],
 ]
 

docs/src/resources/acknowledgements.md

@@ -0,0 +1,21 @@
+# [Acknowledgements](@id doc:Acknowledgements)
+
+## [Fundings](@id doc:Fundings)
+
+`QuantumToolbox.jl` is supported by the [Unitary Fund](https://unitary.fund), a grant program for quantum technology projects.
+
+<div align="center">
+  <a href="https://unitary.fund">
+    <img src="https://raw.githubusercontent.com/unitaryfund/unitary.fund/refs/heads/main/src/assets/svg/logo.svg" alt="Unitary Fund logo" width="200">
+  </a>
+</div>
+
+## [Other Acknowledgements](@id doc:Other-Acknowledgements)
+
+We are also grateful to the [Zulip](https://zulip.com) team for providing a free chat service for open-source projects.
+
+<div align="center">
+  <a href="https://zulip.com">
+    <img src="https://zulip.com/static/images/logo/zulip-org-logo.svg" alt="Zulip logo" width="200">
+  </a>
+</div>

src/metrics.jl

@@ -21,12 +21,14 @@ matrix ``\hat{\rho}``.
 Pure state:
 ```jldoctest
 julia> ψ = fock(2,0)
+
 Quantum Object:   type=Ket   dims=[2]   size=(2,)
 2-element Vector{ComplexF64}:
  1.0 + 0.0im
  0.0 + 0.0im
 
 julia> ρ = ket2dm(ψ)
+
 Quantum Object:   type=Operator   dims=[2]   size=(2, 2)   ishermitian=true
 2×2 Matrix{ComplexF64}:
  1.0+0.0im  0.0+0.0im
@@ -39,6 +41,7 @@ julia> entropy_vn(ρ, base=2)
 Mixed state:
 ```jldoctest
 julia> ρ = maximally_mixed_dm(2)
+
 Quantum Object:   type=Operator   dims=[2]   size=(2, 2)   ishermitian=true
 2×2 Diagonal{ComplexF64, Vector{ComplexF64}}:
  0.5-0.0im      ⋅    

src/negativity.jl

@@ -19,6 +19,7 @@ and ``\Vert \hat{X} \Vert_1=\textrm{Tr}\sqrt{\hat{X}^\dagger \hat{X}}`` is the t
 
 ```jldoctest
 julia> Ψ = bell_state(0, 0)
+
 Quantum Object:   type=Ket   dims=[2, 2]   size=(4,)
 4-element Vector{ComplexF64}:
  0.7071067811865475 + 0.0im
@@ -27,6 +28,7 @@ Quantum Object:   type=Ket   dims=[2, 2]   size=(4,)
  0.7071067811865475 + 0.0im
 
 julia> ρ = ket2dm(Ψ)
+
 Quantum Object:   type=Operator   dims=[2, 2]   size=(4, 4)   ishermitian=true
 4×4 Matrix{ComplexF64}:
  0.5+0.0im  0.0+0.0im  0.0+0.0im  0.5+0.0im

src/qobj/arithmetic_and_attributes.jl

@@ -287,6 +287,7 @@ Note that this function only supports for [`Operator`](@ref) and [`SuperOperator
 
 ```jldoctest
 julia> a = destroy(20)
+
 Quantum Object:   type=Operator   dims=[20]   size=(20, 20)   ishermitian=false
 20×20 SparseMatrixCSC{ComplexF64, Int64} with 19 stored entries:
 ⎡⠈⠢⡀⠀⠀⠀⠀⠀⠀⠀⎤
@@ -327,6 +328,7 @@ Return the standard vector `p`-norm or [Schatten](https://en.wikipedia.org/wiki/
 
 ```jldoctest
 julia> ψ = fock(10, 2)
+
 Quantum Object:   type=Ket   dims=[10]   size=(10,)
 10-element Vector{ComplexF64}:
  0.0 + 0.0im
@@ -551,6 +553,7 @@ Note that this function will always return [`Operator`](@ref). No matter the inp
 Two qubits in the state ``\ket{\psi} = \ket{e,g}``:
 ```jldoctest
 julia> ψ = kron(fock(2,0), fock(2,1))
+
 Quantum Object:   type=Ket   dims=[2, 2]   size=(4,)
 4-element Vector{ComplexF64}:
  0.0 + 0.0im
@@ -559,6 +562,7 @@ Quantum Object:   type=Ket   dims=[2, 2]   size=(4,)
  0.0 + 0.0im
 
 julia> ptrace(ψ, 2)
+
 Quantum Object:   type=Operator   dims=[2]   size=(2, 2)   ishermitian=true
 2×2 Matrix{ComplexF64}:
  0.0+0.0im  0.0+0.0im
@@ -568,6 +572,7 @@ Quantum Object:   type=Operator   dims=[2]   size=(2, 2)   ishermitian=true
 or in an entangled state ``\ket{\psi} = \frac{1}{\sqrt{2}} \left( \ket{e,e} + \ket{g,g} \right)``:
 ```jldoctest
 julia> ψ = 1 / √2 * (kron(fock(2,0), fock(2,0)) + kron(fock(2,1), fock(2,1)))
+
 Quantum Object:   type=Ket   dims=[2, 2]   size=(4,)
 4-element Vector{ComplexF64}:
  0.7071067811865475 + 0.0im
@@ -576,6 +581,7 @@ Quantum Object:   type=Ket   dims=[2, 2]   size=(4,)
  0.7071067811865475 + 0.0im
 
 julia> ptrace(ψ, 1)
+
 Quantum Object:   type=Operator   dims=[2]   size=(2, 2)   ishermitian=true
 2×2 Matrix{ComplexF64}:
  0.5+0.0im  0.0+0.0im

src/qobj/eigsolve.jl

@@ -54,11 +54,13 @@ julia> λ
 
 julia> ψ
 2-element Vector{QuantumObject{Vector{ComplexF64}, KetQuantumObject, Dimensions{1}}}:
- Quantum Object:   type=Ket   dims=[2]   size=(2,)
+
+Quantum Object:   type=Ket   dims=[2]   size=(2,)
 2-element Vector{ComplexF64}:
  -0.7071067811865475 + 0.0im
   0.7071067811865475 + 0.0im
- Quantum Object:   type=Ket   dims=[2]   size=(2,)
+
+Quantum Object:   type=Ket   dims=[2]   size=(2,)
 2-element Vector{ComplexF64}:
  0.7071067811865475 + 0.0im
  0.7071067811865475 + 0.0im

src/qobj/functions.jl

@@ -161,6 +161,7 @@ Returns the [Kronecker product](https://en.wikipedia.org/wiki/Kronecker_product)
 
 ```jldoctest
 julia> a = destroy(20)
+
 Quantum Object:   type=Operator   dims=[20]   size=(20, 20)   ishermitian=false
 20×20 SparseMatrixCSC{ComplexF64, Int64} with 19 stored entries:
 ⎡⠈⠢⡀⠀⠀⠀⠀⠀⠀⠀⎤