export extract_nw

hexaeder · hexaeder · commit 54610f19d0e5 · 2025-03-25T17:34:06.000+01:00
diff --git a/docs/src/API.md b/docs/src/API.md
@@ -191,6 +191,7 @@ KAAggregator
 save_parameters!
 ff_to_constraint
 Base.copy(::NetworkDynamics.ComponentModel)
+extract_nw
 ```
 
 ## NetworkDynamicsInspector API
diff --git a/src/NetworkDynamics.jl b/src/NetworkDynamics.jl
@@ -62,7 +62,7 @@ include("external_inputs.jl")
 # XXX: have both, s[:] and uflat(s) ?
 export VIndex, EIndex, VPIndex, EPIndex, NWState, NWParameter, uflat, pflat
 export vidxs, eidxs, vpidxs, epidxs
-export save_parameters!
+export save_parameters!, extract_nw
 export @obsex
 include("symbolicindexing.jl")
 
diff --git a/src/symbolicindexing.jl b/src/symbolicindexing.jl
@@ -1088,6 +1088,8 @@ _get_components(::Type{<:SymbolicEdgeIndex}, inpr) = extract_nw(inpr).im.edgem
     extract_nw(thing)
 
 Try to extract the `Network` object from thing.
+
+Thing can by many things, e.g. `ODEProblem`, `ODESolution`, `Integrator`, `NWState`, `NWParameter`, ...
 """
 function extract_nw(inpr)
     sc = SII.symbolic_container(inpr)
