Move experimental cell spaces to normal

benchmarks/BoltzmannWealth/boltzmann_wealth.py

@@ -4,6 +4,7 @@
 """
 
 import mesa
+import mesa.spaces as spaces
 
 
 def compute_gini(model):
@@ -42,17 +43,18 @@ def __init__(self, seed=None, n=100, width=10, height=10):
         """
         super().__init__(seed=seed)
         self.num_agents = n
-        self.grid = mesa.space.MultiGrid(width, height, True)
+        self.grid = spaces.OrthogonalMooreGrid((width, height))
+        self.schedule = mesa.time.RandomActivation(self)
         self.datacollector = mesa.DataCollector(
             model_reporters={"Gini": compute_gini}, agent_reporters={"Wealth": "wealth"}
         )
         # Create agents
         for _ in range(self.num_agents):
-            a = MoneyAgent(self)
+            agent = MoneyAgent(self)
             # Add the agent to a random grid cell
-            x = self.random.randrange(self.grid.width)
-            y = self.random.randrange(self.grid.height)
-            self.grid.place_agent(a, (x, y))
+            x = self.random.randrange(width)
+            y = self.random.randrange(height)
+            agent.move_to(self.grid[(x, y)])
 
         self.running = True
         self.datacollector.collect(self)
@@ -74,7 +76,7 @@ def run_model(self, n):
             self.step()
 
 
-class MoneyAgent(mesa.Agent):
+class MoneyAgent(mesa.spaces.CellAgent):
     """An agent with fixed initial wealth."""
 
     def __init__(self, model):
@@ -86,27 +88,21 @@ def __init__(self, model):
         super().__init__(model)
         self.wealth = 1
 
-    def move(self):
-        """Move the agent to a random neighboring cell."""
-        possible_steps = self.model.grid.get_neighborhood(
-            self.pos, moore=True, include_center=False
-        )
-        new_position = self.random.choice(possible_steps)
-        self.model.grid.move_agent(self, new_position)
-
     def give_money(self):
-        """Give money to a random cell mate."""
-        cellmates = self.model.grid.get_cell_list_contents([self.pos])
-        cellmates.pop(
-            cellmates.index(self)
-        )  # Ensure agent is not giving money to itself
+        cellmates = [agent for agent in self.cell.agents if agent is not self]
         if len(cellmates) > 0:
             other = self.random.choice(cellmates)
             other.wealth += 1
             self.wealth -= 1
 
     def step(self):
         """Run the agent for 1 step."""
-        self.move()
+        self.move_to(self.cell.neighborhood().select_random_cell())
         if self.wealth > 0:
             self.give_money()
+
+
+if __name__ == "__main__":
+    model = BoltzmannWealth()
+    for _ in range(10):
+        model.step()

benchmarks/Schelling/schelling.py

@@ -3,7 +3,7 @@
 from __future__ import annotations
 
 from mesa import Model
-from mesa.experimental.cell_space import Cell, CellAgent, OrthogonalMooreGrid
+from mesa.spaces import CellAgent, OrthogonalMooreGrid
 
 
 class SchellingAgent(CellAgent):

benchmarks/WolfSheep/wolf_sheep.py

@@ -10,8 +10,8 @@
 import math
 
 from mesa import Model
-from mesa.experimental.cell_space import CellAgent, FixedAgent, OrthogonalVonNeumannGrid
 from mesa.experimental.devs import ABMSimulator
+from mesa.spaces import CellAgent, OrthogonalVonNeumannGrid
 
 
 class Animal(CellAgent):

mesa/__init__.py

@@ -5,7 +5,9 @@
 
 import datetime
 
-import mesa.space as space
+import mesa.space as old_space
+
+# import mesa.spaces as spaces
 import mesa.time as time
 from mesa.agent import Agent
 from mesa.batchrunner import batch_run
@@ -16,7 +18,8 @@
     "Model",
     "Agent",
     "time",
-    "space",
+    "old_space",
+    "spaces",
     "DataCollector",
     "batch_run",
     "experimental",

mesa/experimental/__init__.py

@@ -1,7 +1,5 @@
 """Experimental init."""
 
-from mesa.experimental import cell_space
-
 from .solara_viz import JupyterViz, Slider, SolaraViz, make_text
 
-__all__ = ["cell_space", "JupyterViz", "SolaraViz", "make_text", "Slider"]
+__all__ = ["JupyterViz", "SolaraViz", "make_text", "Slider"]

mesa/experimental/components/matplotlib.py

@@ -8,7 +8,6 @@
 from matplotlib.ticker import MaxNLocator
 
 import mesa
-from mesa.experimental.cell_space import VoronoiGrid
 
 
 @solara.component

mesa/spaces/__init__.py

@@ -0,0 +1,25 @@
+from mesa.spaces.cell import Cell
+from mesa.spaces.cell_agent import CellAgent
+from mesa.spaces.cell_collection import CellCollection
+from mesa.spaces.discrete_space import DiscreteSpace
+from mesa.spaces.grid import (
+    Grid,
+    HexGrid,
+    OrthogonalMooreGrid,
+    OrthogonalVonNeumannGrid,
+)
+from mesa.spaces.network import Network
+from mesa.spaces.voronoi import VoronoiGrid
+
+__all__ = [
+    "CellCollection",
+    "Cell",
+    "CellAgent",
+    "DiscreteSpace",
+    "Grid",
+    "HexGrid",
+    "OrthogonalMooreGrid",
+    "OrthogonalVonNeumannGrid",
+    "Network",
+    "VoronoiGrid",
+]

