add DataFrames extension

Author: hexaeder

Project.toml

@@ -37,13 +37,15 @@ YAML = "ddb6d928-2868-570f-bddf-ab3f9cf99eb6"
 [weakdeps]
 Adapt = "79e6a3ab-5dfb-504d-930d-738a2a938a0e"
 CUDA = "052768ef-5323-5732-b1bb-66c8b64840ba"
+DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
 MacroTools = "1914dd2f-81c6-5fcd-8719-6d5c9610ff09"
 ModelingToolkit = "961ee093-0014-501f-94e3-6117800e7a78"
 SymbolicUtils = "d1185830-fcd6-423d-90d6-eec64667417b"
 Symbolics = "0c5d862f-8b57-4792-8d23-62f2024744c7"
 
 [extensions]
 NetworkDynamicsCUDAExt = ["CUDA", "Adapt"]
+NetworkDynamicsDataFramesExt = ["DataFrames"]
 NetworkDynamicsMTKExt = ["ModelingToolkit", "SymbolicUtils", "Symbolics"]
 NetworkDynamicsSymbolicsExt = ["Symbolics", "MacroTools"]
 

ext/NetworkDynamicsDataFramesExt.jl

@@ -0,0 +1,96 @@
+module NetworkDynamicsDataFramesExt
+
+using NetworkDynamics: NetworkDynamics, Network
+using DataFrames: DataFrames, DataFrame
+using OrderedCollections: OrderedDict
+
+function _df_from_list(list, f)
+    df = DataFrame()
+    for (i, v) in list
+        row = OrderedDict{Symbol,Any}()
+        row[:idx] = i
+        for sym in f(v)
+            if NetworkDynamics.has_default_or_init(v, sym)
+                row[sym] = NetworkDynamics.get_default_or_init(v, sym)
+            else
+                row[sym] = missing
+            end
+        end
+        push!(df, NamedTuple(row); cols=:union)
+    end
+    df
+end
+function _df_from_pair(list, pair)
+    key, f = pair
+    df = DataFrame()
+    for (i, v) in list
+        row = OrderedDict{Symbol,Any}(:idx => i, key => f(v))
+        push!(df, NamedTuple(row); cols=:union)
+    end
+    df
+end
+
+function NetworkDynamics.describe_vertices(nw::Network, extras...; parameters=true, states=true, batch=nothing)
+    pairs = enumerate(nw.im.vertexm);
+    batches = map(idx -> findfirst(batch -> idx ∈ batch.indices, nw.vertexbatches), first.(pairs))
+
+    if !isnothing(batch)
+        idxs = findall(b -> b ∈ batch, batches)
+        pairs = collect(pairs)[idxs]
+        batch = collect(batches)[idxs]
+    end
+    isempty(pairs) && return DataFrame()
+
+    basedf = DataFrame(
+        idx = first.(pairs),
+        name = map(v->last(v).name, pairs),
+        batch = map(idx -> findfirst(batch -> idx ∈ batch.indices, nw.vertexbatches), first.(pairs)),
+    )
+
+    dfs = [basedf,]
+    if parameters
+        push!(dfs, _df_from_list(pairs, NetworkDynamics.psym))
+    end
+    if states
+        push!(dfs, _df_from_list(pairs, NetworkDynamics.sym))
+    end
+    for p in extras
+        push!(dfs, _df_from_pair(pairs, p))
+    end
+
+    foldl((a,b) -> DataFrames.leftjoin(a,b; on=:idx), dfs)
+end
+
+function NetworkDynamics.describe_edges(nw::Network, extras...; parameters=true, states=true, batch=nothing)
+    pairs = enumerate(nw.im.edgem);
+    batches = map(idx -> findfirst(batch -> idx ∈ batch.indices, nw.layer.edgebatches), first.(pairs))
+
+    if !isnothing(batch)
+        idxs = findall(b -> b ∈ batch, batches)
+        pairs = collect(pairs)[idxs]
+        batch = collect(batches)[idxs]
+    end
+    isempty(pairs) && return DataFrame()
+
+    basedf = DataFrame(
+        idx = first.(pairs),
+        srcdst = map(idx -> nw.im.edgevec[idx].src => nw.im.edgevec[idx].dst, first.(pairs)),
+        name = map(v->last(v).name, pairs),
+        batch = map(idx -> findfirst(batch -> idx ∈ batch.indices, nw.vertexbatches), first.(pairs)),
+    )
+
+    dfs = [basedf,]
+    if parameters
+        push!(dfs, _df_from_list(pairs, NetworkDynamics.psym))
+    end
+    if states
+        push!(dfs, _df_from_list(pairs, NetworkDynamics.sym))
+    end
+    for p in extras
+        push!(dfs, _df_from_pair(pairs, p))
+    end
+
+    foldl((a,b) -> DataFrames.leftjoin(a,b; on=:idx), dfs)
+end
+
+end

