allow default_processes_eqs

Author: Datseris

Project.toml

@@ -1,7 +1,7 @@
 name = "ProcessBasedModelling"
 uuid = "ca969041-2cf3-4b10-bc21-86f4417093eb"
 authors = ["Datseris <[email protected]>"]
-version = "1.2.3"
+version = "1.2.4"
 
 [deps]
 ModelingToolkit = "961ee093-0014-501f-94e3-6117800e7a78"

docs/src/index.md

@@ -203,6 +203,7 @@ when developing a field-specific library.
 processes_to_mtkmodel
 register_default_process!
 default_processes
+default_processes_eqs
 ```
 
 ## [Predefined `Process` subtypes](@id predefined_processes)

src/default.jl

@@ -1,4 +1,4 @@
-export register_default_process!, default_processes
+export register_default_process!, default_processes, default_processes_eqs
 
 const _DEFAULT_PROCESSES = Dict{Module, Dict}()
 
@@ -50,10 +50,24 @@ end
     default_processes(m::Module)
 
 Return the dictionary of default processes tracked by the given module.
+See also [`default_processes_eqs`](@ref).
 """
 function default_processes(m::Module)
     if !haskey(_DEFAULT_PROCESSES, m)
         _DEFAULT_PROCESSES[m] = Dict{Num}{Any}()
     end
     return _DEFAULT_PROCESSES[m]
 end
+
+"""
+    default_processes_eqs(m::Module)
+
+Same as [`default_processes`](@ref), but return the equations
+of all processes in a vector format, which is rendered as LaTeX
+in Markdown to HTML processing by e.g., Documenter.jl.
+"""
+function default_processes_eqs(m::Module)
+    d = default_processes(m)
+    eqs = [lhs(proc) ~ rhs(proc) for proc in values(d)]
+    return eqs
+end