install: updates to support building deb/rpm packages that contain python wheels and install core from a single file, updates to core to install scripts by way of python directly

package/examples/python/distributed_emane.py

@@ -0,0 +1,82 @@
+"""
+Example for scripting a standalone distributed EMANE session that does not interact
+with the GUI.
+"""
+
+import argparse
+import logging
+
+from core.emane.models.ieee80211abg import EmaneIeee80211abgModel
+from core.emane.nodes import EmaneNet
+from core.emulator.coreemu import CoreEmu
+from core.emulator.data import IpPrefixes
+from core.emulator.enumerations import EventTypes
+from core.nodes.base import CoreNode
+
+
+def parse(name):
+    parser = argparse.ArgumentParser(description=f"Run {name} example")
+    parser.add_argument(
+        "-a",
+        "--address",
+        help="local address that distributed servers will use for gre tunneling",
+    )
+    parser.add_argument(
+        "-s", "--server", help="distributed server to use for creating nodes"
+    )
+    options = parser.parse_args()
+    return options
+
+
+def main(args):
+    # ip generator for example
+    prefixes = IpPrefixes(ip4_prefix="10.83.0.0/16")
+
+    # create emulator instance for creating sessions and utility methods
+    coreemu = CoreEmu(
+        {
+            "controlnet": "core1:172.16.1.0/24 core2:172.16.2.0/24 core3:172.16.3.0/24 "
+            "core4:172.16.4.0/24 core5:172.16.5.0/24",
+            "distributed_address": args.address,
+        }
+    )
+    session = coreemu.create_session()
+
+    # initialize distributed
+    server_name = "core2"
+    session.distributed.add_server(server_name, args.server)
+
+    # must be in configuration state for nodes to start, when using "node_add" below
+    session.set_state(EventTypes.CONFIGURATION_STATE)
+
+    # create local node, switch, and remote nodes
+    options = CoreNode.create_options()
+    options.model = "mdr"
+    node1 = session.add_node(CoreNode, options=options)
+    options = EmaneNet.create_options()
+    options.emane_model = EmaneIeee80211abgModel.name
+    emane_net = session.add_node(EmaneNet, options=options)
+    options = CoreNode.create_options()
+    options.server = server_name
+    node2 = session.add_node(CoreNode, options=options)
+
+    # create node interfaces and link
+    interface1_data = prefixes.create_iface(node1)
+    interface2_data = prefixes.create_iface(node2)
+    session.add_link(node1.id, emane_net.id, iface1_data=interface1_data)
+    session.add_link(node2.id, emane_net.id, iface1_data=interface2_data)
+
+    # instantiate session
+    session.instantiate()
+
+    # pause script for verification
+    input("press enter for shutdown")
+
+    # shutdown session
+    coreemu.shutdown()
+
+
+if __name__ == "__main__":
+    logging.basicConfig(level=logging.INFO)
+    args = parse(__file__)
+    main(args)

package/examples/python/distributed_lxd.py

@@ -0,0 +1,69 @@
+"""
+Example for scripting a standalone distributed LXD session that does not interact
+with the GUI.
+"""
+
+import argparse
+import logging
+
+from core.emulator.coreemu import CoreEmu
+from core.emulator.data import IpPrefixes
+from core.emulator.enumerations import EventTypes
+from core.nodes.lxd import LxcNode
+
+
+def parse(name):
+    parser = argparse.ArgumentParser(description=f"Run {name} example")
+    parser.add_argument(
+        "-a",
+        "--address",
+        help="local address that distributed servers will use for gre tunneling",
+    )
+    parser.add_argument(
+        "-s", "--server", help="distributed server to use for creating nodes"
+    )
+    options = parser.parse_args()
+    return options
+
+
+def main(args):
+    # ip generator for example
+    prefixes = IpPrefixes(ip4_prefix="10.83.0.0/16")
+
+    # create emulator instance for creating sessions and utility methods
+    coreemu = CoreEmu({"distributed_address": args.address})
+    session = coreemu.create_session()
+
+    # initialize distributed
+    server_name = "core2"
+    session.distributed.add_server(server_name, args.server)
+
+    # must be in configuration state for nodes to start, when using "node_add" below
+    session.set_state(EventTypes.CONFIGURATION_STATE)
+
+    # create local node, switch, and remote nodes
+    options = LxcNode.create_options()
+    options.image = "ubuntu:18.04"
+    node1 = session.add_node(LxcNode, options=options)
+    options.server = server_name
+    node2 = session.add_node(LxcNode, options=options)
+
+    # create node interfaces and link
+    interface1_data = prefixes.create_iface(node1)
+    interface2_data = prefixes.create_iface(node2)
+    session.add_link(node1.id, node2.id, interface1_data, interface2_data)
+
+    # instantiate session
+    session.instantiate()
+
+    # pause script for verification
+    input("press enter for shutdown")
+
+    # shutdown session
+    coreemu.shutdown()
+
+
+if __name__ == "__main__":
+    logging.basicConfig(level=logging.INFO)
+    args = parse(__file__)
+    main(args)

