Update mesa-geo to sync with mesa >=2.3.0

.gitignore

@@ -268,7 +268,7 @@ target/
 
 # Jupyter Notebook
 .ipynb_checkpoints
-.virtual_documents
+*.virtual_documents
 
 # pyenv
 .python-version

mesa_geo/__init__.py

@@ -6,7 +6,6 @@
 
 import datetime
 
-from mesa_geo import visualization
 from mesa_geo.geoagent import AgentCreator, GeoAgent
 from mesa_geo.geospace import GeoSpace
 from mesa_geo.raster_layers import Cell, ImageLayer, RasterLayer

mesa_geo/geoagent.py

@@ -12,7 +12,7 @@
 import geopandas as gpd
 import numpy as np
 import pyproj
-from mesa import Agent
+from mesa import Agent, Model
 from shapely.geometry import mapping
 from shapely.geometry.base import BaseGeometry
 from shapely.ops import transform
@@ -153,6 +153,9 @@
                 f"Unable to set CRS for {self.agent_class.__name__} due to empty CRS in {self.__class__.__name__}"
             )
 
+        if not isinstance(self.model, Model):
+            raise ValueError("Model must be a valid Mesa model object")
+
         new_agent = self.agent_class(
             unique_id=unique_id,
             model=self.model,

mesa_geo/raster_layers.py

@@ -164,7 +164,7 @@ class Cell(Agent):
     pos: Coordinate | None
     indices: Coordinate | None
 
-    def __init__(self, pos=None, indices=None):
+    def __init__(self, model, pos=None, indices=None):
         """
         Initialize a cell.
 
@@ -174,7 +174,7 @@ def __init__(self, pos=None, indices=None):
             Origin is at upper left corner of the grid
         """
 
-        super().__init__(uuid.uuid4().int, None)
+        super().__init__(uuid.uuid4().int, model)
         self.pos = pos
         self.indices = indices
 
@@ -218,15 +218,18 @@ class RasterLayer(RasterBase):
     _neighborhood_cache: dict[Any, list[Coordinate]]
     _attributes: set[str]
 
-    def __init__(self, width, height, crs, total_bounds, cell_cls: type[Cell] = Cell):
+    def __init__(
+        self, width, height, crs, total_bounds, model, cell_cls: type[Cell] = Cell
+    ):
         super().__init__(width, height, crs, total_bounds)
+        self.model = model
         self.cell_cls = cell_cls
         self.cells = []
         for x in range(self.width):
             col: list[cell_cls] = []
             for y in range(self.height):
                 row_idx, col_idx = self.height - y - 1, x
-                col.append(self.cell_cls(pos=(x, y), indices=(row_idx, col_idx)))
+                col.append(self.cell_cls(model, pos=(x, y), indices=(row_idx, col_idx)))
             self.cells.append(col)
 
         self._attributes = set()

mesa_geo/tile_layers.py

@@ -27,7 +27,7 @@ class RasterWebTile:
     kind: str = "raster_web_tile"
 
     @classmethod
-    def from_xyzservices(cls, provider: xyzservices.TileProvider) -> RasterWebTile:
+    def from_xyzservices(cls, provider=xyzservices.TileProvider) -> RasterWebTile:
         """
         Create a RasterWebTile from an xyzservices TileProvider.
 

mesa_geo/visualization/__init__.py

@@ -1 +1,5 @@
-from mesa_geo.visualization.modules import *  # noqa
+# Import specific classes or functions from the modules
+from mesa_geo.visualization.geojupyter_viz import GeoJupyterViz
+from mesa_geo.visualization.leaflet_viz import LeafletViz
+
+__all__ = ["GeoJupyterViz", "LeafletViz"]

mesa_geo/visualization/geojupyter_viz.py

@@ -0,0 +1,211 @@
+import sys
+
+import matplotlib.pyplot as plt
+import mesa.experimental.components.matplotlib as components_matplotlib
+import solara
+import xyzservices.providers as xyz
+from mesa.experimental import jupyter_viz as jv
+from solara.alias import rv
+
+import mesa_geo.visualization.leaflet_viz as leaflet_viz
+
+# Avoid interactive backend
+plt.switch_backend("agg")
+
+
+# TODO: Turn this function into a Solara component once the current_step.value
+# dependency is passed to measure()
+"""
+Geo-Mesa Visualization Module
+=============================
+Card: Helper Function that initiates the Solara Card for Browser
+GeoJupyterViz: Main Function users employ to create visualization
+"""
+
+
+def Card(
+    model,
+    measures,
+    agent_portrayal,
+    map_drawer,
+    center_default,
+    zoom,
+    current_step,
+    color,
+    layout_type,
+):
+    with rv.Card(
+        style_=f"background-color: {color}; width: 100%; height: 100%"
+    ) as main:
+        if "Map" in layout_type:
+            rv.CardTitle(children=["Map"])
+            leaflet_viz.map(model, map_drawer, zoom, center_default)
+
+        if "Measure" in layout_type:
+            rv.CardTitle(children=["Measure"])
+            measure = measures[layout_type["Measure"]]
+            if callable(measure):
+                # Is a custom object
+                measure(model)
+            else:
+                components_matplotlib.PlotMatplotlib(
+                    model, measure, dependencies=[current_step.value]
+                )
+    return main
+
+
+@solara.component
+def GeoJupyterViz(
+    model_class,
+    model_params,
+    measures=None,
+    name=None,
+    agent_portrayal=None,
+    play_interval=150,
+    # parameters for leaflet_viz
+    view=None,
+    zoom=None,
+    tiles=xyz.OpenStreetMap.Mapnik,
+    center_point=None,  # Due to projection challenges in calculation allow user to specify center point
+):
+    """Initialize a component to visualize a model.
+    Args:
+        model_class: class of the model to instantiate
+        model_params: parameters for initializing the model
+        measures: list of callables or data attributes to plot
+        name: name for display
+        agent_portrayal: options for rendering agents (dictionary)
+        space_drawer: method to render the agent space for
+            the model; default implementation is the `SpaceMatplotlib` component;
+            simulations with no space to visualize should
+            specify `space_drawer=False`
+        play_interval: play interval (default: 150)
+        center_point: list of center coords
+    """
+    if name is None:
+        name = model_class.__name__
+
+    current_step = solara.use_reactive(0)
+
+    # 1. Set up model parameters
+    user_params, fixed_params = jv.split_model_params(model_params)
+    model_parameters, set_model_parameters = solara.use_state(
+        {**fixed_params, **{k: v.get("value") for k, v in user_params.items()}}
+    )
+
+    # 2. Set up Model
+    def make_model():
+        model = model_class(**model_parameters)
+        current_step.value = 0
+        return model
+
+    reset_counter = solara.use_reactive(0)
+    model = solara.use_memo(
+        make_model, dependencies=[*list(model_parameters.values()), reset_counter.value]
+    )
+
+    def handle_change_model_params(name: str, value: any):
+        set_model_parameters({**model_parameters, name: value})
+
+    # 3. Set up UI
+    with solara.AppBar():
+        solara.AppBarTitle(name)
+
+    # 4. Set Up Map
+    # render layout, pass through map build parameters
+    map_drawer = leaflet_viz.MapModule(
+        portrayal_method=agent_portrayal,
+        view=view,
+        zoom=zoom,
+        tiles=tiles,
+    )
+    layers = map_drawer.render(model)
+
+    # determine center point
+    if center_point:
+        center_default = center_point
+    else:
+        bounds = layers["layers"]["total_bounds"]
+        center_default = list((bounds[2:] + bounds[:2]) / 2)
+
+    def render_in_jupyter():
+        # TODO: Build API to allow users to set rows and columns
+        # call in property of model layers geospace line; use 1 column to prevent map overlap
+
+        with solara.Row(
+            justify="space-between", style={"flex-grow": "1"}
+        ) and solara.GridFixed(columns=2):
+            jv.UserInputs(user_params, on_change=handle_change_model_params)
+            jv.ModelController(model, play_interval, current_step, reset_counter)
+            solara.Markdown(md_text=f"###Step - {current_step}")
+
+        # Builds Solara component of map
+        leaflet_viz.map_jupyter(model, map_drawer, zoom, center_default)
+
+        # Place measurement in separate row
+        with solara.Row(
+            justify="space-between",
+            style={"flex-grow": "1"},
+        ):
+            # 5. Plots
+            for measure in measures:
+                if callable(measure):
+                    # Is a custom object
+                    measure(model)
+                else:
+                    components_matplotlib.PlotMatplotlib(
+                        model, measure, dependencies=[current_step.value]
+                    )
+
+    def render_in_browser():
+        # determine center point
+        if center_point:
+            center_default = center_point
+        else:
+            bounds = layers["layers"]["total_bounds"]
+            center_default = list((bounds[2:] + bounds[:2]) / 2)
+
+        # if space drawer is disabled, do not include it
+        layout_types = [{"Map": "default"}]
+
+        if measures:
+            layout_types += [{"Measure": elem} for elem in range(len(measures))]
+
+        grid_layout_initial = jv.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):
+                jv.UserInputs(user_params, on_change=handle_change_model_params)
+                jv.ModelController(model, play_interval, current_step, reset_counter)
+            with solara.Card("Progress", margin=1, elevation=2):
+                solara.Markdown(md_text=f"####Step - {current_step}")
+
+        items = [
+            Card(
+                model,
+                measures,
+                agent_portrayal,
+                map_drawer,
+                center_default,
+                zoom,
+                current_step,
+                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()