Merge pull request #2518 from SciML/initialize_docs

Add a tutorial for initialization handling

Author: ChrisRackauckas

.github/workflows/Documentation.yml

@@ -28,6 +28,7 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token
           DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key
+          JULIA_DEBUG: "Documenter"
         run: DISPLAY=:0 xvfb-run -s '-screen 0 1024x768x24' julia --project=docs/ --code-coverage=user docs/make.jl
       - uses: julia-actions/julia-processcoverage@v1
       - uses: codecov/codecov-action@v4

NEWS.md

@@ -50,7 +50,7 @@
     the `parameter_dependencies` keyword argument of `ODESystem`, `SDESystem` and `JumpSystem`. The dependent
     parameters are updated whenever other parameters are modified, e.g. in callbacks.
   - Support for `IfElse.jl` has been dropped. `Base.ifelse` can be used instead.
-  - DAE initailization and the solving for consistent initial conditions has been changed to use a customized
+  - DAE initialization and the solving for consistent initial conditions has been changed to use a customized
     initialization solve. This change adds `guess` semantics which are clearly delinated from the behavior of
     the defaults, where `default` (and `u0`) is designed to be always satisfied and error if unsatisfiable,
     while `guess` is an initial guess to the initializer. In previous iterations, initialization with the

docs/pages.jl

@@ -3,6 +3,7 @@ pages = [
     "tutorials/ode_modeling.md",
     "Tutorials" => Any["tutorials/acausal_components.md",
         "tutorials/nonlinear.md",
+        "tutorials/initialization.md",
         "tutorials/optimization.md",
         "tutorials/modelingtoolkitize.md",
         "tutorials/programmatically_generating.md",

docs/src/basics/MTKModel_Connector.md

@@ -140,7 +140,7 @@ julia> @mtkbuild model_c2 = ModelC(; p1 = 2.0)
   - Whenever components are created with `@named` macro, these can be accessed with `.` operator as `subcomponent_name.argname`
   - In the above example, as `k` of `model_a` isn't listed while defining the sub-component in `ModelC`, its default value can't be modified by users. While `k_array` can be set as:
 
-```@example mtkmodel-example
+```julia
 using ModelingToolkit: getdefault
 
 @mtkbuild model_c3 = ModelC(; model_a.k_array = [1.0, 2.0])