Change Homepage appearance

docs/make.jl

@@ -12,20 +12,10 @@ const DRAFT = false # set `true` to disable cell evaluation
 
 bib = CitationBibliography(joinpath(@__DIR__, "src", "bibliography.bib"), style=:authoryear)
 
-# const MathEngine = MathJax3(
-#     Dict(
-#         :loader => Dict("load" => ["[tex]/physics"]),
-#         :tex => Dict(
-#             "inlineMath" => [["\$", "\$"], ["\\(", "\\)"]],
-#             "tags" => "ams",
-#             "packages" => ["base", "ams", "autoload", "physics"],
-#         ),
-#     )
-# )
-
 const PAGES = [
+    "Home" => "index.md",
     "Getting Started" => [
-        "Introduction" => "index.md",
+        "Introduction" => "getting_started.md",
         "Key differences from QuTiP" => "qutip_differences.md",
         "The Importance of Type-Stability" => "type_stability.md",
         # "Cite QuantumToolbox.jl" => "cite.md",
@@ -72,24 +62,13 @@ makedocs(;
     repo = Remotes.GitHub("qutip", "QuantumToolbox.jl"),
     sitename = "QuantumToolbox.jl",
     pages = PAGES,
-    # format = Documenter.HTML(;
-    #     prettyurls = get(ENV, "CI", "false") == "true",
-    #     canonical = "https://qutip.github.io/QuantumToolbox.jl",
-    #     edit_link = "main",
-    #     assets = ["assets/favicon.ico"],
-    #     mathengine = MathEngine,
-    #     size_threshold_ignore = ["api.md"],
-    # ),
     format = DocumenterVitepress.MarkdownVitepress(
         repo = "https://qutip.github.io/QuantumToolbox.jl",
-        # deploy_url = "https://qutip.org/QuantumToolbox.jl/",
     ),
     draft = DRAFT,
     plugins = [bib],
 )
 
-# deploydocs(; repo = "github.com/qutip/QuantumToolbox.jl", devbranch = "main")
-
 deploydocs(;
     repo = "github.com/qutip/QuantumToolbox.jl",
     target = "build", # this is where Vitepress stores its output

docs/src/getting_started.md

@@ -0,0 +1,99 @@
+```@meta
+CurrentModule = QuantumToolbox
+```
+
+## [Installation](@id doc:Installation)
+
+!!! note "Requirements"
+    `QuantumToolbox.jl` requires `Julia 1.10+`.
+
+To install `QuantumToolbox.jl`, run the following commands inside Julia's interactive session (also known as REPL):
+```julia
+using Pkg
+Pkg.add("QuantumToolbox")
+```
+Alternatively, this can also be done in Julia's [Pkg REPL](https://julialang.github.io/Pkg.jl/v1/getting-started/) by pressing the key `]` in the REPL to use the package mode, and then type the following command:
+```julia-REPL
+(1.10) pkg> add QuantumToolbox
+```
+More information about `Julia`'s package manager can be found at [`Pkg.jl`](https://julialang.github.io/Pkg.jl/v1/).
+
+To load the package and check the version information, use either [`QuantumToolbox.versioninfo()`](@ref) or [`QuantumToolbox.about()`](@ref), namely
+```julia
+using QuantumToolbox
+QuantumToolbox.versioninfo()
+QuantumToolbox.about()
+```
+
+## Brief Example
+
+We now provide a brief example to demonstrate the similarity between [QuantumToolbox.jl](https://github.com/qutip/QuantumToolbox.jl) and [QuTiP](https://github.com/qutip/qutip).
+
+Let's consider a quantum harmonic oscillator with a Hamiltonian given by:
+
+```math
+\hat{H} = \omega \hat{a}^\dagger \hat{a}
+```
+
+where ``\hat{a}`` and ``\hat{a}^\dagger`` are the annihilation and creation operators, respectively. We can define the Hamiltonian as follows:
+
+```julia
+using QuantumToolbox
+
+N = 20 # cutoff of the Hilbert space dimension
+ω = 1.0 # frequency of the harmonic oscillator
+
+a = destroy(N) # annihilation operator
+
+H = ω * a' * a
+```
+
+We now introduce some losses in a thermal environment, described by the Lindblad master equation:
+
+```math
+\frac{d \hat{\rho}}{dt} = -i [\hat{H}, \hat{\rho}] + \gamma \mathcal{D}[\hat{a}] \hat{\rho}
+```
+
+where ``\hat{\rho}`` is the density matrix, ``\gamma`` is the damping rate, and ``\mathcal{D}[\hat{a}]`` is the Lindblad dissipator, defined as:
+
+```math
+\mathcal{D}[\hat{a}]\hat{\rho} = \hat{a}\hat{\rho}\hat{a}^\dagger - \frac{1}{2}\hat{a}^\dagger\hat{a}\hat{\rho} - \frac{1}{2}\hat{\rho}\hat{a}^\dagger\hat{a}
+```
+
+We now compute the time evolution of the system using the [`mesolve`](@ref) function, starting from the initial state ``\ket{\psi (0)} = \ket{3}``:
+
+```julia
+γ = 0.1 # damping rate
+
+ψ0 = fock(N, 3) # initial state
+
+tlist = range(0, 10, 100) # time list
+
+c_ops = [sqrt(γ) * a]
+e_ops = [a' * a]
+
+sol = mesolve(H, ψ0, tlist, c_ops, e_ops = e_ops)
+```
+
+We can extract the expectation value of the number operator ``\hat{a}^\dagger \hat{a}`` with the command `sol.expect`, and the states with the command `sol.states`.
+
+### Support for GPU calculation
+
+We can easily pass the computation to the GPU, by simply passing all the `Qobj`s to the GPU:
+
+```julia
+using QuantumToolbox
+using CUDA
+CUDA.allowscalar(false) # Avoid unexpected scalar indexing
+
+a_gpu = cu(destroy(N)) # The only difference in the code is the cu() function
+
+H_gpu = ω * a_gpu' * a_gpu
+
+ψ0_gpu = cu(fock(N, 3))
+
+c_ops = [sqrt(γ) * a_gpu]
+e_ops = [a_gpu' * a_gpu]
+
+sol = mesolve(H_gpu, ψ0_gpu, tlist, c_ops, e_ops = e_ops)
+```

docs/src/index.md

@@ -1,115 +1,42 @@
-```@meta
-CurrentModule = QuantumToolbox
-```
-
-# QuantumToolbox.jl Documentation
-
-[QuantumToolbox.jl](https://github.com/qutip/QuantumToolbox.jl) is a cutting-edge Julia package designed for quantum physics simulations, closely emulating the popular Python [QuTiP](https://github.com/qutip/qutip) package. It uniquely combines the simplicity and power of Julia with advanced features like GPU acceleration and distributed computing, making simulation of quantum systems more accessible and efficient.
-
-*With this package, moving from Python to Julia for quantum physics simulations has never been easier*, due to the similar syntax and functionalities.
-
-## Features
-
-QuantumToolbox.jl is equipped with a robust set of features:
-
-- **Quantum State and Operator Manipulation:** Easily handle quantum states and operators with a rich set of tools, with the same functionalities as QuTiP.
-- **Dynamical Evolution:** Advanced solvers for time evolution of quantum systems, thanks to the powerful [DifferentialEquations.jl](https://github.com/SciML/DifferentialEquations.jl) package.
-- **GPU Computing:** Leverage GPU resources for high-performance computing. For example, you run the master equation directly on the GPU with the same syntax as the CPU case.
-- **Distributed Computing:** Distribute the computation over multiple nodes (e.g., a cluster). For example, you can run undreds of quantum trajectories in parallel on a cluster, with, again, the same syntax as the simple case.
-- **Easy Extension:** Easily extend the package, taking advantage of the Julia language features, like multiple dispatch and metaprogramming.
-
-## [Installation](@id doc:Installation)
-
-!!! note "Requirements"
-    `QuantumToolbox.jl` requires `Julia 1.10+`.
-
-To install `QuantumToolbox.jl`, run the following commands inside Julia's interactive session (also known as REPL):
-```julia
-using Pkg
-Pkg.add("QuantumToolbox")
-```
-Alternatively, this can also be done in Julia's [Pkg REPL](https://julialang.github.io/Pkg.jl/v1/getting-started/) by pressing the key `]` in the REPL to use the package mode, and then type the following command:
-```julia-REPL
-(1.10) pkg> add QuantumToolbox
-```
-More information about `Julia`'s package manager can be found at [`Pkg.jl`](https://julialang.github.io/Pkg.jl/v1/).
-
-To load the package and check the version information, use either [`QuantumToolbox.versioninfo()`](@ref) or [`QuantumToolbox.about()`](@ref), namely
-```julia
-using QuantumToolbox
-QuantumToolbox.versioninfo()
-QuantumToolbox.about()
-```
-
-## Brief Example
-
-We now provide a brief example to demonstrate the similarity between [QuantumToolbox.jl](https://github.com/qutip/QuantumToolbox.jl) and [QuTiP](https://github.com/qutip/qutip).
-
-Let's consider a quantum harmonic oscillator with a Hamiltonian given by:
-
-```math
-\hat{H} = \omega \hat{a}^\dagger \hat{a}
-```
-
-where ``\hat{a}`` and ``\hat{a}^\dagger`` are the annihilation and creation operators, respectively. We can define the Hamiltonian as follows:
-
-```julia
-using QuantumToolbox
-
-N = 20 # cutoff of the Hilbert space dimension
-ω = 1.0 # frequency of the harmonic oscillator
-
-a = destroy(N) # annihilation operator
-
-H = ω * a' * a
-```
-
-We now introduce some losses in a thermal environment, described by the Lindblad master equation:
-
-```math
-\frac{d \hat{\rho}}{dt} = -i [\hat{H}, \hat{\rho}] + \gamma \mathcal{D}[\hat{a}] \hat{\rho}
-```
-
-where ``\hat{\rho}`` is the density matrix, ``\gamma`` is the damping rate, and ``\mathcal{D}[\hat{a}]`` is the Lindblad dissipator, defined as:
-
-```math
-\mathcal{D}[\hat{a}]\hat{\rho} = \hat{a}\hat{\rho}\hat{a}^\dagger - \frac{1}{2}\hat{a}^\dagger\hat{a}\hat{\rho} - \frac{1}{2}\hat{\rho}\hat{a}^\dagger\hat{a}
-```
-
-We now compute the time evolution of the system using the [`mesolve`](@ref) function, starting from the initial state ``\ket{\psi (0)} = \ket{3}``:
-
-```julia
-γ = 0.1 # damping rate
-
-ψ0 = fock(N, 3) # initial state
-
-tlist = range(0, 10, 100) # time list
-
-c_ops = [sqrt(γ) * a]
-e_ops = [a' * a]
-
-sol = mesolve(H, ψ0, tlist, c_ops, e_ops = e_ops)
-```
-
-We can extract the expectation value of the number operator ``\hat{a}^\dagger \hat{a}`` with the command `sol.expect`, and the states with the command `sol.states`.
-
-### Support for GPU calculation
-
-We can easily pass the computation to the GPU, by simply passing all the `Qobj`s to the GPU:
-
-```julia
-using QuantumToolbox
-using CUDA
-CUDA.allowscalar(false) # Avoid unexpected scalar indexing
-
-a_gpu = cu(destroy(N)) # The only difference in the code is the cu() function
-
-H_gpu = ω * a_gpu' * a_gpu
-
-ψ0_gpu = cu(fock(N, 3))
-
-c_ops = [sqrt(γ) * a_gpu]
-e_ops = [a_gpu' * a_gpu]
-
-sol = mesolve(H_gpu, ψ0_gpu, tlist, c_ops, e_ops = e_ops)
-```
+```@raw html
+---
+# https://vitepress.dev/reference/default-theme-home-page
+layout: home
+
+hero:
+  name: "QuantumToolbox.jl"
+  tagline: High-performance quantum simulations made simple
+  image:
+    src: /logo.png
+    alt: QuantumToolbox
+  actions:
+    - theme: brand
+      text: Getting Started
+      link: /getting_started
+    - theme: alt
+      text: View on Github
+      link: https://github.com/qutip/QuantumToolbox.jl
+    - theme: alt
+      text: API
+      link: /api
+
+
+features:
+  - icon: <img width="64" height="64" src="https://docs.sciml.ai/DiffEqDocs/stable/assets/logo.png" alt="markdown"/>
+    title: Dynamical Evolution
+    details: Advanced solvers for time evolution of quantum systems, thanks to the powerful DifferentialEquations.jl package.
+    link: /users_guide/time_evolution/intro
+  - icon: <img width="64" height="64" src="https://cuda.juliagpu.org/stable/assets/logo.png" />
+    title: GPU Computing
+    details: Leverage GPU resources for high-performance computing. Simulate the master equation directly on the GPU with the same syntax as the CPU case.
+    link: /getting_started
+  - icon: <img width="64" height="64" src="https://img.icons8.com/?size=100&id=1W4Bkj363ov0&format=png&color=000000" />
+    title: Distributed Computing
+    details: Distribute the computation over multiple nodes (e.g., a cluster). Simulate undreds of quantum trajectories in parallel on a cluster, with, again, the same syntax as the simple case.
+    link: /users_guide/time_evolution/mcsolve
+---
+```
+
+[QuantumToolbox.jl](https://github.com/qutip/QuantumToolbox.jl) is a cutting-edge Julia package designed for quantum physics simulations, closely emulating the popular Python [QuTiP](https://github.com/qutip/qutip) package. It uniquely combines the simplicity and power of Julia with advanced features like GPU acceleration and distributed computing, making simulation of quantum systems more accessible and efficient. Taking advantage of the Julia language features (like multiple dispatch and metaprogramming), QuantumToolbox.jl is designed to be easily extendable, allowing users to build upon the existing functionalities.
+
+*__With this package, moving from Python to Julia for quantum physics simulations has never been easier__*, due to the similar syntax and functionalities.