Mesa 3.0.0a0__tar.gz → 3.0.0a1__tar.gz

{mesa-3.0.0a0 → mesa-3.0.0a1}/.gitignore

@@ -15,6 +15,8 @@ __pycache__/
 .Python
 env/
 venv/
+pythonenv*/
+.venv/
 build/
 develop-eggs/
 dist/
@@ -83,10 +85,6 @@ target/
 .dmypy.json
 dmypy.json
 
-# pythonenv
-pythonenv*/
-
 # JS dependencies
 mesa/visualization/templates/external/
 mesa/visualization/templates/js/external/
-

{mesa-3.0.0a0 → mesa-3.0.0a1}/.readthedocs.yml

@@ -13,9 +13,9 @@ formats:
   - pdf
 
 build:
-  os: "ubuntu-22.04"
+  os: ubuntu-lts-latest
   tools:
-    python: "3"
+    python: latest
 
 # Optionally set the version of Python and requirements required to build your docs
 python:

{mesa-3.0.0a0 → mesa-3.0.0a1}/HISTORY.md

@@ -1,6 +1,27 @@
 ---
 title: Release History
 ---
+# 3.0.0a1 (2024-08-01)
+## Highlights
+Mesa 3.0 alpha 1 (`v3.0.0a1`) is another step towards our next major version. This release introduces a name change from JupyterViz (jupyter_viz) to SolaraViz (solara_viz), to better represent the tech stack being used. It also includes two bugfixes also present in 2.3.2.
+
+## What's Changed
+### ⚠️ Breaking changes
+* viz: Combine code for rendering in browser and Jupyter by @rht in https://github.com/projectmesa/mesa/pull/2180
+### 🛠 Enhancements made
+* Rename JupyterViz to SolaraViz by @rht in https://github.com/projectmesa/mesa/pull/2187
+* refactor: Rename jupyter_viz namespace to solara_viz by @rht in https://github.com/projectmesa/mesa/pull/2188
+### 🐛 Bugs fixed
+* fix: Render agent marker radius correctly by @rht in https://github.com/projectmesa/mesa/pull/2181
+* fix: Use model.schedule.steps -> mode._steps for batch_run by @rht in https://github.com/projectmesa/mesa/pull/2183
+### 📜 Documentation improvements
+* Add original conference paper link to docs by @ENUMERA8OR in https://github.com/projectmesa/mesa/pull/2160
+
+## New Contributors
+* @ENUMERA8OR made their first contribution in https://github.com/projectmesa/mesa/pull/2160
+
+**Full Changelog**: https://github.com/projectmesa/mesa/compare/v3.0.0a0...v3.0.0a1
+
 # 3.0.0a0 (2024-07-04)
 ## Highlights
 This is the first pre-release in the Mesa 3.0 series, which is still in active development. The `v3.0.0a0` pre-release can help active Mesa developers help starting to test the latest features in their models.
@@ -38,6 +59,17 @@ This pre-release can be installed with `pip install mesa --upgrade --pre`.
 
 **Full Changelog**: https://github.com/projectmesa/mesa/compare/v2.3.1...v3.0.0a0
 
+# 2.3.2 (2024-07-22)
+## Highlights
+Mesa 2.3.2 is a small patch release which fixes two bugs, one to the batch_run function still depending on `schedule.steps`, and one in the agent marker visualisation.
+
+## What's Changed
+### 🐛 Bugs fixed
+* fix: Render agent marker radius correctly by @rht in https://github.com/projectmesa/mesa/pull/2181
+* fix: Use model.schedule.steps -> mode._steps for batch_run by @rht in https://github.com/projectmesa/mesa/pull/2183
+
+**Full Changelog**: https://github.com/projectmesa/mesa/compare/v2.3.1...v2.3.2
+
 # 2.3.1 (2024-07-03)
 ## Highlights
 Mesa 2.3.1 is a small patch release with a datacollector bug fixed and improved documentation.

{mesa-3.0.0a0 → mesa-3.0.0a1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: Mesa
-Version: 3.0.0a0
+Version: 3.0.0a1
 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.0a0 → mesa-3.0.0a1}/docs/apis/visualization.md

