fix warehouse

Author: tpike3

examples/warehouse/Readme.md

@@ -16,6 +16,8 @@ This model demonstrates deliberate meta-agent creation. It shows the basics of m
 
 In its current configuration, agents being part of multiple meta-agents is not supported
 
+An additional item of note is that to reference the RobotAgent created in model you will see `type(self.RobotAgent)` or `type(model.RobotAgent)` in various places. If you have any ideas for how to make this more user friendly please let us know or do a pull request.
+
 ## Installation
 
 This model requires Mesa's recommended install

examples/warehouse/agents.py

@@ -10,7 +10,7 @@ class InventoryAgent(FixedAgent):
     """
 
     def __init__(self, model, cell, item: str):
-        super().__init__(model, key_by_name=True)
+        super().__init__(model)
         self.cell = cell
         self.item = item
         self.quantity = 1000  # Default quantity
@@ -24,7 +24,7 @@ class RouteAgent(mesa.Agent):
     """
 
     def __init__(self, model):
-        super().__init__(model, key_by_name=True)
+        super().__init__(model)
 
     def find_path(self, start, goal) -> list[tuple[int, int, int]] | None:
         """
@@ -82,7 +82,7 @@ class SensorAgent(mesa.Agent):
     """
 
     def __init__(self, model):
-        super().__init__(model, key_by_name=True)
+        super().__init__(model)
 
     def move(
         self, coord: tuple[int, int, int], path: list[tuple[int, int, int]]
@@ -109,9 +109,9 @@ def move(
             self.meta_agent.cell = self.random.choice(empty_neighbors)
 
         # Recalculate path
-        new_path = self.meta_agent.get_subagent_instance(RouteAgent).find_path(
-            self.meta_agent.cell, self.meta_agent.item.cell
-        )
+        new_path = self.meta_agent.get_constituting_agent_instance(
+            RouteAgent
+        ).find_path(self.meta_agent.cell, self.meta_agent.item.cell)
         self.meta_agent.path = new_path
         return "recalculating"
 
@@ -122,7 +122,7 @@ class WorkerAgent(mesa.Agent):
     """
 
     def __init__(self, model, ld, cs):
-        super().__init__(model, key_by_name=True)
+        super().__init__(model)
         self.loading_dock = ld
         self.charging_station = cs
         self.path: list[tuple[int, int, int]] | None = None
@@ -140,7 +140,7 @@ def continue_task(self):
         """
         Continues the task if the robot is able to perform it.
         """
-        status = self.meta_agent.get_subagent_instance(SensorAgent).move(
+        status = self.meta_agent.get_constituting_agent_instance(SensorAgent).move(
             self.cell.coordinate, self.path
         )
 

examples/warehouse/app.py

@@ -1,10 +1,10 @@
 import matplotlib.pyplot as plt
 import pandas as pd
 import solara
+from agents import InventoryAgent
 from mesa.visualization import SolaraViz
 from mesa.visualization.utils import update_counter
-
-from examples.warehouse.model import WarehouseModel
+from model import WarehouseModel
 
 # Constants
 LOADING_DOCKS = [(0, 0, 0), (0, 2, 0), (0, 4, 0), (0, 6, 0), (0, 8, 0)]
@@ -53,8 +53,8 @@ def plot_warehouse(model):
     update_counter.get()
 
     # Prepare data for inventory and robot agents
-    inventory_data = prepare_agent_data(model, "InventoryAgent", "Inventory")
-    robot_data = prepare_agent_data(model, "RobotAgent", "Robot")
+    inventory_data = prepare_agent_data(model, InventoryAgent, "Inventory")
+    robot_data = prepare_agent_data(model, type(model.RobotAgent), "Robot")
 
     # Combine data into a single DataFrame
     data = pd.DataFrame(inventory_data + robot_data)

examples/warehouse/model.py

@@ -1,15 +1,14 @@
 import mesa
-from mesa.discrete_space import OrthogonalMooreGrid
-from mesa.discrete_space.cell_agent import CellAgent
-from mesa.experimental.meta_agents.meta_agent import create_meta_agent
-
-from examples.warehouse.agents import (
+from agents import (
     InventoryAgent,
     RouteAgent,
     SensorAgent,
     WorkerAgent,
 )
-from examples.warehouse.make_warehouse import make_warehouse
+from make_warehouse import make_warehouse
+from mesa.discrete_space import OrthogonalMooreGrid
+from mesa.discrete_space.cell_agent import CellAgent
+from mesa.experimental.meta_agents.meta_agent import create_meta_agent
 
 # Constants for configuration
 LOADING_DOCKS = [(0, 0, 0), (0, 2, 0), (0, 4, 0), (0, 6, 0), (0, 8, 0)]
@@ -63,7 +62,7 @@ def __init__(self, seed=42):
 
         # Create Robot Agents
         for idx in range(len(self.loading_docks)):
-            # Create sub-agents
+            # Create constituting_agents
             router = RouteAgent(self)
             sensor = SensorAgent(self)
             worker = WorkerAgent(
@@ -73,17 +72,17 @@ def __init__(self, seed=42):
             )
 
             # Create meta-agent and place in warehouse
-            create_meta_agent(
+            self.RobotAgent = create_meta_agent(
                 self,
                 "RobotAgent",
                 [router, sensor, worker],
-                mesa_agent_type=CellAgent,
+                CellAgent,
                 meta_attributes={
                     "cell": self.warehouse[self.charging_stations[idx]],
                     "status": "open",
                 },
-                assume_subagent_attributes=True,
-                assume_subagent_methods=True,
+                assume_constituting_agent_attributes=True,
+                assume_constituting_agent_methods=True,
             )
 
     def central_move(self, robot):
@@ -99,9 +98,9 @@ def step(self):
         """
         Advance the model by one step.
         """
-        for robot in self.agents_by_type["RobotAgent"]:
+        for robot in self.agents_by_type[type(self.RobotAgent)]:
             if robot.status == "open":  # Assign a task to the robot
-                item = self.random.choice(self.agents_by_type["InventoryAgent"])
+                item = self.random.choice(self.agents_by_type[InventoryAgent])
                 if item.quantity > 0:
                     robot.initiate_task(item)
                     robot.status = "inventory"