Make dummy_control_problem reproducible

Author: goerz

docs/make.jl

@@ -8,21 +8,26 @@ DocMeta.setdocmeta!(
     recursive=true
 )
 
+PROJECT_TOML = Pkg.TOML.parsefile(joinpath(@__DIR__, "..", "Project.toml"))
+VERSION = PROJECT_TOML["version"]
+NAME = PROJECT_TOML["name"]
+AUTHORS = join(PROJECT_TOML["authors"], ", ") * " and contributors"
+GITHUB = "https://github.com/JuliaQuantumControl/QuantumControlTestUtils.jl"
+
+println("Starting makedocs")
+
 makedocs(;
-    modules=[QuantumControlTestUtils],
-    authors="Michael Goerz <mail@michaelgoerz.net",
-    repo="https://github.com/JuliaQuantumControl/QuantumControlTestUtils.jl/blob/{commit}{path}#{line}",
+    authors=AUTHORS,
     sitename="QuantumControlTestUtils.jl",
     format=Documenter.HTML(;
-        prettyurls=get(ENV, "CI", "false") == "true",
+        prettyurls=true,
         canonical="https://JuliaQuantumControl.github.io/QuantumControlTestUtils.jl",
-        edit_link="master",
-        assets=String[]
+        assets=String[],
+        footer="[$NAME.jl]($GITHUB) v$VERSION docs powered by [Documenter.jl](https://github.com/JuliaDocs/Documenter.jl)."
     ),
     pages=["Home" => "index.md",]
 )
 
-deploydocs(;
-    repo="github.com/JuliaQuantumControl/QuantumControlTestUtils.jl",
-    devbranch="master"
-)
+println("Finished makedocs")
+
+deploydocs(; repo="github.com/JuliaQuantumControl/QuantumControlTestUtils.jl")

docs/src/index.md

@@ -4,6 +4,19 @@ CurrentModule = QuantumControlTestUtils
 
 # QuantumControlTestUtils
 
+```@eval
+using Markdown
+using Pkg
+
+VERSION = Pkg.dependencies()[Base.UUID("d3fd27c9-1dfb-4e67-b0c0-90d0d87a1e48")].version
+
+github_badge = "[![Github](https://img.shields.io/badge/JuliaQuantumControl-QuantumControlTestUtils.jl-blue.svg?logo=github)](https://github.com/JuliaQuantumControl/QuantumControlTestUtils.jl)"
+
+version_badge = "![v$VERSION](https://img.shields.io/badge/version-v$VERSION-green.svg)"
+
+Markdown.parse("$github_badge $version_badge")
+```
+
 The [QuantumControlTestUtils](https://github.com/JuliaQuantumControl/QuantumControlTestUtils.jl) package collects methods that are used for testing and benchmarking within the [JuliaQuantumControl](https://github.com/JuliaQuantumControl) organization
 
 ## Exported Functions

src/dummy_problem.jl

@@ -2,6 +2,7 @@ module DummyOptimization
 
 export dummy_control_problem, optimize_with_dummy_method
 
+using Random
 using Printf
 using LinearAlgebra
 
@@ -17,7 +18,7 @@ using ..RandomObjects: random_matrix, random_state_vector
 ```julia
 problem = dummy_control_problem(;
     N=10, n_objectives=1, n_controls=1, n_steps=50, dt=1.0, density=0.5,
-    complex_operators=true, hermitian=true, kwargs...)
+    complex_operators=true, hermitian=true, rng, kwargs...)
 ```
 
 Sets up a control problem with random (sparse) Hermitian matrices.
@@ -36,7 +37,10 @@ Sets up a control problem with random (sparse) Hermitian matrices.
   1.0. For `density=1.0`, the Hamiltonians will be dense matrices.
 * `complex_operators`: Whether or not the drift/control operators will be
   complex-valued or real-valued.
-* `hermitian`: Whether or not all drift/control operators will be Hermitian matrices.
+* `hermitian`: Whether or not all drift/control operators will be Hermitian
+  matrices.
+* `rng=Random.GLOBAL_RNG`: The random number generator to use.  See
+  [`random_matrix`](@ref) and [`random_state_vector`](@ref).
 * `kwargs`: All other keyword arguments are passed on to
   [`ControlProblem`](@ref)
 """
@@ -49,6 +53,7 @@ function dummy_control_problem(;
     density=0.5,
     complex_operators=true,
     hermitian=true,
+    rng=Random.GLOBAL_RNG,
     kwargs...
 )
 
@@ -61,18 +66,18 @@ function dummy_control_problem(;
     controls = [discretize(pulse, tlist) for pulse in pulses]
 
     hamiltonian = []
-    H_0 = random_matrix(N; density, hermitian, complex=complex_operators)
+    H_0 = random_matrix(N; rng, density, hermitian, complex=complex_operators)
     push!(hamiltonian, H_0)
     for control ∈ controls
-        H_c = random_matrix(N; density, hermitian, complex=complex_operators)
+        H_c = random_matrix(N; rng, density, hermitian, complex=complex_operators)
         push!(hamiltonian, (H_c, control))
     end
 
     objectives = [
         Objective(;
-            initial_state=random_state_vector(N),
+            initial_state=random_state_vector(N; rng),
             generator=tuple(hamiltonian...),
-            target_state=random_state_vector(N)
+            target_state=random_state_vector(N; rng)
         ) for k = 1:n_objectives
     ]
 

test/Project.toml

@@ -9,6 +9,7 @@ JuliaFormatter = "98e50ef6-434e-11e9-1051-2b60c6c9e899"
 Krotov = "b05dcdc7-62f6-4360-bf2c-0898bba419de"
 LiveServer = "16fef848-5104-11e9-1b77-fb7a48bbb589"
 LocalCoverage = "5f6e1e16-694c-5876-87ef-16b5274f298e"
+QuantumCitations = "259add83-af3e-4603-9706-50e341d5574e"
 QuantumControl = "8a270532-f23f-47a8-83a9-b33d10cad486"
 QuantumControlBase = "f10a33bc-5a64-497c-be7b-6f86b4f0c2aa"
 QuantumControlTestUtils = "d3fd27c9-1dfb-4e67-b0c0-90d0d87a1e48"