Mesa 3.0.1__tar.gz → 3.0.3__tar.gz

{mesa-3.0.1 → mesa-3.0.3}/HISTORY.md

@@ -1,6 +1,24 @@
 ---
 title: Release History
 ---
+# 3.0.2 (2024-11-11)
+## Highlighst
+Mesa 3.0.2 is a small follow-up patch release, in which we fixed a lot of small bugs in the example models their visualisation, and improved their testing.
+
+## What's Changed
+### 🐛 Bugs fixed
+* allow components as a positional argument again by @Corvince in https://github.com/projectmesa/mesa/pull/2488
+### 🔍 Examples updated
+* examples: Add required components keyword by @EwoutH in https://github.com/projectmesa/mesa/pull/2485
+* examples: Fix boid_flockers viz by @EwoutH in https://github.com/projectmesa/mesa/pull/2492
+* examples: Fix schelling viz by @EwoutH in https://github.com/projectmesa/mesa/pull/2490
+* example: Add input sliders to Sugerscape viz by @EwoutH in https://github.com/projectmesa/mesa/pull/2487
+* examples/gol: Add initial fraction alive, add sliders to viz by @EwoutH in https://github.com/projectmesa/mesa/pull/2489
+### 🔧 Maintenance
+* test app init of examples by @Corvince in https://github.com/projectmesa/mesa/pull/2491
+
+**Full Changelog**: https://github.com/projectmesa/mesa/compare/v3.0.1...v3.0.2
+
 # 3.0.1 (2024-11-11)
 ## Highlights
 After our huge [3.0.0 release](https://github.com/projectmesa/mesa/releases/tag/v3.0.0), Mesa 3.0.1 follows up with two improvements to experimental features, examples and docs.

{mesa-3.0.1 → mesa-3.0.3}/PKG-INFO

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

{mesa-3.0.1 → mesa-3.0.3}/mesa/__init__.py

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

{mesa-3.0.1 → mesa-3.0.3}/mesa/examples/advanced/epstein_civil_violence/Readme.md

@@ -8,14 +8,12 @@ The model generates mass uprising as self-reinforcing processes: if enough agent
 
 ## How to Run
 
-To run the model interactively, run ``EpsteinCivilViolenceServer.py`` in this directory. e.g.
+To run the model interactively, in this directory, run the following command
 
 ```
-    $ python EpsteinCivilViolenceServer.py
+    $ solara run app.py
 ```
 
-Then open your browser to [http://127.0.0.1:8521/](http://127.0.0.1:8521/) and press Reset, then Run.
-
 ## Files
 
 * ``model.py``: Core model code.

{mesa-3.0.1 → mesa-3.0.3}/mesa/examples/advanced/sugarscape_g1mt/app.py

@@ -4,7 +4,7 @@ from matplotlib.figure import Figure
 
 from mesa.examples.advanced.sugarscape_g1mt.agents import Trader
 from mesa.examples.advanced.sugarscape_g1mt.model import SugarscapeG1mt
-from mesa.visualization import SolaraViz, make_plot_component
+from mesa.visualization import Slider, SolaraViz, make_plot_component
 
 
 def SpaceDrawer(model):
@@ -49,13 +49,29 @@ def SpaceDrawer(model):
 model_params = {
     "width": 50,
     "height": 50,
+    # Population parameters
+    "initial_population": Slider(
+        "Initial Population", value=200, min=50, max=500, step=10
+    ),
+    # Agent endowment parameters
+    "endowment_min": Slider("Min Initial Endowment", value=25, min=5, max=30, step=1),
+    "endowment_max": Slider("Max Initial Endowment", value=50, min=30, max=100, step=1),
+    # Metabolism parameters
+    "metabolism_min": Slider("Min Metabolism", value=1, min=1, max=3, step=1),
+    "metabolism_max": Slider("Max Metabolism", value=5, min=3, max=8, step=1),
+    # Vision parameters
+    "vision_min": Slider("Min Vision", value=1, min=1, max=3, step=1),
+    "vision_max": Slider("Max Vision", value=5, min=3, max=8, step=1),
+    # Trade parameter
+    "enable_trade": {"type": "Checkbox", "value": True, "label": "Enable Trading"},
 }
 
-model1 = SugarscapeG1mt(50, 50)
+model1 = SugarscapeG1mt()
 
 page = SolaraViz(
     model1,
     components=[SpaceDrawer, make_plot_component(["Trader", "Price"])],
+    model_params=model_params,
     name="Sugarscape {G1, M, T}",
     play_interval=150,
 )

{mesa-3.0.1 → mesa-3.0.3}/mesa/examples/advanced/wolf_sheep/app.py

@@ -83,7 +83,7 @@ lineplot_component = make_plot_component(
 )
 
 simulator = ABMSimulator()
-model = WolfSheep(simulator, grass=True)
+model = WolfSheep(simulator=simulator, grass=True)
 
 page = SolaraViz(
     model,

{mesa-3.0.1 → mesa-3.0.3}/mesa/examples/basic/boid_flockers/agents.py

@@ -54,13 +54,14 @@ class Boid(Agent):
         self.cohere_factor = cohere
         self.separate_factor = separate
         self.match_factor = match
+        self.neighbors = []
 
     def step(self):
         """Get the Boid's neighbors, compute the new vector, and move accordingly."""
-        neighbors = self.model.space.get_neighbors(self.pos, self.vision, False)
+        self.neighbors = self.model.space.get_neighbors(self.pos, self.vision, False)
 
         # If no neighbors, maintain current direction
-        if not neighbors:
+        if not self.neighbors:
             new_pos = self.pos + self.direction * self.speed
             self.model.space.move_agent(self, new_pos)
             return
@@ -71,7 +72,7 @@ class Boid(Agent):
         separation_vector = np.zeros(2)  # Separation vector
 
         # Calculate the contribution of each neighbor to the three behaviors
-        for neighbor in neighbors:
+        for neighbor in self.neighbors:
             heading = self.model.space.get_heading(self.pos, neighbor.pos)
             distance = self.model.space.get_distance(self.pos, neighbor.pos)
 
@@ -86,7 +87,7 @@ class Boid(Agent):
             match_vector += neighbor.direction
 
         # Weight each behavior by its factor and normalize by number of neighbors
-        n = len(neighbors)
+        n = len(self.neighbors)
         cohere = cohere * self.cohere_factor
         separation_vector = separation_vector * self.separate_factor
         match_vector = match_vector * self.match_factor

{mesa-3.0.1 → mesa-3.0.3}/mesa/examples/basic/boid_flockers/app.py

@@ -3,10 +3,7 @@ from mesa.visualization import Slider, SolaraViz, make_space_component
 
 
 def boid_draw(agent):
-    if not agent.neighbors:  # Only for the first Frame
-        neighbors = len(agent.model.space.get_neighbors(agent.pos, agent.vision, False))
-    else:
-        neighbors = len(agent.neighbors)
+    neighbors = len(agent.neighbors)
 
     if neighbors <= 1:
         return {"color": "red", "size": 20}
@@ -51,7 +48,7 @@ model = BoidFlockers()
 
 page = SolaraViz(
     model,
-    [make_space_component(agent_portrayal=boid_draw, backend="matplotlib")],
+    components=[make_space_component(agent_portrayal=boid_draw, backend="matplotlib")],
     model_params=model_params,
     name="Boid Flocking Model",
 )

{mesa-3.0.1 → mesa-3.0.3}/mesa/examples/basic/conways_game_of_life/app.py

@@ -20,12 +20,34 @@ def post_process(ax):
 
 
 model_params = {
-    "width": 50,
-    "height": 50,
+    "width": {
+        "type": "SliderInt",
+        "value": 50,
+        "label": "Width",
+        "min": 5,
+        "max": 60,
+        "step": 1,
+    },
+    "height": {
+        "type": "SliderInt",
+        "value": 50,
+        "label": "Height",
+        "min": 5,
+        "max": 60,
+        "step": 1,
+    },
+    "initial_fraction_alive": {
+        "type": "SliderFloat",
+        "value": 0.2,
+        "label": "Cells initially alive",
+        "min": 0,
+        "max": 1,
+        "step": 0.01,
+    },
 }
 
 # Create initial model instance
-model1 = ConwaysGameOfLife(50, 50)
+model1 = ConwaysGameOfLife()
 
 # Create visualization elements. The visualization elements are solara components
 # that receive the model instance as a "prop" and display it in a certain way.

{mesa-3.0.1 → mesa-3.0.3}/mesa/examples/basic/conways_game_of_life/model.py

@@ -6,7 +6,7 @@ from mesa.space import SingleGrid
 class ConwaysGameOfLife(Model):
     """Represents the 2-dimensional array of cells in Conway's Game of Life."""
 
-    def __init__(self, width=50, height=50, seed=None):
+    def __init__(self, width=50, height=50, initial_fraction_alive=0.2, seed=None):
         """Create a new playing area of (width, height) cells."""
         super().__init__(seed=seed)
         # Use a simple grid, where edges wrap around.
@@ -16,7 +16,7 @@ class ConwaysGameOfLife(Model):
         # ALIVE and some to DEAD.
         for _contents, (x, y) in self.grid.coord_iter():
             cell = Cell((x, y), self)
-            if self.random.random() < 0.1:
+            if self.random.random() < initial_fraction_alive:
                 cell.state = cell.ALIVE
             self.grid.place_agent(cell, (x, y))
 

{mesa-3.0.1 → mesa-3.0.3}/mesa/examples/basic/schelling/app.py

@@ -26,7 +26,7 @@ model_params = {
     "height": 20,
 }
 
-model1 = Schelling(20, 20, 0.8, 0.2, 3)
+model1 = Schelling()
 
 HappyPlot = make_plot_component({"happy": "tab:green"})
 

{mesa-3.0.1 → mesa-3.0.3}/mesa/examples/basic/virus_on_network/Readme.md

@@ -24,23 +24,12 @@ To install the dependencies use pip and the requirements.txt in this directory.
 
 ## How to Run
 
-To run the model interactively, run ``mesa runserver`` in this directory. e.g.
+To run the model interactively, in this directory, run the following command
 
 ```
-    $ mesa runserver
+    $ solara run app.py
 ```
 
-Then open your browser to [http://127.0.0.1:8521/](http://127.0.0.1:8521/) and press Reset, then Run.
-
-or
-
-Directly run the file ``run.py`` in the terminal. e.g.
-
-```
-    $ python run.py
-```
-
-
 ## Files
 
 * ``model.py``: Contains the agent class, and the overall model class.

{mesa-3.0.1 → mesa-3.0.3}/mesa/examples/basic/virus_on_network/app.py

@@ -103,7 +103,7 @@ model1 = VirusOnNetwork()
 
 page = SolaraViz(
     model1,
-    [
+    components=[
         SpacePlot,
         StatePlot,
         get_resistant_susceptible_ratio,

{mesa-3.0.1 → mesa-3.0.3}/mesa/experimental/cell_space/cell_collection.py

@@ -48,8 +48,10 @@ class CellCollection(Generic[T]):
         else:
             self._cells = {cell: cell.agents for cell in cells}
 
-        #
-        self._capacity: int = next(iter(self._cells.keys())).capacity
+        # Get capacity from first cell if collection is not empty
+        self._capacity: int | None = (
+            next(iter(self._cells.keys())).capacity if self._cells else None
+        )
 
         if random is None:
             warnings.warn(

{mesa-3.0.1 → mesa-3.0.3}/mesa/visualization/solara_viz.py

@@ -43,10 +43,10 @@ if TYPE_CHECKING:
 @solara.component
 def SolaraViz(
     model: Model | solara.Reactive[Model],
-    *,
     components: list[reacton.core.Component]
     | list[Callable[[Model], reacton.core.Component]]
     | Literal["default"] = "default",
+    *,
     play_interval: int = 100,
     simulator: Simulator | None = None,
     model_params=None,
@@ -276,7 +276,7 @@ def SimulatorController(
         running.value = True
         simulator.reset()
         model.value = model.value = model.value.__class__(
-            simulator, **model_parameters.value
+            simulator=simulator, **model_parameters.value
         )
 
     def do_play_pause():
@@ -382,11 +382,17 @@ def ModelCreator(
     )
     user_params, fixed_params = split_model_params(user_params)
 
-    # set model_parameters to the default values for all parameters
-    model_parameters.value = {
-        **fixed_params,
-        **{k: v.get("value") for k, v in user_params.items()},
-    }
+    # Use solara.use_effect to run the initialization code only once
+    solara.use_effect(
+        # set model_parameters to the default values for all parameters
+        lambda: model_parameters.set(
+            {
+                **fixed_params,
+                **{k: v.get("value") for k, v in user_params.items()},
+            }
+        ),
+        [],
+    )
 
     def on_change(name, value):
         model_parameters.value = {**model_parameters.value, name: value}

{mesa-3.0.1 → mesa-3.0.3}/tests/test_cell_space.py

@@ -583,6 +583,40 @@ def test_cell_collection():
     assert len(cells) == len(collection)
 
 
+def test_empty_cell_collection():
+    """Test that CellCollection properly handles empty collections."""
+    rng = random.Random(42)
+
+    # Test initializing with empty collection
+    collection = CellCollection([], random=rng)
+    assert len(collection) == 0
+    assert collection._capacity is None
+    assert list(collection.cells) == []
+    assert list(collection.agents) == []
+
+    # Test selecting from empty collection
+    selected = collection.select(lambda cell: True)
+    assert len(selected) == 0
+    assert selected._capacity is None
+
+    # Test filtering to empty collection
+    n = 10
+    full_collection = CellCollection(
+        [Cell((i,), random=rng) for i in range(n)], random=rng
+    )
+    assert len(full_collection) == n
+
+    # Filter to empty collection
+    empty_result = full_collection.select(lambda cell: False)
+    assert len(empty_result) == 0
+    assert empty_result._capacity is None
+
+    # Test at_most with empty collection
+    at_most_result = full_collection.select(lambda cell: False, at_most=5)
+    assert len(at_most_result) == 0
+    assert at_most_result._capacity is None
+
+
 ### PropertyLayer tests
 def test_property_layer_integration():
     """Test integration of PropertyLayer with DiscrateSpace and Cell."""

{mesa-3.0.1 → mesa-3.0.3}/tests/test_examples.py

@@ -13,6 +13,10 @@ from mesa.examples import (
 
 
 def test_boltzmann_model():  # noqa: D103
+    from mesa.examples.basic.boltzmann_wealth_model import app
+
+    app.page  # noqa: B018
+
     model = BoltzmannWealth(seed=42)
 
     for _i in range(10):
@@ -20,24 +24,40 @@ def test_boltzmann_model():  # noqa: D103
 
 
 def test_conways_game_model():  # noqa: D103
+    from mesa.examples.basic.conways_game_of_life import app
+
+    app.page  # noqa: B018
+
     model = ConwaysGameOfLife(seed=42)
     for _i in range(10):
         model.step()
 
 
 def test_schelling_model():  # noqa: D103
+    from mesa.examples.basic.schelling import app
+
+    app.page  # noqa: B018
+
     model = Schelling(seed=42)
     for _i in range(10):
         model.step()
 
 
 def test_virus_on_network():  # noqa: D103
+    from mesa.examples.basic.virus_on_network import app
+
+    app.page  # noqa: B018
+
     model = VirusOnNetwork(seed=42)
     for _i in range(10):
         model.step()
 
 
 def test_boid_flockers():  # noqa: D103
+    from mesa.examples.basic.boid_flockers import app
+
+    app.page  # noqa: B018
+
     model = BoidFlockers(seed=42)
 
     for _i in range(10):
@@ -45,6 +65,10 @@ def test_boid_flockers():  # noqa: D103
 
 
 def test_epstein():  # noqa: D103
+    from mesa.examples.advanced.epstein_civil_violence import app
+
+    app.page  # noqa: B018
+
     model = EpsteinCivilViolence(seed=42)
 
     for _i in range(10):
@@ -52,6 +76,10 @@ def test_epstein():  # noqa: D103
 
 
 def test_pd_grid():  # noqa: D103
+    from mesa.examples.advanced.pd_grid import app
+
+    app.page  # noqa: B018
+
     model = PdGrid(seed=42)
 
     for _i in range(10):
@@ -59,6 +87,10 @@ def test_pd_grid():  # noqa: D103
 
 
 def test_sugarscape_g1mt():  # noqa: D103
+    from mesa.examples.advanced.sugarscape_g1mt import app
+
+    app.page  # noqa: B018
+
     model = SugarscapeG1mt(seed=42)
 
     for _i in range(10):
@@ -66,8 +98,11 @@ def test_sugarscape_g1mt():  # noqa: D103
 
 
 def test_wolf_sheep():  # noqa: D103
+    from mesa.examples.advanced.wolf_sheep import app
     from mesa.experimental.devs import ABMSimulator
 
+    app.page  # noqa: B018
+
     simulator = ABMSimulator()
     WolfSheep(seed=42, simulator=simulator)
     simulator.run_for(10)