Skip to content

Commit 36b70c8

Browse files
avik-palavik-pal
committed
docs: add SciMLJacobianOperators
1 parent 37c56f7 commit 36b70c8

File tree

6 files changed

+100
-23
lines changed

6 files changed

+100
-23
lines changed

‎.JuliaFormatter.toml

-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,3 @@ style = "sciml"
22
format_markdown = true
33
annotate_untyped_fields_with_any = false
44
format_docstrings = true
5-
join_lines_based_on_source = false

‎.github/workflows/Documentation.yml

+11-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,17 @@ jobs:
1717
with:
1818
version: '1'
1919
- name: Install dependencies
20-
run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
20+
run: |
21+
import Pkg
22+
Pkg.Registry.update()
23+
# Install packages present in subdirectories
24+
dev_pks = Pkg.PackageSpec[]
25+
for path in ("lib/SciMLJacobianOperators", ".")
26+
push!(dev_pks, Pkg.PackageSpec(; path))
27+
end
28+
Pkg.develop(dev_pks)
29+
Pkg.instantiate()
30+
shell: julia --color=yes --project=docs/ {0}
2131
- name: Build and deploy
2232
env:
2333
JULIA_DEBUG: "Documenter"

‎docs/Project.toml

+2
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ OrdinaryDiffEq = "1dea7af3-3e70-54e6-95c3-0bf5283fa5ed"
1414
Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
1515
Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
1616
SciMLBase = "0bca4576-84f4-4d90-8ffe-ffa030f20462"
17+
SciMLJacobianOperators = "19f34311-ddf3-4b8b-af20-060888a46c0e"
1718
SimpleNonlinearSolve = "727e6d20-b764-4bd8-a329-72de5adea6c7"
1819
SparseDiffTools = "47a9eef4-7e08-11e9-0b38-333d64bd3804"
1920
StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
@@ -36,6 +37,7 @@ OrdinaryDiffEq = "6"
3637
Plots = "1"
3738
Random = "<0.0.1, 1"
3839
SciMLBase = "2.4"
40+
SciMLJacobianOperators = "0.1"
3941
SimpleNonlinearSolve = "1"
4042
SparseDiffTools = "2.14"
4143
StaticArrays = "1"

‎docs/make.jl

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
using Documenter, DocumenterCitations
22
using NonlinearSolve, SimpleNonlinearSolve, Sundials, SteadyStateDiffEq, SciMLBase,
33
DiffEqBase
4+
using SciMLJacobianOperators
45

56
cp(joinpath(@__DIR__, "Manifest.toml"),
67
joinpath(@__DIR__, "src/assets/Manifest.toml"), force = true)
@@ -13,8 +14,8 @@ bib = CitationBibliography(joinpath(@__DIR__, "src", "refs.bib"))
1314

