docs: add SciMLJacobianOperators

SciML · Sep 24, 2024 · 36b70c8 · 36b70c8
1 parent 37c56f7
commit 36b70c8
Show file tree

Hide file tree

Showing 6 changed files with 100 additions and 23 deletions.
diff --git a/.JuliaFormatter.toml b/.JuliaFormatter.toml
@@ -2,4 +2,3 @@ style = "sciml"
 format_markdown = true
 annotate_untyped_fields_with_any = false
 format_docstrings = true
-join_lines_based_on_source = false
diff --git a/.github/workflows/Documentation.yml b/.github/workflows/Documentation.yml
@@ -17,7 +17,17 @@ jobs:
         with:
           version: '1'
       - name: Install dependencies
-        run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
+        run: |
+          import Pkg
+          Pkg.Registry.update()
+          # Install packages present in subdirectories
+          dev_pks = Pkg.PackageSpec[]
+          for path in ("lib/SciMLJacobianOperators", ".")
+              push!(dev_pks, Pkg.PackageSpec(; path))
+          end
+          Pkg.develop(dev_pks)
+          Pkg.instantiate()
+        shell: julia --color=yes --project=docs/ {0}
       - name: Build and deploy
         env:
           JULIA_DEBUG: "Documenter"

diff --git a/docs/Project.toml b/docs/Project.toml
@@ -14,6 +14,7 @@ OrdinaryDiffEq = "1dea7af3-3e70-54e6-95c3-0bf5283fa5ed"
 Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
 SciMLBase = "0bca4576-84f4-4d90-8ffe-ffa030f20462"
+SciMLJacobianOperators = "19f34311-ddf3-4b8b-af20-060888a46c0e"
 SimpleNonlinearSolve = "727e6d20-b764-4bd8-a329-72de5adea6c7"
 SparseDiffTools = "47a9eef4-7e08-11e9-0b38-333d64bd3804"
 StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
@@ -36,6 +37,7 @@ OrdinaryDiffEq = "6"
 Plots = "1"
 Random = "<0.0.1, 1"
 SciMLBase = "2.4"
+SciMLJacobianOperators = "0.1"
 SimpleNonlinearSolve = "1"
 SparseDiffTools = "2.14"
 StaticArrays = "1"

diff --git a/docs/make.jl b/docs/make.jl
@@ -1,6 +1,7 @@
 using Documenter, DocumenterCitations
 using NonlinearSolve, SimpleNonlinearSolve, Sundials, SteadyStateDiffEq, SciMLBase,
       DiffEqBase
+using SciMLJacobianOperators
 
 cp(joinpath(@__DIR__, "Manifest.toml"),
     joinpath(@__DIR__, "src/assets/Manifest.toml"), force = true)