@@ -5,7 +5,7 @@ For a detailed tutorial, please refer to our [Visualization Tutorial](../tutoria
 ## Jupyter Visualization
 
 ```{eval-rst}
-.. automodule:: mesa.visualization.jupyter_viz
+.. automodule:: mesa.visualization.solara_viz
    :members:
    :undoc-members:
    :show-inheritance:

{mesa-3.0.0a0 → mesa-3.0.0a1}/docs/index.md

@@ -18,6 +18,8 @@
 
 [Mesa] is an Apache2 licensed agent-based modeling (or ABM) framework in Python.
 
+The original conference paper is [available here](http://conference.scipy.org.s3-website-us-east-1.amazonaws.com/proceedings/scipy2015/jacqueline_kazil.html).
+
 Mesa allows users to quickly create agent-based models using built-in core components (such as spatial grids and agent schedulers) or customized implementations; visualize them using a browser-based interface; and analyze their results using Python's data analysis tools. Its goal is to be the Python-based counterpart to NetLogo, Repast, or MASON.
 
 

{mesa-3.0.0a0 → mesa-3.0.0a1}/docs/tutorials/visualization_tutorial.ipynb

@@ -119,9 +119,9 @@
    },
    "outputs": [],
    "source": [
-    "from mesa.visualization import JupyterViz\n",
+    "from mesa.visualization import SolaraViz\n",
     "\n",
-    "page = JupyterViz(\n",
+    "page = SolaraViz(\n",
     "    BoltzmannWealthModel,\n",
     "    model_params,\n",
     "    measures=[\"Gini\"],\n",
@@ -164,7 +164,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "page = JupyterViz(\n",
+    "page = SolaraViz(\n",
     "    BoltzmannWealthModel,\n",
     "    model_params,\n",
     "    measures=[\"Gini\"],\n",
@@ -223,7 +223,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "page = JupyterViz(\n",
+    "page = SolaraViz(\n",
     "    BoltzmannWealthModel,\n",
     "    model_params,\n",
     "    measures=[\"Gini\", make_histogram],\n",

{mesa-3.0.0a0 → mesa-3.0.0a1}/mesa/__init__.py

@@ -24,7 +24,7 @@ __all__ = [
 ]
 
 __title__ = "mesa"
-__version__ = "3.0.0a0"
+__version__ = "3.0.0a1"
 __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.0a0 → mesa-3.0.0a1}/mesa/batchrunner.py

@@ -132,14 +132,14 @@ def _model_run_func(
     """
     run_id, iteration, kwargs = run
     model = model_cls(**kwargs)
-    while model.running and model.schedule.steps <= max_steps:
+    while model.running and model._steps <= max_steps:
         model.step()
 
     data = []
 
-    steps = list(range(0, model.schedule.steps, data_collection_period))
-    if not steps or steps[-1] != model.schedule.steps - 1:
-        steps.append(model.schedule.steps - 1)
+    steps = list(range(0, model._steps, data_collection_period))
+    if not steps or steps[-1] != model._steps - 1:
+        steps.append(model._steps - 1)
 
     for step in steps:
         model_data, all_agents_data = _collect_data(model, step)

{mesa-3.0.0a0 → mesa-3.0.0a1}/mesa/cookiecutter-mesa/{{cookiecutter.snake}}/app.pytemplate

@@ -1,7 +1,7 @@
 """
 Configure visualization elements and instantiate a server
 """
-from mesa.visualization import JupyterViz
+from mesa.visualization import SolaraViz
 
 from {{ cookiecutter.snake }}.model import {{ cookiecutter.model }}, {{ cookiecutter.agent }}  # noqa
 
@@ -18,7 +18,7 @@ def circle_portrayal_example(agent):
 
 model_params = {"num_agents": 10, "width": 10, "height": 10}
 
-page = JupyterViz(
+page = SolaraViz(
     {{cookiecutter.model}},
     model_params,
     measures=["num_agents"],

mesa-3.0.0a1/mesa/visualization/__init__.py

@@ -0,0 +1,3 @@
+from .solara_viz import JupyterViz, Slider, SolaraViz, make_text
+
+__all__ = ["JupyterViz", "make_text", "Slider", "SolaraViz"]

{mesa-3.0.0a0 → mesa-3.0.0a1}/mesa/visualization/components/matplotlib.py

@@ -48,7 +48,7 @@ def _draw_grid(space, space_ax, agent_portrayal):
         out = {"x": x, "y": y}
         # This is the default value for the marker size, which auto-scales
         # according to the grid area.
-        out["s"] = (180 / min(g.width, g.height)) ** 2
+        out["s"] = (180 / max(g.width, g.height)) ** 2
         if len(s) > 0:
             out["s"] = s
         if len(c) > 0:

mesa-3.0.0a0/mesa/visualization/jupyter_viz.py → mesa-3.0.0a1/mesa/visualization/solara_viz.py

@@ -5,7 +5,7 @@ This module provides components to create browser- and Jupyter notebook-based vi
 Mesa models, allowing users to watch models run step-by-step and interact with model parameters.
 
 Key features:
-    - JupyterViz: Main component for creating visualizations, supporting grid displays and plots
+    - SolaraViz: Main component for creating visualizations, supporting grid displays and plots
     - ModelController: Handles model execution controls (step, play, pause, reset)
     - UserInputs: Generates UI elements for adjusting model parameters
     - Card: Renders individual visualization elements (space, measures)
@@ -17,13 +17,12 @@ custom visualization components.
 Usage:
     1. Define an agent_portrayal function to specify how agents should be displayed
     2. Set up model_params to define adjustable parameters
-    3. Create a JupyterViz instance with your model, parameters, and desired measures
+    3. Create a SolaraViz instance with your model, parameters, and desired measures
     4. Display the visualization in a Jupyter notebook or run as a Solara app
 
 See the Visualization Tutorial and example models for more details.
 """
 
-import sys
 import threading
 
 import reacton.ipywidgets as widgets
@@ -86,7 +85,7 @@ def Card(
 
 
 @solara.component
-def JupyterViz(
+def SolaraViz(
     model_class,
     model_params,
     measures=None,
@@ -158,92 +157,52 @@ def JupyterViz(
         """Update the random seed for the model."""
         reactive_seed.value = model.random.random()
 
-    # jupyter
     dependencies = [current_step.value, reactive_seed.value]
 
-    def render_in_jupyter():
-        """Render the visualization components in Jupyter notebook."""
-        with solara.GridFixed(columns=2):
-            UserInputs(user_params, on_change=handle_change_model_params)
-            ModelController(model, play_interval, current_step, reset_counter)
-            solara.Markdown(md_text=f"###Step - {current_step}")
+    # if space drawer is disabled, do not include it
+    layout_types = [{"Space": "default"}] if space_drawer else []
 
-        with solara.GridFixed(columns=2):
-            # 4. Space
-            if space_drawer == "default":
-                # draw with the default implementation
-                components_matplotlib.SpaceMatplotlib(
-                    model, agent_portrayal, dependencies=dependencies
-                )
-            elif space_drawer == "altair":
-                components_altair.SpaceAltair(
-                    model, agent_portrayal, dependencies=dependencies
-                )
-            elif space_drawer:
-                # if specified, draw agent space with an alternate renderer
-                space_drawer(model, agent_portrayal)
-            # otherwise, do nothing (do not draw space)
-
-            # 5. Plots
-            if measures:
-                for measure in measures:
-                    if callable(measure):
-                        # Is a custom object
-                        measure(model)
-                    else:
-                        components_matplotlib.PlotMatplotlib(
-                            model, measure, dependencies=dependencies
-                        )
-
-    def render_in_browser():
-        """Render the visualization components in a web browser."""
-        # if space drawer is disabled, do not include it
-        layout_types = [{"Space": "default"}] if space_drawer else []
-
-        if measures:
-            layout_types += [{"Measure": elem} for elem in range(len(measures))]
-
-        grid_layout_initial = make_initial_grid_layout(layout_types=layout_types)
-        grid_layout, set_grid_layout = solara.use_state(grid_layout_initial)
-
-        with solara.Sidebar():
-            with solara.Card("Controls", margin=1, elevation=2):
-                solara.InputText(
-                    label="Seed",
-                    value=reactive_seed,
-                    continuous_update=True,
-                )
-                UserInputs(user_params, on_change=handle_change_model_params)
-                ModelController(model, play_interval, current_step, reset_counter)
-                solara.Button(label="Reseed", color="primary", on_click=do_reseed)
-            with solara.Card("Information", margin=1, elevation=2):
-                solara.Markdown(md_text=f"Step - {current_step}")
-
-        items = [
-            Card(
-                model,
-                measures,
-                agent_portrayal,
-                space_drawer,
-                dependencies,
-                color="white",
-                layout_type=layout_types[i],
+    if measures:
+        layout_types += [{"Measure": elem} for elem in range(len(measures))]
+
+    grid_layout_initial = make_initial_grid_layout(layout_types=layout_types)
+    grid_layout, set_grid_layout = solara.use_state(grid_layout_initial)
+
+    with solara.Sidebar():
+        with solara.Card("Controls", margin=1, elevation=2):
+            solara.InputText(
+                label="Seed",
+                value=reactive_seed,
+                continuous_update=True,
             )
-            for i in range(len(layout_types))
-        ]
-        solara.GridDraggable(
-            items=items,
-            grid_layout=grid_layout,
-            resizable=True,
-            draggable=True,
-            on_grid_layout=set_grid_layout,
+            UserInputs(user_params, on_change=handle_change_model_params)
+            ModelController(model, play_interval, current_step, reset_counter)
+            solara.Button(label="Reseed", color="primary", on_click=do_reseed)
+        with solara.Card("Information", margin=1, elevation=2):
+            solara.Markdown(md_text=f"Step - {current_step}")
+
+    items = [
+        Card(
+            model,
+            measures,
+            agent_portrayal,
+            space_drawer,
+            dependencies,
+            color="white",
+            layout_type=layout_types[i],
         )
+        for i in range(len(layout_types))
+    ]
+    solara.GridDraggable(
+        items=items,
+        grid_layout=grid_layout,
+        resizable=True,
+        draggable=True,
+        on_grid_layout=set_grid_layout,
+    )
+
 
-    if ("ipykernel" in sys.argv[0]) or ("colab_kernel_launcher.py" in sys.argv[0]):
-        # When in Jupyter or Google Colab
-        render_in_jupyter()
-    else:
-        render_in_browser()
+JupyterViz = SolaraViz
 
 
 @solara.component

mesa-3.0.0a0/tests/test_jupyter_viz.py → mesa-3.0.0a1/tests/test_solara_viz.py

@@ -5,7 +5,7 @@ import ipyvuetify as vw
 import solara
 
 import mesa
-from mesa.visualization.jupyter_viz import JupyterViz, Slider, UserInputs
+from mesa.visualization.solara_viz import Slider, SolaraViz, UserInputs
 
 
 class TestMakeUserInput(unittest.TestCase):
@@ -101,7 +101,7 @@ def test_call_space_drawer(mocker):
     # initialize with space drawer unspecified (use default)
     # component must be rendered for code to run
     solara.render(
-        JupyterViz(
+        SolaraViz(
             model_class=mesa.Model,
             model_params={},
             agent_portrayal=agent_portrayal,
@@ -116,7 +116,7 @@ def test_call_space_drawer(mocker):
     for falsy_value in [None, False, 0]:
         mock_space_matplotlib.reset_mock()
         solara.render(
-            JupyterViz(
+            SolaraViz(
                 model_class=mesa.Model,
                 model_params={},
                 agent_portrayal=agent_portrayal,
@@ -129,7 +129,7 @@ def test_call_space_drawer(mocker):
     # specify a custom space method
     altspace_drawer = Mock()
     solara.render(
-        JupyterViz(
+        SolaraViz(
             model_class=mesa.Model,
             model_params={},
             agent_portrayal=agent_portrayal,

mesa-3.0.0a0/mesa/visualization/__init__.py

@@ -1,3 +0,0 @@
-from .jupyter_viz import JupyterViz, Slider, make_text
-
-__all__ = ["JupyterViz", "make_text", "Slider"]