Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

space: Add note that Grids are maintenance only #2420

Merged
merged 2 commits into from
Oct 25, 2024
Merged

space: Add note that Grids are maintenance only #2420

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b01cbb0
space: Add note that Grids are maintenance only
EwoutH Oct 25, 2024
1c76862
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Oct 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 15 additions & 4 deletions mesa/space.py
View file
Open in desktop
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
Loading