Mesa 2.3.0rc1__tar.gz → 2.3.1__tar.gz

{mesa-2.3.0rc1 → mesa-2.3.1}/.github/workflows/build_lint.yml

@@ -10,6 +10,9 @@ on:
   pull_request:
     paths-ignore:
       - '**.md'
+  workflow_dispatch:
+  schedule:
+    - cron: '0 6 * * 1'
 
 # This will cancel previous run if a newer job that obsoletes the said previous
 # run, is started.

{mesa-2.3.0rc1 → mesa-2.3.1}/.github/workflows/release.yml

@@ -14,6 +14,8 @@ on:
       - '**.md'
       - '**.rst'
   workflow_dispatch:
+  schedule:
+    - cron: '0 6 * * 1'
 
 permissions:
   id-token: write

{mesa-2.3.0rc1 → mesa-2.3.1}/HISTORY.md

@@ -1,9 +1,21 @@
 ---
 title: Release History
 ---
-# 2.3.0-rc1 (2024-04-18)
+# 2.3.1 (2024-07-03)
+## Highlights
+Mesa 2.3.1 is a small patch release with a datacollector bug fixed and improved documentation.
+
+## What's Changed
+### 🐛 Bugs fixed
+* datacollector: store separate snapshots of model data per step by @EwoutH in https://github.com/projectmesa/mesa/pull/2129
+### 📜 Documentation improvements
+* Add experimental features to documentation as per #2122 by @stephenfmann in https://github.com/projectmesa/mesa/pull/2154
+
+**Full Changelog**: https://github.com/projectmesa/mesa/compare/v2.3.0...v2.3.1
+
+# 2.3.0 (2024-04-23)
 ## Highlights
-The 2.3.0-rc1 release is our first release candidate pre-release, meant to test all the new features and enhancement for the upcoming 2.3.0 release.
+Mesa 2.3.0 is a big feature release and the last feature release before 3.0.
 
 There are two main new features:
 - The experimental cell-centric discrete spaces, as added in #1994. It allows having cells with not only properties but also active behaviors: the `CellAgent`. Its inspired by NetLogo's [patches](https://ccl.northwestern.edu/netlogo/bind/primitive/patches.html) but extend and generalize this concept further.
@@ -13,11 +25,11 @@ There are a lot of other features: The Jupyter visualisation now supports easier
 
 Finally, 2.3.0 stabilizes the `AgentSet` (including `model.agents`), making it the first experimental Mesa feature that is taken out of it's experimental phase.
 
-Install this pre-release with:
+Install this release with:
 ```
-pip install --pre mesa
+pip install --upgrade mesa
 ```
-We would love feedback before we release 2.3.0 stable in ~1 week.
+The Mesa 2.3.x-series supports Python 3.9 to 3.12. The next major release will require Python 3.10.
 
 ## What's Changed
 ### 🧪 Experimental features
@@ -34,7 +46,7 @@ We would love feedback before we release 2.3.0 stable in ~1 week.
 * feat: Let mesa runserver detect server.py as fallback by @rht in https://github.com/projectmesa/mesa/pull/2015
 * JupyterViz: {Convert make_plot & prepare ColorCard} to become Solara component by @rht in https://github.com/projectmesa/mesa/pull/2020
 * new feature: AgentSet.get can retrieve one or more then one attribute by @quaquel in https://github.com/projectmesa/mesa/pull/2044
-* Update CODE_OF_CONDUCT.md to version 2+ of contrib convenant by @jackiekazil in https://github.com/projectmesa/mesa/pull/2052
+* Update CODE_OF_CONDUCT.md to version 2+ of contrib covenant by @jackiekazil in https://github.com/projectmesa/mesa/pull/2052
 * Improve flocking benchmark  by @coderbeta1 in https://github.com/projectmesa/mesa/pull/2054
 * Remove JupyterViz Altair marker overlap for huge grid size by @rht in https://github.com/projectmesa/mesa/pull/2062
 * Add tooltip option to Altair chart by @FoFFolo in https://github.com/projectmesa/mesa/pull/2082
@@ -87,7 +99,10 @@ We would love feedback before we release 2.3.0 stable in ~1 week.
 * @FoFFolo made their first contribution in https://github.com/projectmesa/mesa/pull/2082
 * @puer-robustus made their first contribution in https://github.com/projectmesa/mesa/pull/2083
 