ext/NetworkDynamicsMTKExt.jl

@@ -238,8 +238,12 @@ function _get_metadata(sys, name)
         if def isa Symbolic
             def = fixpoint_sub(def, alldefaults)
         end
-        def isa Symbolic && error("Could not resolve default $(ModelingToolkit.getdefault(sym)) for $name")
-        nt = (; nt..., default=def)
+
+        if def isa Symbolic
+            @warn "Could not resolve default term $(ModelingToolkit.getdefault(sym)) for $name, leave free."
+        else
+            nt = (; nt..., default=def)
+        end
     end
 
     # check for guess both in symbol metadata and in guesses of system

src/NetworkDynamics.jl

@@ -101,6 +101,9 @@ include("doctor.jl")
 export load_network
 include("importexport.jl")
 
+export describe_vertices, describe_edges
+function describe_vertices end
+function describe_edges end
 #=
 using StyledStrings
 s1 = styled"{bright_red:brred} {bright_green:brgreen} {bright_yellow:bryellow} {bright_blue:brblue} {bright_magenta:brmagenta} {bright_cyan:brcyan} {bright_black:brblack} {bright_white:brwhite}";
@@ -119,7 +122,20 @@ const ND_FACES = [
     :NetworkDynamics_fftype => StyledStrings.Face(foreground=:bright_blue),
 ]
 
-__init__() = foreach(StyledStrings.addface!, ND_FACES)
+function __init__()
+    if isdefined(Base.Experimental, :register_error_hint)
+        Base.Experimental.register_error_hint(MethodError) do io, exc, argtypes, kwargs
+            if exc.f ∈ (describe_vertices, describe_edges)
+                ext = Base.get_extension(NetworkDynamics, :NetworkDynamicsDataFramesExt)
+                if isnothing(ext)
+                    printstyled(io, "\nLoad `DataFrames` in order to use `describe_vertices` and `describe_edges`."; bold=true)
+                end
+            end
+        end
+    end
+
+    foreach(StyledStrings.addface!, ND_FACES)
+end
 
 function reloadfaces!()
     StyledStrings.resetfaces!()

src/metadata.jl

@@ -551,3 +551,7 @@ function _has_changed_hash(aliased_cfs)
     end
     changed
 end
+
+
+function describe_vertices end
+function describe_edges end

test/Project.toml

@@ -7,6 +7,7 @@ Bonito = "824d6782-a2ef-11e9-3a09-e5662e0c26f8"
 CUDA = "052768ef-5323-5732-b1bb-66c8b64840ba"
 CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"
 Chairmarks = "0ca39b1e-fe0b-4e98-acfc-b1656634c4de"
+DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
 DataInterpolations = "82cc6244-b520-54b8-b5a6-8a565e85f1d0"
 DelimitedFiles = "8bb1440f-4735-579b-a4ab-409b98df4dab"
 DiffEqCallbacks = "459566f4-90b8-5000-8ac3-15dfb0a30def"