Merge pull request #16 from ChrisRackauckas-Claude/fix/docs-pages-ordering-map

Fix docs page ordering when new benchmark folders are added

Author: ChrisRackauckas

docs/pages.jl

@@ -37,50 +37,62 @@ for folder in readdir(benchmarksdir)
 end
 
 
-# The result is in alphabetical order, change to the wanted order
-
-permute!(pages,
-    [1, 18, 15, 13, 24, 4, 5, 22, 33, 7, 3, 9, 20, 31, 17, 30, 8, 11, 19, 23, 34, 21, 32, 14, 12, 26, 10, 25, 29, 6, 16, 27, 28, 2, 35, 36]
-)
-
-names = [
-    "SciMLBenchmarks.jl: Benchmarks for Scientific Machine Learning (SciML) and Equation Solvers",
-    "Multi-Language Wrapper Benchmarks",
-    "Linear Solvers",
-    "Interval Rootfinding",
-    "Nonlinear Solvers",
-    "Automatic Differentiation",
-    "Sparse Automatic Differentiation",
-    "Non-Stiff Ordinary Differential Equations (ODEs)",
-    "Stiff Ordinary Differential Equations (ODEs)",
-    "Biological Differential Equations",
-    "Astrochemistry Differential Equations",
-    "Differential-Algebraic Equations (DAEs)",
-    "Non-Stiff Boundary Value Problems (BVPs)",
-    "Stiff Boundary Value Problems (BVPs)",
-    "ModelingToolkit Acausal Modeling / Symbolic-Numeric Benchmarks",
-    "Simple Handwritten Partial Differential Equations (PDEs) as ODEs",
-    "Complicated Partial Differential Equations (PDEs)",
-    "Dynamical ODEs (Hamiltonian and Second Order)",
-    "N-Body Problem Benchmarks",
-    "Non-Stiff Stochastic Differential Equations (SDEs)",
-    "Stiff Stochastic Differential Equations (SDEs)",
-    "Non-Stiff Delay Differential Equations (DDEs)",
-    "Stiff Delay Differential equations (DDEs)",
-    "Jump Process Equations (Gillespie Benchmarks)",
-    "Hybrid (Time-Dependent) Jump Processes",
-    "Nonlinear Optimization Solver Benchmarks",
-    "Global Optimization Benchmarks",
-    "Optimization Framework Benchmarks",
-    "Parameter Estimation and Inverse Problem Benchmarks",
-    "Bayesian Inference and Probabilistic Inverse Problem Benchmarks",
-    "MethodOfLines.jl Partial Differential Equation (PDE) Formulations",
-    "Physics-Informed Neural Network (Neural Network PDE Solver) Cost Function Benchmarks",
-    "Physics-Informed Neural Network (Neural Network PDE Solver) Optimizer Benchmarks",
-    "SDE Adaptivity Benchmarks",
-    "Surrogate Benchmarks",
-    "Symbolic Manipulation Benchmarks"]
-
-for i in 1:length(pages)
-    pages[i] = names[i] => pages[i][2]
-end
+# The result is in alphabetical order, change to the wanted order
+
+section_titles = [
+    "MultiLanguage" => "Multi-Language Wrapper Benchmarks",
+    "LinearSolve" => "Linear Solvers",
+    "IntervalNonlinearProblem" => "Interval Rootfinding",
+    "NonlinearProblem" => "Nonlinear Solvers",
+    "AutomaticDifferentiation" => "Automatic Differentiation",
+    "AutomaticDifferentiationSparse" => "Sparse Automatic Differentiation",
+    "NonStiffODE" => "Non-Stiff Ordinary Differential Equations (ODEs)",
+    "StiffODE" => "Stiff Ordinary Differential Equations (ODEs)",
+    "Bio" => "Biological Differential Equations",
+    "AstroChem" => "Astrochemistry Differential Equations",
+    "DAE" => "Differential-Algebraic Equations (DAEs)",
+    "NonStiffBVP" => "Non-Stiff Boundary Value Problems (BVPs)",
+    "StiffBVP" => "Stiff Boundary Value Problems (BVPs)",
+    "ModelingToolkit" => "ModelingToolkit Acausal Modeling / Symbolic-Numeric Benchmarks",
+    "SimpleHandwrittenPDE" => "Simple Handwritten Partial Differential Equations (PDEs) as ODEs",
+    "ComplicatedPDE" => "Complicated Partial Differential Equations (PDEs)",
+    "DynamicalODE" => "Dynamical ODEs (Hamiltonian and Second Order)",
+    "NBodySimulator" => "N-Body Problem Benchmarks",
+    "NonStiffSDE" => "Non-Stiff Stochastic Differential Equations (SDEs)",
+    "StiffSDE" => "Stiff Stochastic Differential Equations (SDEs)",
+    "NonStiffDDE" => "Non-Stiff Delay Differential Equations (DDEs)",
+    "StiffDDE" => "Stiff Delay Differential equations (DDEs)",
+    "Jumps" => "Jump Process Equations (Gillespie Benchmarks)",
+    "HybridJumps" => "Hybrid (Time-Dependent) Jump Processes",
+    "Optimizaton" => "Nonlinear Optimization Solver Benchmarks",
+    "OptimizationCUTEst" => "CUTEst Optimization Solver Benchmarks",
+    "GlobalOptimization" => "Global Optimization Benchmarks",
+    "OptimizationFrameworks" => "Optimization Framework Benchmarks",
+    "ParameterEstimation" => "Parameter Estimation and Inverse Problem Benchmarks",
+    "BayesianInference" => "Bayesian Inference and Probabilistic Inverse Problem Benchmarks",
+    "MethodOfLinesPDE" => "MethodOfLines.jl Partial Differential Equation (PDE) Formulations",
+    "PINNErrorsVsTime" => "Physics-Informed Neural Network (Neural Network PDE Solver) Cost Function Benchmarks",
+    "PINNOptimizers" => "Physics-Informed Neural Network (Neural Network PDE Solver) Optimizer Benchmarks",
+    "AdaptiveSDE" => "SDE Adaptivity Benchmarks",
+    "Surrogates" => "Surrogate Benchmarks",
+    "Symbolics" => "Symbolic Manipulation Benchmarks"
+]
+
+renamed_index = "SciMLBenchmarks.jl: Benchmarks for Scientific Machine Learning (SciML) and Equation Solvers" =>
+                pages[1][2]
+remaining_pages = Dict{String,Any}(pages[2:end])
+ordered_pages = Any[renamed_index]
+
+for (folder, title) in section_titles
+    if haskey(remaining_pages, folder)
+        push!(ordered_pages, title => remaining_pages[folder])
+        delete!(remaining_pages, folder)
+    end
+end
+
+# Keep docs generation robust when new benchmark folders are added.
+for folder in sort!(collect(keys(remaining_pages)))
+    push!(ordered_pages, folder => remaining_pages[folder])
+end
+
+pages = ordered_pages