Skip to content

Commit 4215706

Browse files
authored
space: Add note that Grids are maintenance only (#2420)
* space: Add note that Grids are maintenance only Add a note to the space module level docstring that the Grids are maintenance only. Also add the PropertyLayer to the classes and remove the Grid, since that's now private (and has been for a while).
1 parent 24fdc16 commit 4215706

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

mesa/space.py

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,21 @@
22
33
Objects used to add a spatial component to a model.
44
5-
* Grid: base grid, which creates a rectangular grid.
6-
* SingleGrid: extension to Grid which strictly enforces one agent per cell.
7-
* MultiGrid: extension to Grid where each cell can contain a set of agents.
8-
* HexGrid: extension to Grid to handle hexagonal neighbors.
5+
.. note::
6+
All Grid classes (:class:`_Grid`, :class:`SingleGrid`, :class:`MultiGrid`,
7+
:class:`HexGrid`, etc.) are now in maintenance-only mode. While these classes remain
8+
fully supported, new development occurs in the experimental cell space module
9+
(:mod:`mesa.experimental.cell_space`).
10+
11+
The :class:`PropertyLayer` and :class:`ContinuousSpace` classes remain fully supported
12+
and actively developed.
13+
14+
Classes
15+
-------
16+
* PropertyLayer: A data layer that can be added to Grids to store cell properties
17+
* SingleGrid: a Grid which strictly enforces one agent per cell.
18+
* MultiGrid: a Grid where each cell can contain a set of agents.
19+
* HexGrid: a Grid to handle hexagonal neighbors.
920
* ContinuousSpace: a two-dimensional space where each agent has an arbitrary position of `float`'s.
1021
* NetworkGrid: a network where each node contains zero or more agents.
1122
"""

0 commit comments

Comments
 (0)