1415
makedocs(; sitename = "NonlinearSolve.jl",
1516
authors = "Chris Rackauckas",
16-
modules = [NonlinearSolve, SimpleNonlinearSolve,
17-
SteadyStateDiffEq, Sundials, DiffEqBase, SciMLBase],
17+
modules = [NonlinearSolve, SimpleNonlinearSolve, SteadyStateDiffEq,
18+
Sundials, DiffEqBase, SciMLBase, SciMLJacobianOperators],
1819
clean = true,
1920
doctest = false,
2021
linkcheck = true,

‎docs/pages.jl

+55-19
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,61 @@
22

33
pages = ["index.md",
44
"Getting Started with Nonlinear Rootfinding in Julia" => "tutorials/getting_started.md",
5-
"Tutorials" => Any["tutorials/code_optimization.md", "tutorials/large_systems.md",
6-
"tutorials/modelingtoolkit.md", "tutorials/small_compile.md",
7-
"tutorials/iterator_interface.md", "tutorials/optimizing_parameterized_ode.md"],
8-
"Basics" => Any["basics/nonlinear_problem.md", "basics/nonlinear_functions.md",
9-
"basics/solve.md", "basics/nonlinear_solution.md", "basics/autodiff.md",
10-
"basics/termination_condition.md", "basics/diagnostics_api.md",
11-
"basics/sparsity_detection.md", "basics/faq.md"],
12-
"Solver Summaries and Recommendations" => Any["solvers/nonlinear_system_solvers.md",
13-
"solvers/bracketing_solvers.md", "solvers/steady_state_solvers.md",
14-
"solvers/nonlinear_least_squares_solvers.md", "solvers/fixed_point_solvers.md"],
15-
"Native Functionalities" => Any["native/solvers.md", "native/simplenonlinearsolve.md",
16-
"native/steadystatediffeq.md", "native/descent.md",
17-
"native/globalization.md", "native/diagnostics.md"],
5+
"Tutorials" => Any[
6+
"tutorials/code_optimization.md",
7+
"tutorials/large_systems.md",
8+
"tutorials/modelingtoolkit.md",
9+
"tutorials/small_compile.md",
10+
"tutorials/iterator_interface.md",
11+
"tutorials/optimizing_parameterized_ode.md"
12+
],
13+
"Basics" => Any[
14+
"basics/nonlinear_problem.md",
15+
"basics/nonlinear_functions.md",
16+
"basics/solve.md",
17+
"basics/nonlinear_solution.md",
18+
"basics/autodiff.md",
19+
"basics/termination_condition.md",
20+
"basics/diagnostics_api.md",
21+
"basics/sparsity_detection.md",
22+
"basics/faq.md"
23+
],
24+
"Solver Summaries and Recommendations" => Any[
25+
"solvers/nonlinear_system_solvers.md",
26+
"solvers/bracketing_solvers.md",
27+
"solvers/steady_state_solvers.md",
28+
"solvers/nonlinear_least_squares_solvers.md",
29+
"solvers/fixed_point_solvers.md"
30+
],
31+
"Native Functionalities" => Any[
32+
"native/solvers.md",
33+
"native/simplenonlinearsolve.md",
34+
"native/steadystatediffeq.md",
35+
"native/descent.md",
36+
"native/globalization.md",
37+
"native/diagnostics.md"
38+
],
1839
"Wrapped Solver APIs" => Any[
19-
"api/fastlevenbergmarquardt.md", "api/fixedpointacceleration.md",
20-
"api/leastsquaresoptim.md", "api/minpack.md", "api/nlsolve.md", "api/nlsolvers.md",
21-
"api/siamfanlequations.md", "api/speedmapping.md", "api/sundials.md"],
40+
"api/fastlevenbergmarquardt.md",
41+
"api/fixedpointacceleration.md",
42+
"api/leastsquaresoptim.md",
43+
"api/minpack.md",
44+
"api/nlsolve.md",
45+
"api/nlsolvers.md",
46+
"api/siamfanlequations.md",
47+
"api/speedmapping.md",
48+
"api/sundials.md"
49+
],
50+
"Sub-Packages" => Any[
51+
"api/SciMLJacobianOperators.md",
52+
],
2253
"Development Documentation" => [
23-
"devdocs/internal_interfaces.md", "devdocs/linear_solve.md",
24-
"devdocs/jacobian.md", "devdocs/operators.md", "devdocs/algorithm_helpers.md"],
54+
"devdocs/internal_interfaces.md",
55+
"devdocs/linear_solve.md",
56+
"devdocs/jacobian.md",
57+
"devdocs/operators.md",
58+
"devdocs/algorithm_helpers.md"
59+
],
2560
"Release Notes" => "release_notes.md",
26-
"References" => "references.md"]
61+
"References" => "references.md"
62+
]

‎docs/src/api/SciMLJacobianOperators.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
```@meta
2+
CurrentModule = SciMLJacobianOperators
3+
```
4+
5+
# SciMLJacobianOperators.jl
6+
7+
This is a subpackage on NonlinearSolve providing a general purpose JacVec and VecJac
8+
operator built on top on DifferentiationInterface.jl.
9+
10+
```julia
11+
import Pkg
12+
Pkg.add("SciMLJacobianOperators")
13+
using SciMLJacobianOperators
14+
```
15+
16+
## Jacobian API
17+
18+
```@docs
19+
JacobianOperator
20+
VecJacOperator
21+
JacVecOperator
22+
```
23+
24+
## Stateful Operators
25+
26+
```@docs
27+
StatefulJacobianOperator
28+
StatefulJacobianNormalFormOperator
29+
```

0 commit comments

Comments
 (0)