package/examples/python/distributed_ptp.py

@@ -0,0 +1,66 @@
+"""
+Example for scripting a standalone distributed peer to peer session that does not
+interact with the GUI.
+"""
+
+import argparse
+import logging
+
+from core.emulator.coreemu import CoreEmu
+from core.emulator.data import IpPrefixes
+from core.emulator.enumerations import EventTypes
+from core.nodes.base import CoreNode
+
+
+def parse(name):
+    parser = argparse.ArgumentParser(description=f"Run {name} example")
+    parser.add_argument(
+        "-a",
+        "--address",
+        help="local address that distributed servers will use for gre tunneling",
+    )
+    parser.add_argument(
+        "-s", "--server", help="distributed server to use for creating nodes"
+    )
+    options = parser.parse_args()
+    return options
+
+
+def main(args):
+    # ip generator for example
+    prefixes = IpPrefixes(ip4_prefix="10.83.0.0/16")
+
+    # create emulator instance for creating sessions and utility methods
+    coreemu = CoreEmu({"distributed_address": args.address})
+    session = coreemu.create_session()
+
+    # initialize distributed
+    server_name = "core2"
+    session.distributed.add_server(server_name, args.server)
+
+    # must be in configuration state for nodes to start, when using "node_add" below
+    session.set_state(EventTypes.CONFIGURATION_STATE)
+
+    # create local node, switch, and remote nodes
+    node1 = session.add_node(CoreNode)
+    node2 = session.add_node(CoreNode, server=server_name)
+
+    # create node interfaces and link
+    interface1_data = prefixes.create_iface(node1)
+    interface2_data = prefixes.create_iface(node2)
+    session.add_link(node1.id, node2.id, interface1_data, interface2_data)
+
+    # instantiate session
+    session.instantiate()
+
+    # pause script for verification
+    input("press enter for shutdown")
+
+    # shutdown session
+    coreemu.shutdown()
+
+
+if __name__ == "__main__":
+    logging.basicConfig(level=logging.INFO)
+    args = parse(__file__)
+    main(args)

package/examples/python/distributed_switch.py

@@ -0,0 +1,73 @@
+"""
+Example for scripting a standalone distributed switch session that does not
+interact with the GUI.
+"""
+
+import argparse
+import logging
+
+from core.emulator.coreemu import CoreEmu
+from core.emulator.data import IpPrefixes
+from core.emulator.enumerations import EventTypes
+from core.nodes.base import CoreNode
+from core.nodes.network import SwitchNode
+
+
+def parse(name):
+    parser = argparse.ArgumentParser(description=f"Run {name} example")
+    parser.add_argument(
+        "-a",
+        "--address",
+        help="local address that distributed servers will use for gre tunneling",
+    )
+    parser.add_argument(
+        "-s", "--server", help="distributed server to use for creating nodes"
+    )
+    options = parser.parse_args()
+    return options
+
+
+def main(args):
+    # ip generator for example
+    prefixes = IpPrefixes(ip4_prefix="10.83.0.0/16")
+
+    # create emulator instance for creating sessions and utility methods
+    coreemu = CoreEmu(
+        {"controlnet": "172.16.0.0/24", "distributed_address": args.address}
+    )
+    session = coreemu.create_session()
+
+    # initialize distributed
+    server_name = "core2"
+    session.distributed.add_server(server_name, args.server)
+
+    # must be in configuration state for nodes to start, when using "node_add" below
+    session.set_state(EventTypes.CONFIGURATION_STATE)
+
+    # create local node, switch, and remote nodes
+    node1 = session.add_node(CoreNode)
+    switch = session.add_node(SwitchNode)
+    options = CoreNode.create_options()
+    options.server = server_name
+    node2 = session.add_node(CoreNode, options=options)
+
+    # create node interfaces and link
+    interface1_data = prefixes.create_iface(node1)
+    interface2_data = prefixes.create_iface(node2)
+    session.add_link(node1.id, switch.id, iface1_data=interface1_data)
+    session.add_link(node2.id, switch.id, iface1_data=interface2_data)
+
+    # instantiate session
+    session.instantiate()
+
+    # pause script for verification
+    input("press enter for shutdown")
+
+    # shutdown session
+    coreemu.shutdown()
+
+
+if __name__ == "__main__":
+    logging.basicConfig(level=logging.INFO)
+    args = parse(__file__)
+    main(args)

