Merge pull request #246 from JuliaDiffEq/latexify_ode

Add Latexify for ODESystem

Author: ChrisRackauckas

src/ModelingToolkit.jl

@@ -91,10 +91,10 @@ include("simplify.jl")
 include("utils.jl")
 include("direct.jl")
 include("domains.jl")
-include("latexify_recipes.jl")
 include("systems/diffeqs/diffeqsystem.jl")
 include("systems/diffeqs/first_order_transform.jl")
 include("systems/nonlinear/nonlinear_system.jl")
 include("systems/pde/pdesystem.jl")
+include("latexify_recipes.jl")
 
 end # module

src/latexify_recipes.jl

@@ -2,7 +2,7 @@
     # Set default option values.
     env --> :align
 
-    # Convert both the left and right hand side to expressions of basic types 
+    # Convert both the left and right hand side to expressions of basic types
     # that latexify can deal with.
 
     rhs = getfield.(eqs, :rhs)
@@ -21,3 +21,27 @@
 
     return lhs, rhs
 end
+
+@latexrecipe function f(eqs::Vector{ModelingToolkit.DiffEq}; iv=:t)
+    # Set default option values.
+    env --> :align
+
+    # Convert both the left and right hand side to expressions of basic types
+    # that latexify can deal with.
+
+    rhs = getfield.(eqs, :rhs)
+    rhs = convert.(Expr, rhs)
+    rhs = [postwalk(x -> x isa ModelingToolkit.Constant ? x.value : x, eq) for eq in rhs]
+    rhs = [postwalk(x -> x isa Expr && length(x.args) == 1 ? x.args[1] : x, eq) for eq in rhs]
+    rhs = [postwalk(x -> x isa Expr && x.args[1] == :Differential && length(x.args[2].args) == 2 ? :($(Symbol(:d, x.args[2]))/($(Symbol(:d, x.args[2].args[2])))) : x, eq) for eq in rhs]
+    rhs = [postwalk(x -> x isa Expr && x.args[1] == :Differential ? "\\frac{d\\left($(Latexify.latexraw(x.args[2]))\\right)}{d$iv}" : x, eq) for eq in rhs]
+
+    var = getfield.(getfield.(eqs, :x),:name)
+    ns  = getfield.(eqs, :n)
+    lhs = [ns[i] == 1 ? Latexify.LaTeXString("\\frac{d$(Latexify.latexraw(var[i]))}{d$iv}") : LaTeXString("\\frac{d^{$(ns[i])}$(Latexify.latexraw(var[i]))}{d$iv^{$(ns[i])}}") for i in 1:length(var)]
+    return lhs, rhs
+end
+
+@latexrecipe function f(sys::ModelingToolkit.ODESystem; iv=:t)
+    return latexify(sys.eqs; iv=iv)
+end

test/latexify.jl

@@ -34,3 +34,41 @@ raw"\begin{align}
 \mathrm{derivative}\left( \mathrm{z}\left( t \right), t \right) =& \mathrm{x}\left( t \right) \cdot \left( \mathrm{y}\left( t \right) \right)^{\frac{2}{3}} - \beta \cdot \mathrm{z}\left( t \right)
 \end{align}
 "
+
+@parameters t p[1:3]
+@variables u[1:3](t)
+@derivatives D'~t
+
+eqs = [D(u[1]) ~ p[3]*(u[2]-u[1]),
+       0 ~ p[2]*p[3]*u[1]*(p[1]-u[1])/10-u[2],
+       D(u[3]) ~ u[1]*u[2]^(2//3) - p[3]*u[3]]
+
+@test latexify(eqs) ==
+raw"\begin{align}
+\mathrm{derivative}\left( \mathrm{u_1}\left( t \right), t \right) =& p_3 \cdot \left( \mathrm{u_2}\left( t \right) - \mathrm{u_1}\left( t \right) \right) \\
+0 =& \frac{p_2 \cdot p_3 \cdot \mathrm{u_1}\left( t \right) \cdot \left( p_1 - \mathrm{u_1}\left( t \right) \right)}{10} - \mathrm{u_2}\left( t \right) \\
+\mathrm{derivative}\left( \mathrm{u_3}\left( t \right), t \right) =& \mathrm{u_1}\left( t \right) \cdot \left( \mathrm{u_2}\left( t \right) \right)^{\frac{2}{3}} - p_3 \cdot \mathrm{u_3}\left( t \right)
+\end{align}
+"
+
+eqs = [D(u[1]) ~ p[3]*(u[2]-u[1]),
+       D(u[2]) ~ p[2]*p[3]*u[1]*(p[1]-u[1])/10-u[2],
+       D(u[3]) ~ u[1]*u[2]^(2//3) - p[3]*u[3]]
+
+sys = ODESystem(eqs)
+
+@test latexify(sys.eqs) ==
+raw"\begin{align}
+\frac{du_{1}}{dt} =& p_3 \cdot \left( \mathrm{u_2}\left( t \right) - \mathrm{u_1}\left( t \right) \right) \\
+\frac{du_{2}}{dt} =& \frac{p_2 \cdot p_3 \cdot \mathrm{u_1}\left( t \right) \cdot \left( p_1 - \mathrm{u_1}\left( t \right) \right)}{10} - \mathrm{u_2}\left( t \right) \\
+\frac{du_{3}}{dt} =& \mathrm{u_1}\left( t \right) \cdot \left( \mathrm{u_2}\left( t \right) \right)^{\frac{2}{3}} - p_3 \cdot \mathrm{u_3}\left( t \right)
+\end{align}
+"
+
+@test latexify(sys) ==
+raw"$\begin{align}
+\frac{du_{1}}{dt} =& p_3 \cdot \left( \mathrm{u_2}\left( t \right) - \mathrm{u_1}\left( t \right) \right) \\
+\frac{du_{2}}{dt} =& \frac{p_2 \cdot p_3 \cdot \mathrm{u_1}\left( t \right) \cdot \left( p_1 - \mathrm{u_1}\left( t \right) \right)}{10} - \mathrm{u_2}\left( t \right) \\
+\frac{du_{3}}{dt} =& \mathrm{u_1}\left( t \right) \cdot \left( \mathrm{u_2}\left( t \right) \right)^{\frac{2}{3}} - p_3 \cdot \mathrm{u_3}\left( t \right)
+\end{align}
+$"