Skip to content

Commit

Permalink
Remove QuantumControlBase
Browse files Browse the repository at this point in the history
  • Loading branch information
goerz committed Sep 2, 2024
1 parent b866b53 commit a6695be
Show file tree
Hide file tree
Showing 8 changed files with 15 additions and 21 deletions.
4 changes: 2 additions & 2 deletions Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ version = "0.1.1+dev"
Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
QuantumControlBase = "f10a33bc-5a64-497c-be7b-6f86b4f0c2aa"
QuantumControl = "8a270532-f23f-47a8-83a9-b33d10cad486"
QuantumGradientGenerators = "a563f35e-61db-434d-8c01-8b9e3ccdfd85"

[weakdeps]
Expand All @@ -19,6 +19,6 @@ ParameterizedQuantumControlOptimizationExt = "Optimization"
[compat]
LinearAlgebra = "1"
Optimization = "3"
QuantumControlBase = ">=0.9.0"
QuantumControl = ">=0.10.0"
QuantumGradientGenerators = ">=0.1.4"
julia = "1.9"
2 changes: 1 addition & 1 deletion docs/example/3wavemixing.jl
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
using QuantumControl.Interfaces: check_generator
using ComponentArrays: ComponentVector, Axis
using QuantumControl.Controls: get_parameters
using QuantumControlBase.QuantumPropagators: propagate
using QuantumControl.QuantumPropagators: propagate
import OrdinaryDiffEq
using UnPack: @unpack

Expand Down
9 changes: 2 additions & 7 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ if DOCUMENTER_VERSION <= v"1.3.0"
Pkg.develop("Documenter")
end

using QuantumControlBase
using QuantumControl
using QuantumPropagators
using ParameterizedQuantumControl
using Documenter
Expand All @@ -31,7 +31,7 @@ end

links = InterLinks(
"Julia" => "https://docs.julialang.org/en/v1/",
"QuantumControlBase" => "https://juliaquantumcontrol.github.io/QuantumControlBase.jl/$DEV_OR_STABLE",
"QuantumControl" => "https://juliaquantumcontrol.github.io/QuantumControl.jl/$DEV_OR_STABLE",
"QuantumPropagators" => "https://juliaquantumcontrol.github.io/QuantumPropagators.jl/$DEV_OR_STABLE",
"QuantumGradientGenerators" => "https://juliaquantumcontrol.github.io/QuantumGradientGenerators.jl/$DEV_OR_STABLE",
"QuantumControl" => "https://juliaquantumcontrol.github.io/QuantumControl.jl/$DEV_OR_STABLE",
Expand All @@ -44,16 +44,11 @@ links = InterLinks(
)

fallbacks = ExternalFallbacks(
"QuantumControlBase.ControlProblem" => "@extref QuantumControl :jl:type:`QuantumControlBase.ControlProblem`",
"QuantumControl.ControlProblem" => "@extref QuantumControl :jl:type:`QuantumControlBase.ControlProblem`",
"ControlProblem" => "@extref QuantumControl :jl:type:`QuantumControlBase.ControlProblem`",
"Trajectory" => "@extref QuantumControl :jl:type:`QuantumControlBase.Trajectory`",
"get_parameters" => "@extref QuantumControl :jl:function:`QuantumPropagators.Controls.get_parameters`",
"QuantumControl.Generators.Generator" => "@extref QuantumControl :jl:type:`QuantumPropagators.Generators.Generator`",
"QuantumControl.hamiltonian" => "@extref QuantumControl :jl:function:`QuantumPropagators.Generators.hamiltonian`",
"QuantumControl.liouvillian" => "@extref QuantumControl :jl:function:`QuantumPropagators.Generators.liouvillian`",
"QuantumControl.Controls.ParameterizedFunction" => "@extref QuantumControl :jl:type:`QuantumPropagators.Controls.ParameterizedFunction`",
"QuantumControl.propagate_trajectories" => "@extref QuantumControl :jl:function:`QuantumControlBase.propagate_trajectories`",
"QuantumControl.init_prop" => "@extref QuantumControl :jl:function:`QuantumPropagators.init_prop`",
"QuantumControl.prop_step!" => "@extref QuantumControl :jl:function:`QuantumPropagators.prop_step!`",
)
Expand Down
2 changes: 1 addition & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ pkg> add ParameterizedQuantumControl

* Define a [`QuantumControl.ControlProblem`](@ref) that contains parameterized generators or control fields: [`get_parameters(problem)`](@ref get_parameters) must return a vector of control parameters.

* Call [`QuantumControl.optimize`](@extref QuantumControl `QuantumControlBase.optimize`) using `method=ParameterizedQuantumControl`, and give an appropriate backend and optimizer, e.g.,
* Call [`QuantumControl.optimize`](@extref) using `method=ParameterizedQuantumControl`, and give an appropriate backend and optimizer, e.g.,

```
optimize(
Expand Down
10 changes: 5 additions & 5 deletions src/optimize.jl
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import QuantumControlBase: optimize
import QuantumControl: optimize

using LinearAlgebra
using QuantumControlBase: @threadsif
using QuantumControlBase: set_atexit_save_optimization
using QuantumControlBase: propagate_trajectories
using QuantumControl: @threadsif
using QuantumControl: set_atexit_save_optimization
using QuantumControl: propagate_trajectories


@doc raw"""
Expand All @@ -12,7 +12,7 @@ using ParameterizedQuantumControl
result = optimize(problem; method=ParameterizedQuantumControl, kwargs...)
```
optimizes the given control [`problem`](@ref QuantumControlBase.ControlProblem)
optimizes the given control [`problem`](@ref QuantumControl.ControlProblem)
by varying a set of control parameters in order to minimize the functional
```math
Expand Down
2 changes: 1 addition & 1 deletion src/result.jl
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
using QuantumControlBase.QuantumPropagators.Controls: get_parameters
using QuantumControl.QuantumPropagators.Controls: get_parameters
using Printf
using Dates

Expand Down
6 changes: 3 additions & 3 deletions src/workspace.jl
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import QuantumControlBase
using QuantumControlBase.QuantumPropagators.Controls: get_parameters
import QuantumControl
using QuantumControl.QuantumPropagators.Controls: get_parameters


"""Parameterized Optimization Workspace."""
Expand Down Expand Up @@ -38,7 +38,7 @@ mutable struct ParameterizedOptWrk{O}

end

function ParameterizedOptWrk(problem::QuantumControlBase.ControlProblem; verbose=false)
function ParameterizedOptWrk(problem::QuantumControl.ControlProblem; verbose=false)
use_threads = get(problem.kwargs, :use_threads, false)
kwargs = Dict(problem.kwargs) # creates a shallow copy; ok to modify
trajectories = [traj for traj in problem.trajectories]
Expand Down
1 change: 0 additions & 1 deletion test/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ ParameterizedQuantumControl = "409be4c9-afa4-4246-894e-472b92a1ed06"
Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
QuantumControl = "8a270532-f23f-47a8-83a9-b33d10cad486"
QuantumControlBase = "f10a33bc-5a64-497c-be7b-6f86b4f0c2aa"
QuantumControlTestUtils = "d3fd27c9-1dfb-4e67-b0c0-90d0d87a1e48"
QuantumGradientGenerators = "a563f35e-61db-434d-8c01-8b9e3ccdfd85"
QuantumPropagators = "7bf12567-5742-4b91-a078-644e72a65fc1"
Expand Down

0 comments on commit a6695be

Please sign in to comment.