Merge pull request #603 from SciML/detailed_solver

setup more detailed solver API pages

Author: ChrisRackauckas

docs/Project.toml

@@ -2,6 +2,7 @@
 BSON = "fbb218c0-5317-5bc6-957e-2ee96dd4b1f0"
 CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"
 DAEProblemLibrary = "dfb8ca35-80a1-48ba-a605-84916a45b4f8"
+DASKR = "165a45c3-f624-5814-8e85-3bdf39a7becd"
 DDEProblemLibrary = "f42792ee-6ffc-4e2a-ae83-8ee2f22de800"
 DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
 DiffEqBase = "2b5f629d-d688-5b77-993f-72d75c75574e"
@@ -21,6 +22,7 @@ Sundials = "c3572dad-4567-51f8-b174-8c6c989267f4"
 BSON = "0.3"
 CSV = "0.10"
 DAEProblemLibrary = "0.1"
+DASKR = "2.9.1"
 DDEProblemLibrary = "0.1"
 DataFrames = "1.4"
 DiffEqBase = "6.106"

docs/make.jl

@@ -15,7 +15,7 @@ makedocs(modules = [
              DDEProblemLibrary,
              DAEProblemLibrary,
              OrdinaryDiffEq,
-             Sundials
+             Sundials,
          ],
          strict = [
              :doctest,

docs/pages.jl

@@ -58,5 +58,6 @@ pages = Any["index.md",
                                          "features/io.md",
                                          "features/low_dep.md",
                                          "features/progress_bar.md"],
-            "Detailed Solver APIs" => Any["api/sundials.md"],
+            "Detailed Solver APIs" => Any["api/sundials.md",
+                                          "api/daskr.md"],
             "Extra Details" => Any["extras/timestepping.md"]]

docs/src/api/daskr.md

@@ -0,0 +1,18 @@
+# [DASKR.jl](@id daskr)
+
+This is a wrapper package for importing solvers from DASKR into the SciML interface.
+DASKR.jl is not automatically included by DifferentialEquations.jl. To use this
+algorithm, you will need to install and use the package:
+
+```julia
+]add DASKR
+using DASKR
+```
+
+These methods can be used independently of the rest of DifferentialEquations.jl.
+
+## DAE Solver APIs
+
+```@docs
+daskr
+```

docs/src/solvers/dae_solve.md

@@ -161,25 +161,8 @@ using DASKR
 
 - `daskr` - This is a wrapper for the well-known DASKR algorithm.
 
-All additional options are available. The constructor is:
-
-```julia
-function daskr(;linear_solver=:Dense,
-                  jac_upper=0,jac_lower=0,max_order = 5,
-                  non_negativity_enforcement = 0,
-                  non_negativity_enforcement_array = nothing,
-                  max_krylov_iters = nothing,
-                  num_krylov_vectors = nothing,
-                  max_number_krylov_restarts = 5,
-                  krylov_convergence_test_constant = 0.05,
-                  exclude_algebraic_errors = false)
-```
-
-Choices for the linear solver are:
-
-- `:Dense`
-- `:Banded`
-- `:SPIGMR`, a Krylov method
+For more details on controlling the DASKR.jl solvers, see the
+[DASKR detailed solver API page](@ref daskr)
 
 ### DASSL.jl