build based on d660156

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.3","generation_timestamp":"2024-05-29T17:55:32","documenter_version":"1.4.1"}}
+{"documenter":{"julia_version":"1.10.3","generation_timestamp":"2024-06-01T02:08:24","documenter_version":"1.4.1"}}

dev/getting_started/find_root/index.html

@@ -65,5 +65,5 @@
 sol = solve(prob, NewtonRaphson())</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">retcode: Success
 u: 2-element Vector{Float64}:
  -2.129924444096732e-29
- -2.398137151871876e-28</code></pre><h3 id="Step-5:-Analyze-the-Solution"><a class="docs-heading-anchor" href="#Step-5:-Analyze-the-Solution">Step 5: Analyze the Solution</a><a id="Step-5:-Analyze-the-Solution-1"></a><a class="docs-heading-anchor-permalink" href="#Step-5:-Analyze-the-Solution" title="Permalink"></a></h3><p>Now let&#39;s check out the solution. First of all, what kind of thing is the <code>sol</code>? We can see that by asking for its type:</p><pre><code class="language-julia hljs">typeof(sol)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">SciMLBase.NonlinearSolution{Float64, 1, Vector{Float64}, Vector{Float64}, SciMLBase.NonlinearProblem{Vector{Float64}, true, ModelingToolkit.MTKParameters{Tuple{Vector{Float64}}, Tuple{}, Tuple{}, Tuple{}, Tuple{}, Nothing, Nothing}, SciMLBase.NonlinearFunction{true, SciMLBase.FullSpecialize, ModelingToolkit.var&quot;#f#529&quot;{RuntimeGeneratedFunctions.RuntimeGeneratedFunction{(:ˍ₋arg1, :ˍ₋arg2), ModelingToolkit.var&quot;#_RGF_ModTag&quot;, ModelingToolkit.var&quot;#_RGF_ModTag&quot;, (0x0bec91c5, 0x7102a3b4, 0x25790b05, 0xeedeb041, 0xb28da2c7), Nothing}, RuntimeGeneratedFunctions.RuntimeGeneratedFunction{(:ˍ₋out, :ˍ₋arg1, :ˍ₋arg2), ModelingToolkit.var&quot;#_RGF_ModTag&quot;, ModelingToolkit.var&quot;#_RGF_ModTag&quot;, (0x85b9a698, 0x76e4b08e, 0x07ba5224, 0xe2c014ba, 0x43cce4c2), Nothing}}, LinearAlgebra.UniformScaling{Bool}, Nothing, Nothing, Nothing, Nothing, Nothing, Nothing, Nothing, Nothing, Nothing, Nothing, ModelingToolkit.var&quot;#generated_observed#532&quot;{ModelingToolkit.NonlinearSystem, Dict{Any, Any}}, Nothing, ModelingToolkit.NonlinearSystem, Nothing}, Base.Pairs{Symbol, Union{}, Tuple{}, @NamedTuple{}}, SciMLBase.StandardNonlinearProblem}, NonlinearSolve.GeneralizedFirstOrderAlgorithm{nothing, :NewtonRaphson, NonlinearSolve.NoLineSearch, Missing, NonlinearSolve.NewtonDescent{Nothing, typeof(NonlinearSolve.DEFAULT_PRECS)}, Nothing, Nothing, Nothing}, Nothing, Nothing, NonlinearSolve.ImmutableNLStats, NonlinearSolve.NonlinearSolveTrace{false, false, NonlinearSolve.TraceMinimal, Nothing, SciMLBase.NonlinearProblem{Vector{Float64}, true, ModelingToolkit.MTKParameters{Tuple{Vector{Float64}}, Tuple{}, Tuple{}, Tuple{}, Tuple{}, Nothing, Nothing}, SciMLBase.NonlinearFunction{true, SciMLBase.FullSpecialize, ModelingToolkit.var&quot;#f#529&quot;{RuntimeGeneratedFunctions.RuntimeGeneratedFunction{(:ˍ₋arg1, :ˍ₋arg2), ModelingToolkit.var&quot;#_RGF_ModTag&quot;, ModelingToolkit.var&quot;#_RGF_ModTag&quot;, (0x0bec91c5, 0x7102a3b4, 0x25790b05, 0xeedeb041, 0xb28da2c7), Nothing}, RuntimeGeneratedFunctions.RuntimeGeneratedFunction{(:ˍ₋out, :ˍ₋arg1, :ˍ₋arg2), ModelingToolkit.var&quot;#_RGF_ModTag&quot;, ModelingToolkit.var&quot;#_RGF_ModTag&quot;, (0x85b9a698, 0x76e4b08e, 0x07ba5224, 0xe2c014ba, 0x43cce4c2), Nothing}}, LinearAlgebra.UniformScaling{Bool}, Nothing, Nothing, Nothing, Nothing, Nothing, Nothing, Nothing, Nothing, Nothing, Nothing, ModelingToolkit.var&quot;#generated_observed#532&quot;{ModelingToolkit.NonlinearSystem, Dict{Any, Any}}, Nothing, ModelingToolkit.NonlinearSystem, Nothing}, Base.Pairs{Symbol, Union{}, Tuple{}, @NamedTuple{}}, SciMLBase.StandardNonlinearProblem}}}</code></pre><p>From this, we can see that it is an <code>NonlinearSolution</code>. We can see the documentation for how to use the <code>NonlinearSolution</code> by checking the <a href="https://docs.sciml.ai/NonlinearSolve/stable/basics/nonlinear_solution/">NonlinearSolve.jl solution type page.</a> For example, the solution is stored as <code>.u</code>. What is the solution to our nonlinear system, and what is the final residual value? We can check it as follows:</p><pre><code class="language-julia hljs"># Analyze the solution
-@show sol[[x,y,z]], sol.resid</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">([-2.129924444096732e-29, -5.537803554651503e-28, -2.398137151871876e-28], [-5.32481111024183e-27, 6.395032404991669e-28])</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../fit_simulation/">« Fit a simulation to a dataset</a><a class="docs-footer-nextpage" href="../../comparisons/python/">Getting Started with Julia&#39;s SciML for the Python User »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Wednesday 29 May 2024 17:55">Wednesday 29 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+ -2.398137151871876e-28</code></pre><h3 id="Step-5:-Analyze-the-Solution"><a class="docs-heading-anchor" href="#Step-5:-Analyze-the-Solution">Step 5: Analyze the Solution</a><a id="Step-5:-Analyze-the-Solution-1"></a><a class="docs-heading-anchor-permalink" href="#Step-5:-Analyze-the-Solution" title="Permalink"></a></h3><p>Now let&#39;s check out the solution. First of all, what kind of thing is the <code>sol</code>? We can see that by asking for its type:</p><pre><code class="language-julia hljs">typeof(sol)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">SciMLBase.NonlinearSolution{Float64, 1, Vector{Float64}, Vector{Float64}, SciMLBase.NonlinearProblem{Vector{Float64}, true, ModelingToolkit.MTKParameters{Tuple{Vector{Float64}}, Tuple{}, Tuple{}, Tuple{}, Tuple{}, Nothing, Nothing}, SciMLBase.NonlinearFunction{true, SciMLBase.FullSpecialize, ModelingToolkit.var&quot;#f#529&quot;{RuntimeGeneratedFunctions.RuntimeGeneratedFunction{(:ˍ₋arg1, :ˍ₋arg2), ModelingToolkit.var&quot;#_RGF_ModTag&quot;, ModelingToolkit.var&quot;#_RGF_ModTag&quot;, (0x0bec91c5, 0x7102a3b4, 0x25790b05, 0xeedeb041, 0xb28da2c7), Nothing}, RuntimeGeneratedFunctions.RuntimeGeneratedFunction{(:ˍ₋out, :ˍ₋arg1, :ˍ₋arg2), ModelingToolkit.var&quot;#_RGF_ModTag&quot;, ModelingToolkit.var&quot;#_RGF_ModTag&quot;, (0x85b9a698, 0x76e4b08e, 0x07ba5224, 0xe2c014ba, 0x43cce4c2), Nothing}}, LinearAlgebra.UniformScaling{Bool}, Nothing, Nothing, Nothing, Nothing, Nothing, Nothing, Nothing, Nothing, Nothing, Nothing, ModelingToolkit.var&quot;#generated_observed#532&quot;{ModelingToolkit.NonlinearSystem, Dict{Any, Any}}, Nothing, ModelingToolkit.NonlinearSystem, Nothing}, Base.Pairs{Symbol, Union{}, Tuple{}, @NamedTuple{}}, SciMLBase.StandardNonlinearProblem}, NonlinearSolve.GeneralizedFirstOrderAlgorithm{nothing, :NewtonRaphson, NonlinearSolve.NoLineSearch, Missing, NonlinearSolve.NewtonDescent{Nothing, typeof(NonlinearSolve.DEFAULT_PRECS)}, Nothing, Nothing, Nothing}, Nothing, Nothing, SciMLBase.NLStats, NonlinearSolve.NonlinearSolveTrace{false, false, NonlinearSolve.TraceMinimal, Nothing, SciMLBase.NonlinearProblem{Vector{Float64}, true, ModelingToolkit.MTKParameters{Tuple{Vector{Float64}}, Tuple{}, Tuple{}, Tuple{}, Tuple{}, Nothing, Nothing}, SciMLBase.NonlinearFunction{true, SciMLBase.FullSpecialize, ModelingToolkit.var&quot;#f#529&quot;{RuntimeGeneratedFunctions.RuntimeGeneratedFunction{(:ˍ₋arg1, :ˍ₋arg2), ModelingToolkit.var&quot;#_RGF_ModTag&quot;, ModelingToolkit.var&quot;#_RGF_ModTag&quot;, (0x0bec91c5, 0x7102a3b4, 0x25790b05, 0xeedeb041, 0xb28da2c7), Nothing}, RuntimeGeneratedFunctions.RuntimeGeneratedFunction{(:ˍ₋out, :ˍ₋arg1, :ˍ₋arg2), ModelingToolkit.var&quot;#_RGF_ModTag&quot;, ModelingToolkit.var&quot;#_RGF_ModTag&quot;, (0x85b9a698, 0x76e4b08e, 0x07ba5224, 0xe2c014ba, 0x43cce4c2), Nothing}}, LinearAlgebra.UniformScaling{Bool}, Nothing, Nothing, Nothing, Nothing, Nothing, Nothing, Nothing, Nothing, Nothing, Nothing, ModelingToolkit.var&quot;#generated_observed#532&quot;{ModelingToolkit.NonlinearSystem, Dict{Any, Any}}, Nothing, ModelingToolkit.NonlinearSystem, Nothing}, Base.Pairs{Symbol, Union{}, Tuple{}, @NamedTuple{}}, SciMLBase.StandardNonlinearProblem}}}</code></pre><p>From this, we can see that it is an <code>NonlinearSolution</code>. We can see the documentation for how to use the <code>NonlinearSolution</code> by checking the <a href="https://docs.sciml.ai/NonlinearSolve/stable/basics/nonlinear_solution/">NonlinearSolve.jl solution type page.</a> For example, the solution is stored as <code>.u</code>. What is the solution to our nonlinear system, and what is the final residual value? We can check it as follows:</p><pre><code class="language-julia hljs"># Analyze the solution
+@show sol[[x,y,z]], sol.resid</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">([-2.129924444096732e-29, -5.537803554651503e-28, -2.398137151871876e-28], [-5.32481111024183e-27, 6.395032404991669e-28])</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../fit_simulation/">« Fit a simulation to a dataset</a><a class="docs-footer-nextpage" href="../../comparisons/python/">Getting Started with Julia&#39;s SciML for the Python User »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Saturday 1 June 2024 02:08">Saturday 1 June 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>