Skip to content

Commit c0aa786

Browse files
ChrisRackauckas-ClaudeChrisRackauckasclaude
authored
Fix docs build: add git [sources] for unregistered QuadDIRECT (#1232)
* Fix docs build: add git [sources] entry for unregistered QuadDIRECT The Documentation workflow fails at the very first instantiate step (`Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()`) with: ERROR: expected package `QuadDIRECT [dae52e8d]` to be registered `docs/Project.toml` lists `QuadDIRECT` (and `OptimizationQuadDIRECT`, which depends on it) in `[deps]`, but `QuadDIRECT` is not registered in General and had no `[sources]` entry, so the docs environment could not resolve. Add a git `[sources]` entry pointing at the upstream repo, the same source the docs page already instructs users to add manually. Verified locally on Julia 1.12 (the docs CI channel): the docs environment now resolves and instantiates; QuadDIRECT is pulled from https://github.com/timholy/QuadDIRECT.jl.git and OptimizationQuadDIRECT resolves against it. Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com> Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * Fix docs build: SimpleOptimization linesearch API + dead doc links The QuadDIRECT [sources] fix got the docs build past instantiate, which then surfaced pre-existing makedocs errors [:example_block, :linkcheck]. - lib/SimpleOptimization: SimpleBFGS/SimpleLBFGS passed the obsolete `linesearch = Val(false)` to SimpleBroyden/SimpleLimitedMemoryBroyden. SimpleNonlinearSolve v2.x's `linesearch` keyword is `Union{Nothing, LineSearch.AbstractLineSearchAlgorithm}` and rejects `Val{false}` with a TypeError; `nothing` is the documented "no line search" value. This also fixes the sublibrary's own (red) Core tests. - evolutionary.md: Evolutionary.jl moved wildart -> SciML; the four wildart.github.io/Evolutionary.jl/stable/{ga,de,es,cmaes}/ links 404. Repoint to sciml.github.io and the repo links to github.com/SciML. - nlopt.md: http://ab-initio.mit.edu/nlopt/ is dead (linkcheck timeout); repoint the NLopt library link to https://nlopt.readthedocs.io/en/latest/. Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com> Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> --------- Co-authored-by: ChrisRackauckas-Claude <accounts@chrisrackauckas.com> Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent f48a07c commit c0aa786

4 files changed

Lines changed: 12 additions & 9 deletions

File tree

docs/Project.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,9 @@ path = "../lib/OptimizationPyCMA"
130130
[sources.OptimizationQuadDIRECT]
131131
path = "../lib/OptimizationQuadDIRECT"
132132

133+
[sources.QuadDIRECT]
134+
url = "https://github.com/timholy/QuadDIRECT.jl.git"
135+
133136
[sources.OptimizationSciPy]
134137
path = "../lib/OptimizationSciPy"
135138

docs/src/optimization_packages/evolutionary.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Evolutionary.jl
22

3-
[`Evolutionary`](https://github.com/wildart/Evolutionary.jl) is a Julia package implementing various evolutionary and genetic algorithm.
3+
[`Evolutionary`](https://github.com/SciML/Evolutionary.jl) is a Julia package implementing various evolutionary and genetic algorithm.
44

55
## Installation: OptimizationEvolutionary.jl
66

@@ -15,16 +15,16 @@ Pkg.add("OptimizationEvolutionary");
1515

1616
### Without Constraint Equations
1717

18-
The methods in [`Evolutionary`](https://github.com/wildart/Evolutionary.jl) are performing global optimization on problems without
18+
The methods in [`Evolutionary`](https://github.com/SciML/Evolutionary.jl) are performing global optimization on problems without
1919
constraint equations. These methods work both with and without lower and upper constraints set by `lb` and `ub` in the `OptimizationProblem`.
2020

2121
A `Evolutionary` algorithm is called by one of the following:
2222

23-
- [`Evolutionary.GA()`](https://wildart.github.io/Evolutionary.jl/stable/ga/): **Genetic Algorithm optimizer**
23+
- [`Evolutionary.GA()`](https://sciml.github.io/Evolutionary.jl/stable/ga/): **Genetic Algorithm optimizer**
2424

25-
- [`Evolutionary.DE()`](https://wildart.github.io/Evolutionary.jl/stable/de/): **Differential Evolution optimizer**
26-
- [`Evolutionary.ES()`](https://wildart.github.io/Evolutionary.jl/stable/es/): **Evolution Strategy algorithm**
27-
- [`Evolutionary.CMAES()`](https://wildart.github.io/Evolutionary.jl/stable/cmaes/): **Covariance Matrix Adaptation Evolution Strategy algorithm**
25+
- [`Evolutionary.DE()`](https://sciml.github.io/Evolutionary.jl/stable/de/): **Differential Evolution optimizer**
26+
- [`Evolutionary.ES()`](https://sciml.github.io/Evolutionary.jl/stable/es/): **Evolution Strategy algorithm**
27+
- [`Evolutionary.CMAES()`](https://sciml.github.io/Evolutionary.jl/stable/cmaes/): **Covariance Matrix Adaptation Evolution Strategy algorithm**
2828

2929
Algorithm-specific options are defined as `kwargs`. See the respective documentation for more detail.
3030

docs/src/optimization_packages/nlopt.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# NLopt.jl
22

3-
[`NLopt`](https://github.com/jump-dev/NLopt.jl) is Julia package interfacing to the free/open-source [`NLopt library`](http://ab-initio.mit.edu/nlopt/) which implements many optimization methods both global and local [`NLopt Documentation`](https://nlopt.readthedocs.io/en/latest/NLopt_Algorithms/).
3+
[`NLopt`](https://github.com/jump-dev/NLopt.jl) is Julia package interfacing to the free/open-source [`NLopt library`](https://nlopt.readthedocs.io/en/latest/) which implements many optimization methods both global and local [`NLopt Documentation`](https://nlopt.readthedocs.io/en/latest/NLopt_Algorithms/).
44

55
## Installation: OptimizationNLopt.jl
66

lib/SimpleOptimization/src/SimpleOptimization.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ function SciMLBase.__solve(cache::OptimizationCache{O}) where {O <: SimpleLBFGS}
181181
nlprob,
182182
SimpleLimitedMemoryBroyden(;
183183
threshold = __get_threshold(cache.opt),
184-
linesearch = Val(false)
184+
linesearch = nothing
185185
);
186186
maxiters = maxiters,
187187
abstol = abstol,
@@ -222,7 +222,7 @@ function SciMLBase.__solve(cache::OptimizationCache{O}) where {O <: SimpleBFGS}
222222
nlprob = NonlinearProblem(∇f, cache.u0)
223223
nlsol = solve(
224224
nlprob,
225-
SimpleBroyden(; linesearch = Val(false));
225+
SimpleBroyden(; linesearch = nothing);
226226
maxiters = maxiters,
227227
abstol = abstol,
228228
reltol = reltol

0 commit comments

Comments
 (0)