Group entity

docs/framework_documentation/abstract_level/entity_types/group.rst

@@ -11,7 +11,7 @@ may not be sufficient and a distinction of social strata or other social groups
 "indigenous people", "social democrats", a certain NGO, ...)
 that is transverse to the former partitioning is helpful in addition.
 
-For this, we will in the future provide an entity-type "group" 
+For this, the entity-type "group" is provided
 which is meant to represent any grouping of individuals (that may come from one or several social systems) 
 by meaningful cultural or social-metabolic aspects.
 
@@ -33,25 +33,30 @@ Basic relationships to other entity-types
 
 A group will usually...
 
--  have several member :doc:`individuals<individual>`
+-  have several members :doc:`individuals<individual>`,
+   which is represented by a group membership directed network owned by the culture taxon
 
 In addition, a group may...
 
--  have one or several "leader" :doc:`individuals<individual>`, 
-   of which one may be the dominant leader
+-  have an "intra" group network between members :doc:`individuals<individual>`
+   (this feature is not completely implemented yet)
 
--  have a "headquarters" :doc:`cell<cell>`
+-  have one or several "leader" :doc:`individuals<individual>`,
+   of which one may be the dominant leader (this feature is not implemented yet)
 
--  be related to other groups via some network owned by the culture taxon 
+-  have a "headquarters" :doc:`cell<cell>` (this feature is not implemented yet)
+
+-  be related to other groups via an "inter" network owned by the culture taxon
    (which will typically interact with the network of personal acquaintance between member individuals)
+   - (this feature is not completely implemented yet)
 
--  act as the current "elite" in some :doc:`social system<social system>`
+-  act as the current "elite" in some :doc:`social system<social system>` (this feature is not implemented yet)
 
 All these relationships may be dynamic.
 
 Finally, a group may...
 
 -  be a permanent subgroup of a larger group or :doc:`social system<social system>` *by definition* 
    (rather than by coincidence, e.g., "scientists" are by definition a subgroup of the group "academics",
-   and "German workers" may be by definition a subgroup of the social system "Germany")
+   and "German workers" may be by definition a subgroup of the social system "Germany") - (this feature is not implemented yet)
 

pycopancore/data_model/master_data_model/__init__.py

@@ -37,5 +37,8 @@
 from .individual import Individual as I
 from .individual import Individual as individual
 from .individual import Individual
+from .group import Group as G
+from .group import Group as group
+from .group import Group
 
 from .. import unity

pycopancore/data_model/master_data_model/culture.py

@@ -94,7 +94,24 @@ class Culture:
                  scale='nominal',
                  datatype=set)
 
-
+
+    # group entity related networks
+
+    inter_group_network = \
+        Variable("inter group network",
+                 """Basic undirected social network between
+                 Groups.""",
+                 ref="https://en.wikipedia.org/wiki/Social_network#Meso_level",
+                 scale='nominal',
+                 datatype=Graph)
+
+    group_membership_network = \
+        Variable("group membership network",
+                 """Directed network from individual to group that
+                 signifies membership (to avoid problems due to n to n relation)""",
+                 scale='nominal',
+                 datatype=DiGraph)
+
     # socio-cultural traits that may occur on different levels:
 
     is_environmentally_friendly = \

pycopancore/data_model/master_data_model/group.py

@@ -0,0 +1,33 @@
+"""Master data model for group."""
+
+"""https://github.com/pik-copan/pycopancore/blob/master/docs/framework_documentation/abstract_level/entity_types/group.rst"""
+
+from .. import Variable
+
+from networkx import Graph
+
+class Group:
+
+    #TODO: specify edges
+
+    intra_group_network = \
+        Variable("intra group network",
+                 """Basic undirected social network between
+                 Group members.""",
+                 scale='nominal',
+                 datatype=Graph)    
+
+    has_leader = \
+        Variable("has a leader",
+                 "whether the group has a leader",
+                 scale="ordinal", levels=[False, True], default=False)
+
+    has_headquarter = \
+        Variable("has a headquarter",
+                 "whether the group has a headquarter located in a cell",
+                 scale="ordinal", levels=[False, True], default=False)
+
+
+
+
+

pycopancore/model_components/abstract/__init__.py

@@ -16,6 +16,7 @@
 from .social_system import SocialSystem
 from .cell import Cell
 from .individual import Individual
+from .group import Group
 
 from .environment import Environment
 from .metabolism import Metabolism

pycopancore/model_components/abstract/group.py

@@ -0,0 +1,25 @@
+"""Abstract Group entity type class, inherited by base model component."""
+
+# This file is part of pycopancore.
+#
+# Copyright (C) 2016-2017 by COPAN team at Potsdam Institute for Climate
+# Impact Research
+#
+# URL: <http://www.pik-potsdam.de/copan/software>
+# Contact: core@pik-potsdam.de
+# License: BSD 2-clause license
+
+from ...private import _AbstractEntityMixin
+from ...data_model import OrderedSet
+
+
+class Group (_AbstractEntityMixin):
+    """Abstract Group entity type class.
+
+    Inherited by base model component.
+    """
+
+    variables = OrderedSet()
+    """All variables occurring in this entity type"""
+
+

pycopancore/model_components/base/implementation/__init__.py

@@ -17,6 +17,7 @@
 from .social_system import SocialSystem
 from .cell import Cell
 from .individual import Individual
+from .group import Group
 
 from .environment import Environment
 from .metabolism import Metabolism

pycopancore/model_components/base/implementation/culture.py

@@ -14,8 +14,7 @@
 
 from .. import interface as I
 
-from networkx import Graph
-
+from networkx import Graph, DiGraph
 
 class Culture (I.Culture, abstract.Culture):
     """Culture process taxon mixin implementation class."""
@@ -25,6 +24,7 @@ class Culture (I.Culture, abstract.Culture):
     def __init__(self,
                  *,
                  acquaintance_network=None,
+                 group_membership_network=None,
                  **kwargs):
         """Initialize the unique instance of Culture.
 
@@ -33,6 +33,9 @@ def __init__(self,
         acquaintance_network: Graph
             The Network of acquaintances which is managed by Culture
             (default is None)
+        group_membership_network: DiGraph
+            The Network between Individiuals and groups, which is managed
+            by Culture (default is None)
         **kwargs
             keyword arguments passed to super()
 
@@ -43,7 +46,14 @@ def __init__(self,
             acquaintance_network = Graph()
         assert isinstance(acquaintance_network, Graph)
         self.acquaintance_network = acquaintance_network
+
+        if group_membership_network is None:
+            group_membership_network = DiGraph()
+        assert isinstance(group_membership_network, DiGraph)
+        self.group_membership_network = group_membership_network
+
         self._worlds = set()
+        self._groups = set()
 
         # make sure all variable values are valid:
         self.assert_valid()
@@ -54,6 +64,11 @@ def worlds(self):
         """Get the set of all Worlds this Culture acts in."""
         return self._worlds
 
+    @property  # read-only
+    def groups(self):
+        """Get the set of all Groups in this Culture."""
+        return self._groups
+
     # no process-related methods
 
     processes = []  # no processes in base