Network

area(sn::StreamfallNetwork)::Float64

Total area represented by a network.

create_network(name::String, network::AbstractDict)::StreamfallNetwork

Create a StreamNetwork from a YAML-derived specification.

Example

julia> using OrderedCollections
julia> network_spec = YAML.load_file("example_network.yml"; dicttype=OrderedDict{Any,Any})
julia> sn = create_network("Example Network", network_spec)

create_node(mg::MetaDiGraph, node_name::String, details::AbstractDict, nid::Int)

Create a node specified with given name (if it does not exist).

Returns

• this_id : ID of node (if pre-existing) and
• nid : incremented node id for entire network (equal to this_id if exists)

extract_network_spec(sn::StreamfallNetwork)

Extract network details

find_inlets_and_outlets(sn::StreamfallNetwork)::Tuple

Find all inlets and outlets in a network.

in_or_out(g, v)

Determine a node's connection

inlets(sn::StreamfallNetwork, node_name::String)

Find ID(s) of nodes which provides inflows for given node.

outlets(sn::StreamfallNetwork, node_name::String)

Find ID(s) of node immediately downstream from given node.

plot_network(sn::StreamfallNetwork)

Simple plot of stream network.

reset!(sn::StreamfallNetwork)::Nothing

Reset a network.

save_figure(sn::StreamfallNetwork, fn::String)

Save a figure of the network in SVG format.

save_network(sn::StreamfallNetwork, fn::String)::Nothing

Save network specification to a YAML file.