package/examples/python/emane80211.py

@@ -0,0 +1,62 @@
+# required imports
+from core.emane.models.ieee80211abg import EmaneIeee80211abgModel
+from core.emane.nodes import EmaneNet
+from core.emulator.coreemu import CoreEmu
+from core.emulator.data import IpPrefixes
+from core.emulator.enumerations import EventTypes
+from core.nodes.base import CoreNode, Position
+
+# ip nerator for example
+ip_prefixes = IpPrefixes(ip4_prefix="10.0.0.0/24")
+
+# create emulator instance for creating sessions and utility methods
+coreemu = CoreEmu()
+session = coreemu.create_session()
+
+# location information is required to be set for emane
+session.location.setrefgeo(47.57917, -122.13232, 2.0)
+session.location.refscale = 150.0
+
+# must be in configuration state for nodes to start, when using "node_add" below
+session.set_state(EventTypes.CONFIGURATION_STATE)
+
+# create emane
+options = EmaneNet.create_options()
+options.emane_model = EmaneIeee80211abgModel.name
+position = Position(x=200, y=200)
+emane = session.add_node(EmaneNet, position=position, options=options)
+
+# create nodes
+options = CoreNode.create_options()
+options.model = "mdr"
+position = Position(x=100, y=100)
+n1 = session.add_node(CoreNode, position=position, options=options)
+options = CoreNode.create_options()
+options.model = "mdr"
+position = Position(x=300, y=100)
+n2 = session.add_node(CoreNode, position=position, options=options)
+
+# configure general emane settings
+config = session.emane.get_configs()
+config.update({"eventservicettl": "2"})
+
+# configure emane model settings
+# using a dict mapping currently support values as strings
+session.emane.set_model_config(
+    emane.id, EmaneIeee80211abgModel.name, {"unicastrate": "3"}
+)
+
+# link nodes to emane
+iface1 = ip_prefixes.create_iface(n1)
+session.add_link(n1.id, emane.id, iface1)
+iface1 = ip_prefixes.create_iface(n2)
+session.add_link(n2.id, emane.id, iface1)
+
+# start session
+session.instantiate()
+
+# do whatever you like here
+input("press enter to shutdown")
+
+# stop session
+session.shutdown()

package/examples/python/peertopeer.py

@@ -0,0 +1,35 @@
+# required imports
+from core.emulator.coreemu import CoreEmu
+from core.emulator.data import IpPrefixes
+from core.emulator.enumerations import EventTypes
+from core.nodes.base import CoreNode, Position
+
+# ip nerator for example
+ip_prefixes = IpPrefixes(ip4_prefix="10.0.0.0/24")
+
+# create emulator instance for creating sessions and utility methods
+coreemu = CoreEmu()
+session = coreemu.create_session()
+
+# must be in configuration state for nodes to start, when using "node_add" below
+session.set_state(EventTypes.CONFIGURATION_STATE)
+
+# create nodes
+position = Position(x=100, y=100)
+n1 = session.add_node(CoreNode, position=position)
+position = Position(x=300, y=100)
+n2 = session.add_node(CoreNode, position=position)
+
+# link nodes together
+iface1 = ip_prefixes.create_iface(n1)
+iface2 = ip_prefixes.create_iface(n2)
+session.add_link(n1.id, n2.id, iface1, iface2)
+
+# start session
+session.instantiate()
+
+# do whatever you like here
+input("press enter to shutdown")
+
+# stop session
+session.shutdown()

package/examples/python/switch.py

