Merge branch 'feature/example-shed-community' into 'develop'

Adds kclique to simulation

See merge request !8

examples/shed.py

@@ -8,7 +8,8 @@ from collections import namedtuple
 from multiprocessing import Pool
 
 from pydtn import Network, RandomTraffic, Node, EpidemicNode
-from pydtn.community import BubbleNode, HCBFNode, LouvainCommunity
+from pydtn.community import BubbleKCliqueNode, BubbleLouvainNode
+from pydtn.community import HCBFKCliqueNode, HCBFLouvainNode
 from pydtn.shed import ShedTrace
 
 
@@ -26,7 +27,8 @@ def run_simulation(simulation):
     node_type = simulation.node_type
     node_options = {
         'tick_rate': 5 * 60,  # 5 mins
-        'community': LouvainCommunity(epoch),
+        'epoch': epoch,
+        'k': 3,
     }
     nodes = {
         node_id: simulation.node_type(**node_options)
@@ -36,7 +38,7 @@ def run_simulation(simulation):
     traffic_options = {
         'seed': seed,
         'start': epoch,
-        'step': 30 * 60,  # 1 packet every 30 mins
+        'step': 1 * 60,  # 1 packet every 1 mins
     }
     traffic = RandomTraffic(nodes, **traffic_options)
 
@@ -59,9 +61,17 @@ def main(args):
     trace = args['shed']
     pool = Pool()
     simulations = []
+    node_types = [
+        Node,
+        EpidemicNode,
+        BubbleKCliqueNode,
+        HCBFKCliqueNode,
+        BubbleLouvainNode,
+        HCBFLouvainNode,
+    ]
 
     for seed in args['seeds']:
-        for node_type in [Node, EpidemicNode, BubbleNode, HCBFNode]:
+        for node_type in node_types:
             sim = Simulation(trace=trace, node_type=node_type, seed=seed)
             simulations.append(sim)
 

pydtn/community.py

@@ -16,8 +16,14 @@ __all__ = [
     "LouvainCommunity",
 
     "CommunityNode",
+    "KCliqueNode",
+    "LouvainNode",
     "BubbleNode",
+    "BubbleKCliqueNode",
+    "BubbleLouvainNode",
     "HCBFNode",
+    "HCBFKCliqueNode",
+    "HCBFLouvainNode",
 ]
 __author__ = 'Jarrod Pas <j.pas@usask.ca>'
 
@@ -301,6 +307,35 @@ class CommunityNode(Node):
         ]
 
 
+class LouvainNode(CommunityNode):
+    """Wrapper to add louvain community detection automatically to a node."""
+
+    def __init__(self, **options):
+        """
+        Create lovain node.
+
+        Keyword Arguments:
+        epoch -- how often to recalculate communities
+        """
+        options['community'] = LouvainCommunity(options['epoch'])
+        super().__init__(**options)
+
+
+class KCliqueNode(CommunityNode):
+    """Wrapper to add kclique community detection automatically to a node."""
+
+    def __init__(self, **options):
+        """
+        Create k-clique node.
+
+        Keyword Arguments:
+        epoch -- how often to recalculate communities
+        k -- initial community size
+        """
+        options['community'] = KCliqueCommunity(options['epoch'], options['k'])
+        super().__init__(**options)
+
+
 def _decide(node, others, key):
     """
     Make a decision on which node to send to best is decided based on key.
@@ -349,6 +384,18 @@ class BubbleNode(CommunityNode):
         return {}
 
 
+class BubbleKCliqueNode(KCliqueNode, BubbleNode):
+    """Bubble node with k-clique community detection."""
+
+    pass
+
+
+class BubbleLouvainNode(LouvainNode, BubbleNode):
+    """Bubble node with louvain community detection."""
+
+    pass
+
+
 class HCBFNode(CommunityNode):
     """Node with Hybrid Community Based forwarding."""
 
@@ -392,3 +439,15 @@ class HCBFNode(CommunityNode):
                 return {target: 'local-popularity'}
 
         return {}
+
+
+class HCBFKCliqueNode(KCliqueNode, HCBFNode):
+    """HCBF node with k-clique community detection."""
+
+    pass
+
+
+class HCBFLouvainNode(LouvainNode, HCBFNode):
+    """HCBF node with louvain community detection."""
+
+    pass