-**Full Changelog**: https://github.com/projectmesa/mesa/compare/v2.2.4...2.3.0-rc1
+**Full Changelog**: https://github.com/projectmesa/mesa/compare/v2.2.4...2.3.0
+
+# 2.3.0-rc1 (2024-04-18)
+Mesa 2.3.0-rc1 is pre-release in preparation for 2.3.0 stable. It had the same release notes as 2.3.0.
 
 # 2.2.4 (2024-01-26)
 ## Highlights

{mesa-2.3.0rc1 → mesa-2.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: Mesa
-Version: 2.3.0rc1
+Version: 2.3.1
 Summary: Agent-based modeling (ABM) in Python
 Project-URL: homepage, https://github.com/projectmesa/mesa
 Project-URL: repository, https://github.com/projectmesa/mesa

{mesa-2.3.0rc1 → mesa-2.3.1}/docs/apis/api_main.md

@@ -9,4 +9,5 @@ space
 datacollection
 batchrunner
 visualization
+experimental
 ```

mesa-2.3.1/docs/apis/experimental.md

@@ -0,0 +1,60 @@
+# Experimental
+
+```{eval-rst}
+.. automodule:: experimental.__init__
+   :members:
+```
+
+## Cell Space
+
+```{eval-rst}
+.. automodule:: experimental.cell_space.__init__
+   :members:
+```
+
+```{eval-rst}
+.. automodule:: experimental.cell_space.cell
+   :members:
+```
+
+```{eval-rst}
+.. automodule:: experimental.cell_space.cell_agent
+   :members:
+```
+
+```{eval-rst}
+.. automodule:: experimental.cell_space.cell_collection
+   :members:
+```
+
+```{eval-rst}
+.. automodule:: experimental.cell_space.discrete_space
+   :members:
+```
+
+```{eval-rst}
+.. automodule:: experimental.cell_space.grid
+   :members:
+```
+
+```{eval-rst}
+.. automodule:: experimental.cell_space.network
+   :members:
+```
+
+## Devs
+
+```{eval-rst}
+.. automodule:: experimental.devs.__init__
+   :members:
+```
+
+```{eval-rst}
+.. automodule:: experimental.devs.eventlist
+   :members:
+```
+
+```{eval-rst}
+.. automodule:: experimental.devs.simulator
+   :members:
+```

{mesa-2.3.0rc1 → mesa-2.3.1}/mesa/__init__.py

@@ -26,7 +26,7 @@ __all__ = [
 ]
 
 __title__ = "mesa"
-__version__ = "2.3.0-rc1"
+__version__ = "2.3.1"
 __license__ = "Apache 2.0"
 _this_year = datetime.datetime.now(tz=datetime.timezone.utc).date().year
 __copyright__ = f"Copyright {_this_year} Project Mesa Team"

{mesa-2.3.0rc1 → mesa-2.3.1}/mesa/datacollection.py

@@ -36,6 +36,7 @@ The default DataCollector here makes several assumptions:
 import contextlib
 import itertools
 import types
+from copy import deepcopy
 from functools import partial
 
 with contextlib.suppress(ImportError):
@@ -197,17 +198,21 @@ class DataCollector:
             for var, reporter in self.model_reporters.items():
                 # Check if lambda or partial function
                 if isinstance(reporter, (types.LambdaType, partial)):
-                    self.model_vars[var].append(reporter(model))
+                    # Use deepcopy to store a copy of the data,
+                    # preventing references from being updated across steps.
+                    self.model_vars[var].append(deepcopy(reporter(model)))
                 # Check if model attribute
                 elif isinstance(reporter, str):
-                    self.model_vars[var].append(getattr(model, reporter, None))
+                    self.model_vars[var].append(
+                        deepcopy(getattr(model, reporter, None))
+                    )
                 # Check if function with arguments
                 elif isinstance(reporter, list):
-                    self.model_vars[var].append(reporter[0](*reporter[1]))
-                # TODO: Check if method of a class, as of now it is assumed
-                # implicitly if the other checks fail.
+                    self.model_vars[var].append(deepcopy(reporter[0](*reporter[1])))
+                # Assume it's a callable otherwise (e.g., method)
+                # TODO: Check if method of a class explicitly
                 else:
-                    self.model_vars[var].append(reporter())
+                    self.model_vars[var].append(deepcopy(reporter()))
 
         if self.agent_reporters:
             agent_records = self._record_agents(model)

{mesa-2.3.0rc1 → mesa-2.3.1}/mesa/space.py

@@ -461,6 +461,7 @@ class _Grid:
                 # Find the closest position without sorting all positions
                 closest_pos = None
                 min_distance = float("inf")
+                agent.random.shuffle(pos)
                 for p in pos:
                     distance = self._distance_squared(p, current_pos)
                     if distance < min_distance: