[pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

Author: pre-commit-ci[bot]

examples/color_patches/color_patches/model.py

@@ -1,6 +1,4 @@
-"""
-The model - a 2D lattice where agents live and have an opinion
-"""
+"""The model - a 2D lattice where agents live and have an opinion"""
 
 from collections import Counter
 
@@ -14,16 +12,12 @@
 
 
 class ColorCell(CellAgent):
-    """
-    Represents a cell's opinion (visualized by a color)
-    """
+    """Represents a cell's opinion (visualized by a color)"""
 
     OPINIONS = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]
 
     def __init__(self, model, initial_state):
-        """
-        Create a cell, in the given state, at the given row, col position.
-        """
+        """Create a cell, in the given state, at the given row, col position."""
         super().__init__(model)
         self.state = initial_state
         self.next_state = None
@@ -37,8 +31,7 @@ def get_row(self):
         return self.cell.coordinate[1]
 
     def determine_opinion(self):
-        """
-        Determines the agent opinion for the next step by polling its neighbors
+        """Determines the agent opinion for the next step by polling its neighbors
         The opinion is determined by the majority of the 8 neighbors' opinion
         A choice is made at random in case of a tie
         The next state is stored until all cells have been polled
@@ -55,20 +48,15 @@ def determine_opinion(self):
         self.next_state = self.random.choice(tied_opinions)[0]
 
     def assume_opinion(self):
-        """
-        Set the state of the agent to the next state
-        """
+        """Set the state of the agent to the next state"""
         self.state = self.next_state
 
 
 class ColorPatches(mesa.Model):
-    """
-    represents a 2D lattice where agents live
-    """
+    """represents a 2D lattice where agents live"""
 
     def __init__(self, width=20, height=20):
-        """
-        Create a 2D lattice with strict borders where agents live
+        """Create a 2D lattice with strict borders where agents live
         The agents next state is first determined before updating the grid
         """
         super().__init__()
@@ -88,8 +76,7 @@ def __init__(self, width=20, height=20):
         self.running = True
 
     def step(self):
-        """
-        Perform the model step in two stages:
+        """Perform the model step in two stages:
         - First, all agents determine their next opinion based on their neighbors current opinions
         - Then, all agents update their opinion to the next opinion
         """
@@ -98,8 +85,7 @@ def step(self):
 
     @property
     def grid(self):
-        """
-        /mesa/visualization/modules/CanvasGridVisualization.py
+        """/mesa/visualization/modules/CanvasGridVisualization.py
         is directly accessing Model.grid
              76     def render(self, model):
              77         grid_state = defaultdict(list)

examples/hex_ant/agent.py

@@ -9,9 +9,7 @@ class AntState(Enum):
 
 
 class Ant(CellAgent):
-    """
-    An Ant agent that navigates the HexGrid using pheromones.
-    """
+    """An Ant agent that navigates the HexGrid using pheromones."""
 
     def __init__(self, model):
         super().__init__(model)
@@ -22,13 +20,11 @@ def __init__(self, model):
         self.wiggle_bias = self.random.uniform(-0.1, 0.1)
 
     def step(self):
-        """
-        Agent Life Cycle:
+        """Agent Life Cycle:
         1. SENSE: Check neighbors.
         2. DECIDE: Switch state if needed.
         3. ACT: Move and deposit pheromones.
         """
-
         # --- State Logic ---
         if self.state == AntState.FORAGING:
             self._step_foraging()
@@ -76,8 +72,7 @@ def _drop_food(self):
         self.state = AntState.FORAGING
 
     def _move_towards_gradient(self, layer_name, randomness=0.1):
-        """
-        Find the neighbor with the highest value in 'layer_name'.
+        """Find the neighbor with the highest value in 'layer_name'.
         With some probability, move randomly to explore.
         """
         if self.random.random() < randomness:

examples/hex_ant/app.py

@@ -10,9 +10,7 @@
 
 
 def agent_portrayal(agent):
-    """
-    Portrayal for the Ant agents.
-    """
+    """Portrayal for the Ant agents."""
     if agent.state == AntState.FORAGING:
         return {"color": "tab:red", "size": 19}
     elif agent.state == AntState.RETURNING:
