Add sesolve_map docstring

Author: albertomercurio

src/time_evolution/sesolve.jl

@@ -178,12 +178,52 @@ function _gen_sesolve_solution(sol, times, dimensions)
 end
 
 @doc raw"""
-    sesolve_map
+    sesolve_map(
+        H::Union{AbstractQuantumObject{Operator},Tuple},
+        ψ0::Union{QuantumObject{Ket},AbstractVector{<:QuantumObject{Ket}}},
+        tlist::AbstractVector;
+        alg::OrdinaryDiffEqAlgorithm = Tsit5(),
+        ensemblealg::EnsembleAlgorithm = EnsembleThreads(),
+        e_ops::Union{Nothing,AbstractVector,Tuple} = nothing,
+        params::Tuple = (NullParameters(),),
+        progress_bar::Union{Val,Bool} = Val(true),
+        kwargs...,
+    )
+
+Solve the Schrödinger equation for multiple initial states and parameter sets using ensemble simulation.
 
-(TBA)
+This function computes the time evolution for all combinations (Cartesian product) of initial states and parameter sets, solving the Schrödinger equation (see [`sesolve`](@ref)):
+
+```math
+\frac{\partial}{\partial t} |\psi(t)\rangle = -i \hat{H} |\psi(t)\rangle
+```
+
+for each combination in the ensemble.
+
+# Arguments
+
+- `H`: Hamiltonian of the system ``\hat{H}``. It can be either a [`QuantumObject`](@ref), a [`QuantumObjectEvolution`](@ref), or a `Tuple` of operator-function pairs.
+- `ψ0`: Initial state(s) of the system. Can be a single [`QuantumObject`](@ref) or a `Vector` of initial states.
+- `tlist`: List of time points at which to save either the state or the expectation values of the system.
+- `alg`: The algorithm for the ODE solver. The default is `Tsit5()`.
+- `ensemblealg`: Ensemble algorithm to use for parallel computation. Default is `EnsembleThreads()`.
+- `e_ops`: List of operators for which to calculate expectation values. It can be either a `Vector` or a `Tuple`.
+- `params`: A `Tuple` of parameter sets. Each element should be an `AbstractVector` representing the sweep range for that parameter. The function will solve for all combinations of initial states and parameter sets.
+- `progress_bar`: Whether to show the progress bar. Using non-`Val` types might lead to type instabilities.
+- `kwargs`: The keyword arguments for the ODEProblem.
+
+# Notes
+
+- The function returns an array of solutions with dimensions matching the Cartesian product of initial states and parameter sets.
+- If `ψ0` is a vector of `m` states and `params = (p1, p2, ...)` where `p1` has length `n1`, `p2` has length `n2`, etc., the output will be of size `(m, n1, n2, ...)`.
+- See [`sesolve`](@ref) for more details.
+
+# Returns
+
+- An array of [`TimeEvolutionSol`](@ref) objects with dimensions `(length(ψ0), length(params[1]), length(params[2]), ...)`.
 """
 function sesolve_map(
-    H::Union{QuantumObjectEvolution{Operator},Tuple},
+    H::Union{AbstractQuantumObject{Operator},Tuple},
     ψ0::AbstractVector{<:QuantumObject{Ket}},
     tlist::AbstractVector;
     alg::OrdinaryDiffEqAlgorithm = Tsit5(),