GitHub

Metadata

Component models such as VertexModel and EdgeModel can store metadata. We distinguish between two kinds of metadata: component metadata and symbol metadata.

Component Metadata

Component metadata is a Dict{Symbol,Any} attached to each component to store various information. Use metadata to retrieve the full dict.

To access the data, you can use the methods has_metadata, get_metadata, set_metadata! and delete_metadata! (see Component Metadata API).

Special metadata:

  • :init_residual: after Component-wise Initialization, this field stores the residual vector of the nonlinear problem.
  • :graphelement: optional field to specialize the graphelement for each component (vidx) for vertices, (;src,dst) named tuple of either vertex names or vertex indices for edges. Has special accessors has_/get_/set_graphelement.
  • :callback: optional field to define callback functions on the component level. See Callbacks and Callbacks API for more information.
  • :position: Store a tuple (x, y) with position of the node for plotting. Has special accessors has_/get_/set_position.
  • :marker: Store a Symbol for the graph plot. Possible values could be :circle, :rect, :utriangle, :cross, :diamond, :dtriangle, :pentagon, :xcross or anything which works as a marker keyword argument in Makie.

Symbol Metadata

Each component stores symbol metadata. The symbol metadata is a Dict{Symbol, Dict{Symbol, Any}} which stores a metadata dict per symbol. Symbols are everything that appears in sym, psym, obssym and insym.

To access the data, you can use the methods has_metadata, get_metadata, set_metadata! and delete_metadata! (see Per Symbol Metadata API).

Special cases for symbol metadata are:

  • default: Stores default values for states/parameters. In initialization, those are considered fixed.
  • guess: Stores a guess for a state/parameter which needs to be solved during initialization ("free" variables).
  • bounds: Stores bounds for variables/parameters
  • init: Stores the solution of the "free" variables, this is rarely set manually but instead when calling initialize_component!.

For those, there are special functions has_*, get_*, set_*! and delete_*!. See Per Symbol Metadata API.

These are closely aligned with the metadata use in ModelingToolkit. They are automatically copied from the ODESystem if you use MTK models to create NetworkDynamics models.

Metadata Utils

Accessing metadata (especially defaults) of states and parameters is a very common task. We provide several helper methods to do so. Please check out their docstrings for further explanation: