chore: improved readability

Author: Spartan-71

examples/termites/README.md

@@ -15,7 +15,7 @@ Over time, these simple interactions lead to the formation of wood chip piles, i
 
 ## Installation
 
-Make sure that you have installed the `latest` version of mesa i.e `3.2` onwards.
+Make sure that you have installed the `latest` version of mesa.
 
 ## Usage
 

examples/termites/app.py

@@ -14,7 +14,7 @@
 
 
 def agent_portrayal(agent):
-    return {"marker": ">", "color": "red" if agent.hasWoodChip else "black", "size": 10}
+    return {"marker": ">", "color": "red" if agent.has_woodchip else "black", "size": 10}
 
 
 model_params = {

examples/termites/termites/agents.py

@@ -6,7 +6,7 @@ class Termite(CellAgent):
     A Termite agent that has ability to carry woodchip.
 
     Attributes:
-        hasWoodChip(bool): True if the agent is carrying a wood chip.
+        has_woodchip(bool): True if the agent is carrying a wood chip.
     """
 
     def __init__(self, model, cell):
@@ -17,15 +17,15 @@ def __init__(self, model, cell):
         """
         super().__init__(model)
         self.cell = cell
-        self.hasWoodChip = False
+        self.has_woodchip = False
 
     def wiggle(self):
         self.cell = self.model.random.choice(self.model.grid.all_cells.cells)
 
     def search_for_chip(self):
         if self.cell.woodcell:
             self.cell.woodcell = False
-            self.hasWoodChip = True
+            self.has_woodchip = True
 
             for _ in range(10):
                 new_cell = self.cell.neighborhood.select_random_cell()
@@ -46,12 +46,12 @@ def find_new_pile(self):
         return True
 
     def put_down_chip(self):
-        if not self.hasWoodChip:
+        if not self.has_woodchip:
             return True
 
         if not self.cell.woodcell:
             self.cell.woodcell = True
-            self.hasWoodChip = False
+            self.has_woodchip = False
 
             self.get_away()
             return True
@@ -77,7 +77,7 @@ def step(self):
           2. Find a new pile (a cell with a wood chip) if carrying a chip.
           3. Put down the chip if a suitable location is found.
         """
-        if not self.hasWoodChip:
+        if not self.has_woodchip:
             while not self.search_for_chip():
                 pass
 

examples/termites/termites/model.py

@@ -7,7 +7,7 @@
 
 class TermiteModel(Model):
     """
-    A simulation that depicts behavior of termite agents gathering wood chips into piles.
+    A simulation that shows behavior of termite agents gathering wood chips into piles.
     """
 
     def __init__(
@@ -31,6 +31,8 @@ def __init__(
         self.wood_chips_layer = PropertyLayer(
             "woodcell", (width, height), default_value=False, dtype=bool
         )
+
+        # Randomly distribute wood chips, by directly modifying the layer's underlying ndarray
         self.wood_chips_layer.data = np.random.choice(
             [True, False],
             size=(width, height),
@@ -39,10 +41,11 @@ def __init__(
 
         self.grid.add_property_layer(self.wood_chips_layer)
 
+        # Create agents and randomly distribute them over the grid
         Termite.create_agents(
-            self,
-            self.num_termites,
-            self.random.sample(self.grid.all_cells.cells, k=self.num_termites),
+            model = self,
+            n = self.num_termites,
+            cell = self.random.sample(self.grid.all_cells.cells, k=self.num_termites),
         )
 
     def step(self):