@@ -21,9 +19,7 @@ def agent_portrayal(agent):
 
 
 def property_portrayal(layer):
-    """
-    Portrayal for the Environment (PropertyLayers).
-    """
+    """Portrayal for the Environment (PropertyLayers)."""
     if layer.name == "food":
         # Dense Food clusters
         return PropertyLayerStyle(

examples/hex_ant/model.py

@@ -5,8 +5,7 @@
 
 
 class AntForaging(mesa.Model):
-    """
-    Au ant foraging model on a Hexagonal Grid.
+    """Au ant foraging model on a Hexagonal Grid.
 
     This demonstrates the power of PropertyLayers for efficient environmental
     simulation (pheromones) combined with complex agent movement.
@@ -98,9 +97,7 @@ def step(self):
         self.agents.shuffle_do("step")
 
     def _update_pheromone_layer(self, layer_name):
-        """
-        Apply evaporation to a pheromone layer.
-        """
+        """Apply evaporation to a pheromone layer."""
         np_layer = self.grid.property_layers[layer_name]
         np_layer *= 1.0 - self.evaporation_rate
 

examples/humanitarian_aid_distribution/app.py

@@ -5,8 +5,7 @@
 
 
 def agent_portrayal(agent):
-    """
-    Defines how agents look in the browser visualization.
+    """Defines how agents look in the browser visualization.
 
     Color Coding for Beneficiaries (Needs-Based status):
     - RED -> Desperate

examples/humanitarian_aid_distribution/humanitarian_aid_distribution/agents.py

@@ -2,8 +2,7 @@
 
 
 class Beneficiary(CellAgent):
-    """
-    Simulates a person with dynamic needs (water and food).
+    """Simulates a person with dynamic needs (water and food).
 
     The agent follows a Needs-Based Architecture:
     1. Biological drives (hunger/thirst) increase over time.
@@ -21,8 +20,7 @@ class Beneficiary(CellAgent):
     def __init__(
         self, model, cell, water_decay=2, food_decay=1, critical_days_threshold=5
     ):
-        """
-        Create a new Beneficiary agent.
+        """Create a new Beneficiary agent.
 
         Args:
             model: The Mesa model instance.
@@ -49,9 +47,7 @@ def __init__(
     CRITICAL = 90  # "Emergency"
 
     def move_towards(self, target_pos):
-        """
-        Moves the agent one step closer to the target position.
-        """
+        """Moves the agent one step closer to the target position."""
         current_x, current_y = self.cell.coordinate
         target_x, target_y = target_pos
 
@@ -72,8 +68,7 @@ def move_towards(self, target_pos):
         self.cell = self.model.grid[(next_x, next_y)]
 
     def step(self):
-        """
-        Advance the agent by one step.
+        """Advance the agent by one step.
 
         Lifecycle:
         1. Biological Decay: Needs increase naturally.
@@ -151,9 +146,9 @@ def wander(self):
         self.cell = self.cell.neighborhood.select_random_cell()
 
     def find_nearest_truck(self, radius=None):
-        """
-        Scans the neighborhood for a Truck agent.
+        """Scans the neighborhood for a Truck agent.
         Returns the nearest Truck agent or None.
+
         Args:
             radius (int, optional): limit search to this distance. None = global.
         """
@@ -184,8 +179,7 @@ def get_dist(t):
 
 
 class Truck(CellAgent):
-    """
-    A delivery agent that distributes supplies to Beneficiaries.
+    """A delivery agent that distributes supplies to Beneficiaries.
 
     Behavior:
     - Scans for beneficiaries with high needs.
@@ -206,7 +200,6 @@ def __init__(self, model, cell):
 
     def distribute_aid(self, beneficiary, amount=10):
         """Split aid proportionally to need intensity"""
-
         total_need = beneficiary.water_urgency + beneficiary.food_urgency
 
         if total_need == 0:
@@ -231,9 +224,7 @@ def distribute_aid(self, beneficiary, amount=10):
         return water_satisfied + food_satisfied
 
     def move_towards(self, target_pos):
-        """
-        Moves the agent one step closer to the target position.
-        """
+        """Moves the agent one step closer to the target position."""
         current_x, current_y = self.cell.coordinate
         target_x, target_y = target_pos
 
@@ -255,8 +246,7 @@ def get_distance(self, pos):
         return abs(x1 - x2) + abs(y1 - y2)
 
     def step(self):
-        """
-        Advance the truck by one step.
+        """Advance the truck by one step.
 
         Lifecycle:
         1. Logistics: Refill if empty.

examples/humanitarian_aid_distribution/humanitarian_aid_distribution/model.py

@@ -5,8 +5,7 @@
 
 
 class HumanitarianModel(mesa.Model):
-    """
-    The central environment for the Needs-Based Architecture simulation.
+    """The central environment for the Needs-Based Architecture simulation.
 
     This model manages:
     1. A grid space where agents interact.
@@ -28,8 +27,7 @@ def __init__(
         rng=None,
         critical_days_threshold=5,
     ):
-        """
-        Create a new Humanitarian model with the given parameters.
+        """Create a new Humanitarian model with the given parameters.
 
         Args:
             num_beneficiaries (int): Number of beneficiaries to create.
@@ -69,9 +67,7 @@ def __init__(
         self.running = True
 
     def create_agents(self):
-        """
-        Create and place agents using high-level grid methods.
-        """
+        """Create and place agents using high-level grid methods."""
         random_cells = self.random.choices(
             list(self.grid.all_cells), k=self.num_beneficiaries
         )
@@ -92,8 +88,7 @@ def create_agents(self):
         )
 
     def step(self):
-        """
-        Advance the model by one step.
+        """Advance the model by one step.
 
         Lifecycle:
         1. Collect Data: Record current model stats (e.g. Average Urgency).
@@ -104,8 +99,7 @@ def step(self):
 
     @staticmethod
     def get_average_urgency(model):
-        """
-        Helper for data collection: Calculates the average urgency of all beneficiaries.
+        """Helper for data collection: Calculates the average urgency of all beneficiaries.
 
         Args:
             model (HumanitarianModel): The model instance.

examples/rumor_mill/app.py

@@ -1,15 +1,12 @@
-"""
-Visualization interface for the Rumor Mill model using Mesa's SolaraViz.
-"""
+"""Visualization interface for the Rumor Mill model using Mesa's SolaraViz."""
 
 from mesa.visualization import SolaraViz, SpaceRenderer, make_plot_component
 from mesa.visualization.components import AgentPortrayalStyle
 from rumor_mill.model import RumorMillModel
 
 
 def agent_portrayal(agent):
-    """
-    Define how agents are displayed in the grid visualization.
+    """Define how agents are displayed in the grid visualization.
     Red = knows rumor, Blue = doesn't know rumor
     """
     return AgentPortrayalStyle(color="red" if agent.knows_rumor else "blue", size=50)

examples/rumor_mill/rumor_mill/agent.py

@@ -2,13 +2,10 @@
 
 
 class Person(CellAgent):
-    """
-    A person agent that can know and spread a rumor.
-    """
+    """A person agent that can know and spread a rumor."""
 
     def __init__(self, model, cell, rumor_spread_chance=0.5, color=None):
-        """
-        Initialize a Person agent.
+        """Initialize a Person agent.
 
         Args:
             model: The model instance
@@ -26,9 +23,7 @@ def __init__(self, model, cell, rumor_spread_chance=0.5, color=None):
         self.color = color if color is not None else self.random.choice(["red", "blue"])
 
     def step(self):
-        """
-        Agent behavior each step: if knows rumor, tell a random neighbor.
-        """
+        """Agent behavior each step: if knows rumor, tell a random neighbor."""
         if self.knows_rumor:
             # Get all neighbors in the cell's neighborhood (excluding self)
             neighbors = [

examples/rumor_mill/rumor_mill/model.py

@@ -6,9 +6,7 @@
 
 
 class RumorMillModel(Model):
-    """
-    Model simulating rumor spread through a population on a grid.
-    """
+    """Model simulating rumor spread through a population on a grid."""
 
     def __init__(
         self,
@@ -19,8 +17,7 @@ def __init__(
         eight_neightborhood=False,
         rng=None,
     ):
-        """
-        Initialize the Rumor Mill model.
+        """Initialize the Rumor Mill model.
 
         Args:
             width: Grid width