ongoing work

docs/tutorials/9_batch_run.ipynb

@@ -410,7 +410,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.12.5"
+   "version": "3.12.2"
   },
   "widgets": {
    "state": {},

mesa/agent.py

@@ -143,6 +143,7 @@ def __getitem__(self, i):
     @property
     def random(self) -> Random:
         """Return a seeded stdlib rng."""
+        warnings.warn("the use of random is deprecated, please use rng instead", FutureWarning, stacklevel=2)
         return self.model.random
 
     @property

mesa/discrete_space/cell.py

@@ -51,8 +51,7 @@ class Cell:
         "connections",
         "coordinate",
         "properties",
-        "random",
-        "rng",
+        "rng"
     ]
 
     @deprecate_kwarg("random")

mesa/discrete_space/cell_collection.py

@@ -42,7 +42,8 @@ class CellCollection[T: Cell]:
     Attributes:
         cells (List[Cell]): The list of cells this collection represents
         agents (List[CellAgent]) : List of agents occupying the cells in this collection
-        random (Random) : The random number generator
+        random (Random) : The random number generator, deprecated
+        rng (Random) : The random number generator
 
     Notes:
         A `UserWarning` is issued if `random=None`. You can resolve this warning by explicitly

mesa/discrete_space/voronoi.py

@@ -215,7 +215,7 @@ def __init__(
         self._validate_parameters()
 
         self._cells = {
-            i: cell_klass(self.centroids_coordinates[i], capacity, rng=self.random)
+            i: cell_klass(self.centroids_coordinates[i], capacity, rng=self.rng)
             for i in range(len(self.centroids_coordinates))
         }
 

mesa/examples/advanced/epstein_civil_violence/model.py

@@ -54,7 +54,7 @@ def __init__(
         self.max_iters = max_iters
 
         self.grid = mesa.discrete_space.OrthogonalVonNeumannGrid(
-            (width, height), capacity=1, torus=True, random=self.random
+            (width, height), capacity=1, torus=True, rng=self.rng
         )
 
         model_reporters = {

mesa/examples/advanced/pd_grid/model.py

@@ -27,7 +27,7 @@ def __init__(
         """
         super().__init__(rng=rng)
         self.activation_order = activation_order
-        self.grid = OrthogonalMooreGrid((width, height), torus=True, random=self.random)
+        self.grid = OrthogonalMooreGrid((width, height), torus=True, rng=self.rng)
 
         if payoffs is not None:
             self.payoff = payoffs

mesa/examples/advanced/sugarscape_g1mt/model.py

@@ -66,7 +66,7 @@ def __init__(
 
         # initiate mesa grid class
         self.grid = OrthogonalVonNeumannGrid(
-            (self.width, self.height), torus=False, random=self.random
+            (self.width, self.height), torus=False, rng=self.rng
         )
         # initiate datacollector
         self.datacollector = mesa.DataCollector(

mesa/examples/basic/boltzmann_wealth_model/agents.py

@@ -30,7 +30,7 @@ def give_money(self):
         cellmates = [a for a in self.cell.agents if a is not self]
 
         if cellmates:  # Only give money if there are other agents present
-            other = cellmates[self.rng.integers(0, len(cellmates))]
+            other = cellmates[0] if len(cellmates)==1 else cellmates[self.rng.integers(0, len(cellmates))]
             other.wealth += 1
             self.wealth -= 1
 

mesa/examples/basic/conways_game_of_life/model.py

@@ -10,16 +10,18 @@ def __init__(self, width=50, height=50, initial_fraction_alive=0.2, rng=None):
         """Create a new playing area of (width, height) cells."""
         super().__init__(rng=rng)
         # Use a simple grid, where edges wrap around.
-        self.grid = OrthogonalMooreGrid((width, height), capacity=1, torus=True)
+        self.grid = OrthogonalMooreGrid((width, height), capacity=1, torus=True, rng=rng)
 
         # Place a cell at each location, with some initialized to
         # ALIVE and some to DEAD.
+        random_floats = self.rng.uniform(0, 1, size=(width, height))
+
         for cell in self.grid.all_cells:
             Cell(
                 self,
                 cell,
                 init_state=Cell.ALIVE
-                if self.random.random() < initial_fraction_alive
+                if random_floats[cell.coordinate] < initial_fraction_alive
                 else Cell.DEAD,
             )
 

mesa/examples/basic/virus_on_network/agents.py

@@ -35,7 +35,7 @@ def __init__(
     def try_to_infect_neighbors(self):
         for agent in self.cell.neighborhood.agents:
             if (agent.state is State.SUSCEPTIBLE) and (
-                self.random.random() < self.virus_spread_chance
+                self.rng.random() < self.virus_spread_chance
             ):
                 agent.state = State.INFECTED
 

mesa/examples/basic/virus_on_network/model.py

@@ -41,7 +41,7 @@ def __init__(
         super().__init__(rng=rng)
         prob = avg_node_degree / num_nodes
         graph = nx.erdos_renyi_graph(n=num_nodes, p=prob)
-        self.grid = Network(graph, capacity=1, random=self.random)
+        self.grid = Network(graph, capacity=1, rng=self.rng)
 
         self.initial_outbreak_size = (
             initial_outbreak_size if initial_outbreak_size <= num_nodes else num_nodes
@@ -69,8 +69,8 @@ def __init__(
 
         # Infect some nodes
         infected_nodes = CellCollection(
-            self.random.sample(list(self.grid.all_cells), self.initial_outbreak_size),
-            random=self.random,
+            self.rng.choice(list(self.grid.all_cells), size=self.initial_outbreak_size),
+            rng=self.rng,
         )
         for a in infected_nodes.agents:
             a.state = State.INFECTED

mesa/experimental/meta_agents/meta_agent.py

@@ -63,7 +63,7 @@ def evaluate_combination(
         Optional[Tuple[AgentSet, float]]: The evaluated group and its value,
         or None.
     """
-    group_set = AgentSet(candidate_group, random=model.random)
+    group_set = AgentSet(candidate_group, rng=model.rng)
     if evaluation_func:
         value = evaluation_func(group_set)
         return group_set, value
@@ -287,7 +287,7 @@ def __init__(
             name (str, optional): The name of the MetaAgent. Defaults to "MetaAgent".
         """
         super().__init__(model)
-        self._constituting_set = AgentSet(agents or [], random=model.random)
+        self._constituting_set = AgentSet(agents or [], rng=model.rng)
         self.name = name
 
         # Add ref to meta_agent in constituting_agents