@@ -0,0 +1,41 @@
+# required imports
+from core.emulator.coreemu import CoreEmu
+from core.emulator.data import IpPrefixes
+from core.emulator.enumerations import EventTypes
+from core.nodes.base import CoreNode, Position
+from core.nodes.network import SwitchNode
+
+# ip nerator for example
+ip_prefixes = IpPrefixes(ip4_prefix="10.0.0.0/24")
+
+# create emulator instance for creating sessions and utility methods
+coreemu = CoreEmu()
+session = coreemu.create_session()
+
+# must be in configuration state for nodes to start, when using "node_add" below
+session.set_state(EventTypes.CONFIGURATION_STATE)
+
+# create switch
+position = Position(x=200, y=200)
+switch = session.add_node(SwitchNode, position=position)
+
+# create nodes
+position = Position(x=100, y=100)
+n1 = session.add_node(CoreNode, position=position)
+position = Position(x=300, y=100)
+n2 = session.add_node(CoreNode, position=position)
+
+# link nodes to switch
+iface1 = ip_prefixes.create_iface(n1)
+session.add_link(n1.id, switch.id, iface1)
+iface1 = ip_prefixes.create_iface(n2)
+session.add_link(n2.id, switch.id, iface1)
+
+# start session
+session.instantiate()
+
+# do whatever you like here
+input("press enter to shutdown")
+
+# stop session
+session.shutdown()

package/examples/python/wireless.py

@@ -0,0 +1,50 @@
+# required imports
+import logging
+
+from core.emulator.coreemu import CoreEmu
+from core.emulator.data import IpPrefixes
+from core.emulator.enumerations import EventTypes
+from core.nodes.base import CoreNode, Position
+from core.nodes.network import WlanNode
+
+# enable info logging
+logging.basicConfig(level=logging.INFO)
+
+# ip nerator for example
+ip_prefixes = IpPrefixes(ip4_prefix="10.0.0.0/24")
+
+# create emulator instance for creating sessions and utility methods
+coreemu = CoreEmu()
+session = coreemu.create_session()
+
+# must be in configuration state for nodes to start
+session.set_state(EventTypes.CONFIGURATION_STATE)
+
+# create wireless
+position = Position(x=200, y=200)
+wireless = session.add_node(WlanNode, position=position)
+
+# create nodes
+options = CoreNode.create_options()
+options.model = "mdr"
+position = Position(x=100, y=100)
+n1 = session.add_node(CoreNode, position=position, options=options)
+options = CoreNode.create_options()
+options.model = "mdr"
+position = Position(x=300, y=100)
+n2 = session.add_node(CoreNode, position=position, options=options)
+
+# link nodes to wireless
+iface1 = ip_prefixes.create_iface(n1)
+session.add_link(n1.id, wireless.id, iface1)
+iface1 = ip_prefixes.create_iface(n2)
+session.add_link(n2.id, wireless.id, iface1)
+
+# start session
+session.instantiate()
+
+# do whatever you like here
+input("press enter to shutdown")
+
+# stop session
+session.shutdown()

package/examples/python/wlan.py

@@ -0,0 +1,59 @@
+# required imports
+from core.emulator.coreemu import CoreEmu
+from core.emulator.data import IpPrefixes
+from core.emulator.enumerations import EventTypes
+from core.location.mobility import BasicRangeModel
+from core.nodes.base import CoreNode, Position
+from core.nodes.network import WlanNode
+
+# ip nerator for example
+ip_prefixes = IpPrefixes(ip4_prefix="10.0.0.0/24")
+
+# create emulator instance for creating sessions and utility methods
+coreemu = CoreEmu()
+session = coreemu.create_session()
+
+# must be in configuration state for nodes to start, when using "node_add" below
+session.set_state(EventTypes.CONFIGURATION_STATE)
+
+# create wlan
+position = Position(x=200, y=200)
+wlan = session.add_node(WlanNode, position=position)
+
+# create nodes
+options = CoreNode.create_options()
+options.model = "mdr"
+position = Position(x=100, y=100)
+n1 = session.add_node(CoreNode, position=position, options=options)
+options = CoreNode.create_options()
+options.model = "mdr"
+position = Position(x=300, y=100)
+n2 = session.add_node(CoreNode, position=position, options=options)
+
+# configuring wlan
+session.mobility.set_model_config(
+    wlan.id,
+    BasicRangeModel.name,
+    {
+        "range": "280",
+        "bandwidth": "55000000",
+        "delay": "6000",
+        "jitter": "5",
+        "error": "5",
+    },
+)
+
+# link nodes to wlan
+iface1 = ip_prefixes.create_iface(n1)
+session.add_link(n1.id, wlan.id, iface1)
+iface1 = ip_prefixes.create_iface(n2)
+session.add_link(n2.id, wlan.id, iface1)
+
+# start session
+session.instantiate()
+
+# do whatever you like here
+input("press enter to shutdown")
+
+# stop session
+session.shutdown()