Merge branch 'main' into code-quality-Julia-1

Author: ytdHuang

.github/workflows/CleanPreviewDoc.yml

@@ -4,6 +4,10 @@ on:
   pull_request:
     types: [closed]
 
+permissions:
+    contents: write
+    deployments: write
+
 jobs:
   cleanup-preview-doc:
     runs-on: ubuntu-latest
@@ -23,4 +27,5 @@ jobs:
               git push --force origin gh-pages-new:gh-pages
             fi
         env:
+            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
             PRNUM: ${{ github.event.number }}

.github/workflows/SpellCheck.yml

@@ -10,4 +10,4 @@ jobs:
       - name: Checkout Actions Repository
         uses: actions/checkout@v4
       - name: Check spelling
-        uses: crate-ci/[email protected].5
+        uses: crate-ci/[email protected].7

CHANGELOG.md

@@ -7,11 +7,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased](https://github.com/qutip/QuantumToolbox.jl/tree/main)
 
+- Support for single `AbstractQuantumObject` in `sc_ops` for faster specific method in `ssesolve` and `smesolve`. ([#408])
+- Change save callbacks from `PresetTimeCallback` to `FunctionCallingCallback`. ([#410])
+- Align `eigenstates` and `eigenenergies` to QuTiP. ([#411])
+
+## [v0.27.0]
+Release date: 2025-02-14
+
 - Rename `sparse_to_dense` as `to_dense` and `dense_to_sparse` as `to_sparse`. ([#392])
 - Fix erroneous definition of the stochastic term in `smesolve`. ([#393])
 - Change name of `MultiSiteOperator` to `multisite_operator`. ([#394])
 - Fix `smesolve` for specifying initial state as density matrix. ([#395])
+- Add more generic solver for `steadystate_floquet` to allow more linear solvers. ([#396])
 - Fix time evolution output when using `saveat` keyword argument. ([#398])
+- Align some attributes of `mcsolve`, `ssesolve` and `smesolve` results with `QuTiP`. ([#402])
+- Improve ensemble generation of `ssesolve` and change parameters handling on stochastic processes. ([#403])
+- Set default trajectories to 500 and rename the keyword argument `ensemble_method` to `ensemblealg`. ([#405])
+- Introduce measurement on `ssesolve` and `smesolve`. ([#404])
 
 ## [v0.26.0]
 Release date: 2025-02-09
@@ -89,6 +101,7 @@ Release date: 2024-11-13
 [v0.25.1]: https://github.com/qutip/QuantumToolbox.jl/releases/tag/v0.25.1
 [v0.25.2]: https://github.com/qutip/QuantumToolbox.jl/releases/tag/v0.25.2
 [v0.26.0]: https://github.com/qutip/QuantumToolbox.jl/releases/tag/v0.26.0
+[v0.27.0]: https://github.com/qutip/QuantumToolbox.jl/releases/tag/v0.27.0
 [#86]: https://github.com/qutip/QuantumToolbox.jl/issues/86
 [#139]: https://github.com/qutip/QuantumToolbox.jl/issues/139
 [#271]: https://github.com/qutip/QuantumToolbox.jl/issues/271
@@ -125,4 +138,12 @@ Release date: 2024-11-13
 [#393]: https://github.com/qutip/QuantumToolbox.jl/issues/393
 [#394]: https://github.com/qutip/QuantumToolbox.jl/issues/394
 [#395]: https://github.com/qutip/QuantumToolbox.jl/issues/395
+[#396]: https://github.com/qutip/QuantumToolbox.jl/issues/396
 [#398]: https://github.com/qutip/QuantumToolbox.jl/issues/398
+[#402]: https://github.com/qutip/QuantumToolbox.jl/issues/402
+[#403]: https://github.com/qutip/QuantumToolbox.jl/issues/403
+[#404]: https://github.com/qutip/QuantumToolbox.jl/issues/404
+[#405]: https://github.com/qutip/QuantumToolbox.jl/issues/405
+[#408]: https://github.com/qutip/QuantumToolbox.jl/issues/408
+[#410]: https://github.com/qutip/QuantumToolbox.jl/issues/410
+[#411]: https://github.com/qutip/QuantumToolbox.jl/issues/411

Project.toml

@@ -1,7 +1,7 @@
 name = "QuantumToolbox"
 uuid = "6c2fb7c5-b903-41d2-bc5e-5a7c320b9fab"
 authors = ["Alberto Mercurio", "Yi-Te Huang"]
-version = "0.26.0"
+version = "0.27.0"
 
 [deps]
 ArrayInterface = "4fba245c-0d91-5ea0-9b3e-6abc04ee57a9"
@@ -51,7 +51,7 @@ Graphs = "1.7"
 IncompleteLU = "0.2"
 KernelAbstractions = "0.9.2"
 LinearAlgebra = "1"
-LinearSolve = "2"
+LinearSolve = "2, 3"
 OrdinaryDiffEqCore = "1"
 OrdinaryDiffEqTsit5 = "1"
 Pkg = "1"

benchmarks/eigenvalues.jl

@@ -16,7 +16,8 @@ function benchmark_eigenvalues!(SUITE)
     L = liouvillian(H, c_ops)
 
     SUITE["Eigenvalues"]["eigenstates"]["dense"] = @benchmarkable eigenstates($L)
-    SUITE["Eigenvalues"]["eigenstates"]["sparse"] = @benchmarkable eigenstates($L, sparse = true, sigma = 0.01, k = 5)
+    SUITE["Eigenvalues"]["eigenstates"]["sparse"] =
+        @benchmarkable eigenstates($L, sparse = true, sigma = 0.01, eigvals = 5)
 
     return nothing
 end

benchmarks/timeevolution.jl

@@ -50,7 +50,7 @@ function benchmark_timeevolution!(SUITE)
         ntraj = 100,
         e_ops = $e_ops,
         progress_bar = Val(false),
-        ensemble_method = EnsembleSerial(),
+        ensemblealg = EnsembleSerial(),
     )
     SUITE["Time Evolution"]["time-independent"]["mcsolve"]["Multithreaded"] = @benchmarkable mcsolve(
         $H,
@@ -60,7 +60,7 @@ function benchmark_timeevolution!(SUITE)
         ntraj = 100,
         e_ops = $e_ops,
         progress_bar = Val(false),
-        ensemble_method = EnsembleThreads(),
+        ensemblealg = EnsembleThreads(),
     )
 
     return nothing

docs/make.jl

@@ -34,7 +34,7 @@ const PAGES = [
     "Home" => "index.md",
     "Getting Started" => [
         "Brief Example" => "getting_started/brief_example.md",
-        "Key differences from QuTiP" => "getting_started/qutip_differences.md",
+        # "Key differences from QuTiP" => "getting_started/qutip_differences.md",
         "The Importance of Type-Stability" => "getting_started/type_stability.md",
         "Example: Create QuantumToolbox.jl Logo" => "getting_started/logo.md",
         # "Cite QuantumToolbox.jl" => "getting_started/cite.md",
@@ -51,7 +51,7 @@ const PAGES = [
             "Time Evolution Solutions" => "users_guide/time_evolution/solution.md",
             "Schrödinger Equation Solver" => "users_guide/time_evolution/sesolve.md",
             "Lindblad Master Equation Solver" => "users_guide/time_evolution/mesolve.md",
-            "Monte-Carlo Solver" => "users_guide/time_evolution/mcsolve.md",
+            "Monte Carlo Solver" => "users_guide/time_evolution/mcsolve.md",
             "Stochastic Solver" => "users_guide/time_evolution/stochastic.md",
             "Solving Problems with Time-dependent Hamiltonians" => "users_guide/time_evolution/time_dependent.md",
         ],

docs/src/resources/api.md

@@ -212,11 +212,12 @@ liouvillian_generalized
 
 ```@docs
 steadystate
-steadystate_floquet
+steadystate_fourier
 SteadyStateDirectSolver
 SteadyStateEigenSolver
 SteadyStateLinearSolver
 SteadyStateODESolver
+SSFloquetEffectiveLiouvillian
 ```
 
 ### [Dynamical Shifted Fock method](@id doc-API:Dynamical-Shifted-Fock-method)

docs/src/users_guide/cluster.md

@@ -112,7 +112,7 @@ e_ops = [Sx, Sy, Sz]
 
 tlist = range(0, 10, 100)
 
-sol_mc = mcsolve(H, ψ0, tlist, c_ops, e_ops=e_ops, ntraj=5000, ensemble_method=EnsembleSplitThreads())
+sol_mc = mcsolve(H, ψ0, tlist, c_ops, e_ops=e_ops, ntraj=5000, ensemblealg=EnsembleSplitThreads())
 
 ##
 
@@ -131,7 +131,7 @@ println("Hello! You have $(nworkers()) workers with $(remotecall_fetch(Threads.n
 
 command, we test that the distributed network is correctly initialized. The `remotecall_fetch(Threads.nthreads, 2)` command returns the number of threads of the worker with ID `2`.
 
-We then write the main part of the script, where we define the lattice through the [`Lattice`](@ref) function. We set the parameters and define the Hamiltonian and collapse operators with the [`DissipativeIsing`](@ref) function. We also define the expectation operators `e_ops` and the initial state `ψ0`. Finally, we perform the Monte Carlo quantum trajectories with the [`mcsolve`](@ref) function. The `ensemble_method=EnsembleSplitThreads()` argument is used to parallelize the Monte Carlo quantum trajectories, by splitting the ensemble of trajectories among the workers. For a more detailed explanation of the different ensemble methods, you can check the [official documentation](https://docs.sciml.ai/DiffEqDocs/stable/features/ensemble/) of the [**DifferentialEquations.jl**](https://github.com/SciML/DifferentialEquations.jl/) package. Finally, the `rmprocs(workers())` command is used to remove the workers after the computation is finished.
+We then write the main part of the script, where we define the lattice through the [`Lattice`](@ref) function. We set the parameters and define the Hamiltonian and collapse operators with the [`DissipativeIsing`](@ref) function. We also define the expectation operators `e_ops` and the initial state `ψ0`. Finally, we perform the Monte Carlo quantum trajectories with the [`mcsolve`](@ref) function. The `ensemblealg=EnsembleSplitThreads()` argument is used to parallelize the Monte Carlo quantum trajectories, by splitting the ensemble of trajectories among the workers. For a more detailed explanation of the different ensemble methods, you can check the [official documentation](https://docs.sciml.ai/DiffEqDocs/stable/features/ensemble/) of the [**DifferentialEquations.jl**](https://github.com/SciML/DifferentialEquations.jl/) package. Finally, the `rmprocs(workers())` command is used to remove the workers after the computation is finished.
 
 The output of the script will be printed in the `output.out` file, which contains an output similar to the following:
 

docs/src/users_guide/steadystate.md

@@ -121,4 +121,4 @@ fig
 
 ## Calculate steady state for periodically driven systems
 
-See the docstring of [`steadystate_floquet`](@ref) for more details.
+See the docstring of [`steadystate_fourier`](@ref) for more details.