mesa/experimental/cell_space/cell.py → mesa/spaces/cell.py

@@ -7,8 +7,11 @@
 from random import Random
 from typing import TYPE_CHECKING, Any
 
-from mesa.experimental.cell_space.cell_agent import CellAgent
-from mesa.experimental.cell_space.cell_collection import CellCollection
+from mesa.spaces.cell_collection import CellCollection
+
+if TYPE_CHECKING:
+    from mesa.spaces.cell_agent import CellAgent
+
 from mesa.space import PropertyLayer
 
 if TYPE_CHECKING:

mesa/experimental/cell_space/cell_agent.py → mesa/spaces/cell_agent.py

@@ -7,7 +7,7 @@
 from mesa.agent import Agent
 
 if TYPE_CHECKING:
-    from mesa.experimental.cell_space import Cell
+    from mesa.spaces.cell import Cell
 
 
 class HasCellProtocol(Protocol):
@@ -127,7 +127,3 @@ def move(self, direction: str, distance: int = 1):
 
         if direction not in self.DIRECTION_MAP:
             raise ValueError(f"Invalid direction: {direction}")
-
-        move_vector = self.DIRECTION_MAP[direction]
-        for _ in range(distance):
-            self.move_relative(move_vector)

mesa/experimental/cell_space/cell_collection.py → mesa/spaces/cell_collection.py

@@ -9,8 +9,8 @@
 from typing import TYPE_CHECKING, Generic, TypeVar
 
 if TYPE_CHECKING:
-    from mesa.experimental.cell_space.cell import Cell
-    from mesa.experimental.cell_space.cell_agent import CellAgent
+    from mesa.spaces.cell import Cell
+    from mesa.spaces.cell_agent import CellAgent
 
 T = TypeVar("T", bound="Cell")
 

mesa/experimental/cell_space/discrete_space.py → mesa/spaces/discrete_space.py

@@ -7,9 +7,9 @@
 from random import Random
 from typing import Any, Generic, TypeVar
 
-from mesa.experimental.cell_space.cell import Cell
-from mesa.experimental.cell_space.cell_collection import CellCollection
 from mesa.space import PropertyLayer
+from mesa.spaces.cell import Cell
+from mesa.spaces.cell_collection import CellCollection
 
 T = TypeVar("T", bound=Cell)
 

mesa/experimental/cell_space/grid.py → mesa/spaces/grid.py

@@ -7,7 +7,7 @@
 from random import Random
 from typing import Generic, TypeVar
 
-from mesa.experimental.cell_space import Cell, DiscreteSpace
+from mesa.spaces import Cell, DiscreteSpace
 
 T = TypeVar("T", bound=Cell)
 

mesa/experimental/cell_space/network.py → mesa/spaces/network.py

@@ -3,8 +3,8 @@
 from random import Random
 from typing import Any
 
-from mesa.experimental.cell_space.cell import Cell
-from mesa.experimental.cell_space.discrete_space import DiscreteSpace
+from mesa.spaces.cell import Cell
+from mesa.spaces.discrete_space import DiscreteSpace
 
 
 class Network(DiscreteSpace[Cell]):

mesa/experimental/cell_space/voronoi.py → mesa/spaces/voronoi.py

@@ -6,8 +6,8 @@
 
 import numpy as np
 
-from mesa.experimental.cell_space.cell import Cell
-from mesa.experimental.cell_space.discrete_space import DiscreteSpace
+from mesa.spaces.cell import Cell
+from mesa.spaces.discrete_space import DiscreteSpace
 
 
 class Delaunay:

mesa/visualization/components/matplotlib.py

@@ -11,8 +11,8 @@
 from matplotlib.figure import Figure
 
 import mesa
-from mesa.experimental.cell_space import VoronoiGrid
 from mesa.space import PropertyLayer
+from mesa.spaces import VoronoiGrid
 from mesa.visualization.utils import update_counter
 
 

tests/test_cell_space.py

@@ -6,7 +6,8 @@
 import pytest
 
 from mesa import Model
-from mesa.experimental.cell_space import (
+from mesa.space import PropertyLayer
+from mesa.spaces import (
     Cell,
     CellAgent,
     CellCollection,
@@ -18,7 +19,6 @@
     OrthogonalVonNeumannGrid,
     VoronoiGrid,
 )
-from mesa.space import PropertyLayer
 
 
 def test_orthogonal_grid_neumann():

tests/test_solara_viz.py

@@ -128,7 +128,7 @@ def drawer(model):
 
     # check voronoi space drawer
     voronoi_model = mesa.Model()
-    voronoi_model.grid = mesa.experimental.cell_space.VoronoiGrid(
+    voronoi_model.grid = mesa.spaces.VoronoiGrid(
         centroids_coordinates=[(0, 1), (0, 0), (1, 0)],
     )
     solara.render(