@@ -13,8 +14,8 @@ bib = CitationBibliography(joinpath(@__DIR__, "src", "refs.bib"))
 
 makedocs(; sitename = "NonlinearSolve.jl",
     authors = "Chris Rackauckas",
-    modules = [NonlinearSolve, SimpleNonlinearSolve,
-        SteadyStateDiffEq, Sundials, DiffEqBase, SciMLBase],
+    modules = [NonlinearSolve, SimpleNonlinearSolve, SteadyStateDiffEq,
+        Sundials, DiffEqBase, SciMLBase, SciMLJacobianOperators],
     clean = true,
     doctest = false,
     linkcheck = true,

diff --git a/docs/pages.jl b/docs/pages.jl
@@ -2,25 +2,61 @@
 
 pages = ["index.md",
     "Getting Started with Nonlinear Rootfinding in Julia" => "tutorials/getting_started.md",
-    "Tutorials" => Any["tutorials/code_optimization.md", "tutorials/large_systems.md",
-        "tutorials/modelingtoolkit.md", "tutorials/small_compile.md",
-        "tutorials/iterator_interface.md", "tutorials/optimizing_parameterized_ode.md"],
-    "Basics" => Any["basics/nonlinear_problem.md", "basics/nonlinear_functions.md",
-        "basics/solve.md", "basics/nonlinear_solution.md", "basics/autodiff.md",
-        "basics/termination_condition.md", "basics/diagnostics_api.md",
-        "basics/sparsity_detection.md", "basics/faq.md"],
-    "Solver Summaries and Recommendations" => Any["solvers/nonlinear_system_solvers.md",
-        "solvers/bracketing_solvers.md", "solvers/steady_state_solvers.md",
-        "solvers/nonlinear_least_squares_solvers.md", "solvers/fixed_point_solvers.md"],
-    "Native Functionalities" => Any["native/solvers.md", "native/simplenonlinearsolve.md",
-        "native/steadystatediffeq.md", "native/descent.md",
-        "native/globalization.md", "native/diagnostics.md"],
+    "Tutorials" => Any[
+        "tutorials/code_optimization.md",
+        "tutorials/large_systems.md",
+        "tutorials/modelingtoolkit.md",
+        "tutorials/small_compile.md",
+        "tutorials/iterator_interface.md",
+        "tutorials/optimizing_parameterized_ode.md"
+    ],
+    "Basics" => Any[
+        "basics/nonlinear_problem.md",
+        "basics/nonlinear_functions.md",
+        "basics/solve.md",
+        "basics/nonlinear_solution.md",
+        "basics/autodiff.md",
+        "basics/termination_condition.md",
+        "basics/diagnostics_api.md",
+        "basics/sparsity_detection.md",
+        "basics/faq.md"
+    ],
+    "Solver Summaries and Recommendations" => Any[
+        "solvers/nonlinear_system_solvers.md",
+        "solvers/bracketing_solvers.md",
+        "solvers/steady_state_solvers.md",
+        "solvers/nonlinear_least_squares_solvers.md",
+        "solvers/fixed_point_solvers.md"
+    ],
+    "Native Functionalities" => Any[
+        "native/solvers.md",
+        "native/simplenonlinearsolve.md",
+        "native/steadystatediffeq.md",
+        "native/descent.md",
+        "native/globalization.md",
+        "native/diagnostics.md"
+    ],
     "Wrapped Solver APIs" => Any[
-        "api/fastlevenbergmarquardt.md", "api/fixedpointacceleration.md",
-        "api/leastsquaresoptim.md", "api/minpack.md", "api/nlsolve.md", "api/nlsolvers.md",
-        "api/siamfanlequations.md", "api/speedmapping.md", "api/sundials.md"],
+        "api/fastlevenbergmarquardt.md",
+        "api/fixedpointacceleration.md",
+        "api/leastsquaresoptim.md",
+        "api/minpack.md",
+        "api/nlsolve.md",
+        "api/nlsolvers.md",
+        "api/siamfanlequations.md",
+        "api/speedmapping.md",
+        "api/sundials.md"
+    ],
+    "Sub-Packages" => Any[
+        "api/SciMLJacobianOperators.md",
+    ],
     "Development Documentation" => [
-        "devdocs/internal_interfaces.md", "devdocs/linear_solve.md",
-        "devdocs/jacobian.md", "devdocs/operators.md", "devdocs/algorithm_helpers.md"],
+        "devdocs/internal_interfaces.md",
+        "devdocs/linear_solve.md",
+        "devdocs/jacobian.md",
+        "devdocs/operators.md",
+        "devdocs/algorithm_helpers.md"
+    ],
     "Release Notes" => "release_notes.md",
-    "References" => "references.md"]
+    "References" => "references.md"
+]
diff --git a/docs/src/api/SciMLJacobianOperators.md b/docs/src/api/SciMLJacobianOperators.md
@@ -0,0 +1,29 @@
+```@meta
+CurrentModule = SciMLJacobianOperators
+```
+
+# SciMLJacobianOperators.jl
+
+This is a subpackage on NonlinearSolve providing a general purpose JacVec and VecJac
+operator built on top on DifferentiationInterface.jl.
+
+```julia
+import Pkg
+Pkg.add("SciMLJacobianOperators")
+using SciMLJacobianOperators
+```
+
+## Jacobian API
+
+```@docs
+JacobianOperator
+VecJacOperator
+JacVecOperator
+```
+
+## Stateful Operators
+
+```@docs
+StatefulJacobianOperator
+StatefulJacobianNormalFormOperator
+```