Merge pull request #412 from SciML/sb/docs

docs: fix use of default values in PDESystem
SciML · Sep 8, 2024 · 7d14fbb · 7d14fbb
2 parents d7e1e92 + daa0db0
commit 7d14fbb
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 16 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -5,6 +5,7 @@ cp("./docs/Project.toml", "./docs/src/assets/Project.toml", force = true)
 
 # Make sure that plots don't throw a bunch of warnings / errors!
 ENV["GKSwstype"] = "100"
+ENV["JULIA_DEBUG"] = Documenter
 
 include("pages.jl")
 

diff --git a/docs/pages.jl b/docs/pages.jl
@@ -8,7 +8,7 @@ pages = [
         "tutorials/sispde.md",
         "tutorials/icbc_sampled.md",
         "tutorials/PIDE.md",
-        "tutorials/schroedinger.md",
+        "tutorials/schroedinger.md"
     ],
     "Performance Tips" => "performance.md",
     "MOLFiniteDifference" => "MOLFiniteDifference.md",
@@ -22,15 +22,5 @@ pages = [
     "How it Works" => "howitworks.md",
     "Notes for Developers: Implement a Scheme" => "devnotes.md",
     "Generated Examples" => ["generated/bruss_code.md", "generated/bruss_ode_eqs.md"],
-    "API Reference" => ["api/discretization.md", "api/utils.md"],
-
-    # "Tutorial: Burgers" => "tutorials/burgers.md",
-    # "Tutorial: 1D Linear Diffusion" => "tutorials/1d_linear_diffusion.md",
-    # "Tutorial: 1D Non-Linear Diffusion" => "tutorials/1d_nonlinear_diffusion.md",
-    # "Tutorial: 2D Diffusion" => "tutorials/2d_diffusion.md",
-    # "Tutorial: 1D Linear Convection" => "tutorials/1d_linear_convection.md",
-    # "Tutorial: 1D Higher Order" => "tutorials/1d_higher_order.md",
-    # "Tutorial: Stationary Nonlinear Problems" => "tutorials/stationary_nonlinear_problems.md",
-    # "Tutorial: 1D Partial DAE" => "tutorials/1d_partial_DAE.md",
-
+    "API Reference" => ["api/discretization.md", "api/utils.md"]
 ]
diff --git a/docs/src/tutorials/params.md b/docs/src/tutorials/params.md
@@ -23,7 +23,8 @@ domains = [t ∈ Interval(0.0, 1.0),
     x ∈ Interval(0.0, 1.0)]
 
 @named pdesys = PDESystem(
-    eqs, bcs, domains, [t, x], [u(t, x), v(t, x)], [Dn => 0.5, Dp => 2])
+    eqs, bcs, domains, [t, x], [u(t, x), v(t, x)],
+    [Dn, Dp]; defaults = Dict(Dn => 0.5, Dp => 2.0))
 
 discretization = MOLFiniteDifference([x => 0.1], t)
 
@@ -74,7 +75,8 @@ domains = [t ∈ Interval(0.0, 1.0),
     x ∈ Interval(0.0, 1.0)]
 
 @named pdesys = PDESystem(
-    eqs, bcs, domains, [t, x], [u(t, x), v(t, x)], [Dn => 0.5, Dp => 2.0])
+    eqs, bcs, domains, [t, x], [u(t, x), v(t, x)],
+    [Dn, Dp]; defaults = Dict(Dn => 0.5, Dp => 2.0))
 
 discretization = MOLFiniteDifference([x => 0.1], t)
 

diff --git a/docs/src/tutorials/sispde.md b/docs/src/tutorials/sispde.md
@@ -68,8 +68,8 @@ domains = [t ∈ Interval(0.0, 10.0),
     x ∈ Interval(0.0, 1.0)]
 
 # PDE system
-@named pdesys = PDESystem(eq, bcs, domains, [t, x], [S(t, x), I(t, x)],
-    [dS => 0.5, dI => 0.1, brn => 3, ϵ => 0.1])
+@named pdesys = PDESystem(eq, bcs, domains, [t, x], [S(t, x), I(t, x)], [dS, dI, brn, ϵ];
+    defaults = Dict(dS => 0.5, dI => 0.1, brn => 3, ϵ => 0.1))
 
 # Method of lines discretization
 # Need a small dx here for accuracy