Skip to content

Commit

Permalink
space: Add note that Grids are maintenance only (#2420)
Browse files Browse the repository at this point in the history
* 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).
  • Loading branch information
EwoutH authored Oct 25, 2024
1 parent 24fdc16 commit 4215706
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions mesa/space.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,21 @@
Objects used to add a spatial component to a model.
* Grid: base grid, which creates a rectangular grid.
* SingleGrid: extension to Grid which strictly enforces one agent per cell.
* MultiGrid: extension to Grid where each cell can contain a set of agents.
* HexGrid: extension to Grid to handle hexagonal neighbors.
.. note::
All Grid classes (:class:`_Grid`, :class:`SingleGrid`, :class:`MultiGrid`,
:class:`HexGrid`, etc.) are now in maintenance-only mode. While these classes remain
fully supported, new development occurs in the experimental cell space module
(:mod:`mesa.experimental.cell_space`).
The :class:`PropertyLayer` and :class:`ContinuousSpace` classes remain fully supported
and actively developed.
Classes
-------
* PropertyLayer: A data layer that can be added to Grids to store cell properties
* SingleGrid: a Grid which strictly enforces one agent per cell.
* MultiGrid: a Grid where each cell can contain a set of agents.
* HexGrid: a Grid to handle hexagonal neighbors.
* ContinuousSpace: a two-dimensional space where each agent has an arbitrary position of `float`'s.
* NetworkGrid: a network where each node contains zero or more agents.
"""
Expand Down

0 comments on commit 4215706

Please sign in to comment.