Merge pull request #253 from JuliaDynamics/edit_tutorial_contents

Edit tutorial contents

Author: hexaeder

docs/examples/getting_started_with_network_dynamics.jl

@@ -1,13 +1,13 @@
 #=
 # Modeling a heterogeneous system
 
-This example can be dowloaded as a normal Julia script [here](@__NAME__.jl). #md
+This example can be downloaded as a normal Julia script [here](@__NAME__.jl). #md
 
-One of the main purposes of NetworkDynamics.jl is to facilitate
-modeling coupled systems with heterogenities. This means that
-components can differ in their parameters as well as in their dynamics.
+One of the main purposes of NetworkDynamics.jl is to facilitate the
+modeling systems whose components can differ in their parameters as well as their dynamics.
+These are known as Coupled systems with heterogeneities.
 
-## Heterogenous parameters
+## Heterogeneous parameters
 
 We start by setting up a simple system of Kuramoto oscillators.
 =#

docs/examples/heterogeneous_system.jl

@@ -10,29 +10,29 @@ At the end of each run the user is prompted to rerun the make process. Using rev
 use the updated `*.md` and source files. This way the Julia session keeps alive and the
 individual builds are much faster.
 =#
-
-#=
 using Pkg
+using Revise
+using LiveServer
+
 Pkg.activate(@__DIR__)
-Pkg.instantiate()
-print("Do you want to update docs environment? [y/n] ")
+if VERSION ≤ v"1.11-"
+    Pkg.develop(PackageSpec(path=dirname(@__DIR__))) # adds the package this script is called from
+end
+print("Do you want to update docs environment? [y/N] ")
 answer = readline()
 if !isempty(answer) && answer[1] == 'y'
     Pkg.update()
 end
-
-using Revise
-using LiveServer
-using REPL.TerminalMenus
+Pkg.instantiate()
 
 port = isempty(ARGS) ? 8000 : parse(Int, ARGS[1])
 @assert 8000 ≤ port ≤ 9000 "port has to be in range 8000..9000!"
 
 @info "Start server..."
 @async serve(;dir=joinpath(@__DIR__, "build"), port)
 
-menu = RadioMenu(["Run again!", "Quit!"])
-while true
+run = true
+while run
     revise()
     @info "Start building docs..."
     try
@@ -41,23 +41,22 @@ while true
         @info "make.jl error" e
     end
 
-    println("\nDocs are served at http://localhost:$port")
-
-    if request("What now?", menu) != 1
-        break
+    printstyled("\n\nDocs are served at http://localhost:$port\n\n", color=:blue, bold=true)
+    println("Run again? Enter! Exit with 'q'.")
+    if readline() == "q"
+        global run = false
     end
 end
-=#
 
 
-using Pkg
-Pkg.activate(@__DIR__)
-using NetworkDynamics
-using LiveServer
+# using Pkg
+# Pkg.activate(@__DIR__)
+# using NetworkDynamics
+# using LiveServer
 
-cd(pkgdir(NetworkDynamics))
+# cd(pkgdir(NetworkDynamics))
 
-servedocs(
-    literate_dir = joinpath("docs", "examples"),
-    skip_dir = joinpath("docs", "src", "generated")
-)
+# servedocs(
+#     literate_dir = joinpath("docs", "examples"),
+#     skip_dir = joinpath("docs", "src", "generated")
+# )

docs/localmake.jl

@@ -19,7 +19,7 @@ NDI.get_electron_window()
 
 links = InterLinks(
     "DiffEq" => "https://docs.sciml.ai/DiffEqDocs/stable/",
-    "MTK" => "https://docs.sciml.ai/ModelingToolkit/stable/",
+    "ModelingToolkit" => "https://docs.sciml.ai/ModelingToolkit/stable/",
     "SymbolicIndexingInterface" => "https://docs.sciml.ai/SymbolicIndexingInterface/stable/",
     "DiffEqCallbacks" => "https://docs.sciml.ai/DiffEqCallbacks/stable/",
 )

docs/make.jl

@@ -0,0 +1,23 @@
+% \documentclass[tikz,convert={outfile=\jobname.svg}]{standalone}
+\documentclass[tikz,convert=pdf2svg]{standalone}
+%\usetikzlibrary{...}% tikz package already loaded by 'tikz' option
+\usetikzlibrary{arrows, arrows.meta}
+% \tikzset{
+%   >=stealth',
+% }
+\usepackage{amsmath,amssymb}
+\usepackage{ndtheme}
+
+\begin{document}
+\begin{tikzpicture}[\ndtheme]
+  \node[draw, minimum height=1.5cm](n){
+    Edge Model
+  };
+  \draw[->](n.east)++(0,0.4)--++(1.0,0) node[right]{$y^{\mathrm e}_{\mathrm{src}}$}; \draw[->](n.east)++(0,-0.4)--++(1.0,0) node[right]{$y^{\mathrm e}_{\mathrm{dst}}$};
+
+  \draw[<-](n.west)++(0,0.4)--++(-1.0,0) node[left]{$y^{\mathrm v}_{i}=i^{\mathrm e}_{\mathrm{src}}$};
+  \draw[<-](n.west)++(0,-0.4)--++(-1.0,0) node[left]{$y^{\mathrm v}_{j}=i^{\mathrm e}_{\mathrm{dst}}$};
+
+  \node[text width=3.5cm, align=center, font=\scriptsize] at ([xshift=-2.7cm, yshift=-1.2cm]n) {mapping of adjacent node outputs as edge inputs};
+\end{tikzpicture}
+\end{document}

docs/src/assets/edgemodel-dark.svg

@@ -17,5 +17,23 @@ if ! command_exists pdf2svg; then
     exit 1
 fi
 
-latexmk -pdflua -shell-escape mathmodel.tex
+# List of figures to generate
+figures=(mathmodel edgemodel nodemodel)
+
+# Generate light versions (default)
+echo "Generating light versions..."
+for fig in "${figures[@]}"; do
+    latexmk -pdflua -shell-escape "${fig}.tex"
+done
+
+# Generate dark versions
+echo "Generating dark versions..."
+for fig in "${figures[@]}"; do
+    cp "${fig}.tex" "${fig}-dark.tex"
+    NDTHEME=dark latexmk -pdflua -shell-escape "${fig}-dark.tex"
+    rm "${fig}-dark.tex"
+done
+
 latexmk -C
+# Clean up remaining temp files that latexmk -C might miss
+rm -f *.aux *.fdb_latexmk *.fls *.log *.pdf