Adds Altair plot component and some other fixes #2644

nissu99 · 2025-01-26T06:35:31Z

- rename make_space_altair to something like make_altair_space_component
- add make_altair_plot_component
- Add support for all spaces. This means including the hexgrid and network transformation of the x and y coordinates.
- Have a generic get_agent_data method

@quaquel @EwoutH I’ve added a new component, make_altair_plot_component. Could you kindly check if it aligns well with the project?

P.S working on space support.

for more information, see https://pre-commit.ci

github-actions · 2025-01-26T06:43:06Z

Performance benchmarks:

Model	Size	Init time [95% CI]	Run time [95% CI]
BoltzmannWealth	small	🔵 +1.3% [+0.4%, +2.2%]	🔵 -0.3% [-0.5%, -0.2%]
BoltzmannWealth	large	🔵 -1.2% [-1.8%, -0.6%]	🔵 -0.5% [-1.6%, +0.7%]
Schelling	small	🔵 -0.7% [-1.0%, -0.5%]	🔵 +0.8% [+0.6%, +0.9%]
Schelling	large	🔵 -0.7% [-1.1%, -0.3%]	🔵 -0.9% [-1.3%, -0.5%]
WolfSheep	small	🔵 +0.1% [-0.1%, +0.3%]	🔵 +1.1% [+0.9%, +1.2%]
WolfSheep	large	🔵 +0.9% [+0.3%, +1.5%]	🔵 +1.9% [+1.2%, +2.5%]
BoidFlockers	small	🔵 -0.7% [-1.3%, -0.2%]	🔵 +1.8% [+1.6%, +2.0%]
BoidFlockers	large	🔵 -0.1% [-0.5%, +0.4%]	🔵 +1.9% [+1.6%, +2.3%]

EwoutH · 2025-01-26T10:42:39Z

Thanks for the PR! A few of the automated checks broke, could you look into what caused that?

I will leave the review to others.

tpike3 · 2025-01-26T13:17:47Z

@nissu99 also please look at #2643 and #2641 As you are @sanika-n are working in the same space

As it looks like you two are looking over the entire altair implementation I would also recommend looking at #2642 discussion

It is always good to collaborate and think together you may address some larger visualization challenges.

"alt defined"

for more information, see https://pre-commit.ci

nissu99 · 2025-01-27T08:04:19Z

@tpike3 When I run the tests locally, they don't fail, but they are failing here.

tpike3 · 2025-01-27T11:02:15Z

@tpike3 When I run the tests locally, they don't fail, but they are failing here.

I am not sure why your tests are passing locally, however for tests to pass they need to updated. It is expecting None and now getting Chart, because you added post process.

__ ERROR collecting tests/test_components_matplotlib.py _____________
tests/test_components_matplotlib.py:[20](https://github.com/projectmesa/mesa/actions/runs/12984364297/job/36207123671?pr=2644#step:6:21): in <module>
    from mesa.visualization.mpl_space_drawing import (
mesa/visualization/__init__.py:13: in <module>
    from .components import make_plot_component, make_space_component
mesa/visualization/components/__init__.py:7: in <module>
    from .altair_components import (
mesa/visualization/components/altair_components.py:93: in <module>
    post_process: Callable[[alt.Chart], alt.Chart] | None = None,
E   AttributeError: 'NoneType' object has no attribute 'Chart'

"removed a line"

"updated toml"

"removed suppress"

for more information, see https://pre-commit.ci

"doc string "

for more information, see https://pre-commit.ci

"operator bug"

nissu99 · 2025-01-27T18:41:24Z

@tpike3 When I run the tests locally, they don't fail, but they are failing here.

I am not sure why your tests are passing locally, however for tests to pass they need to updated. It is expecting None and now getting Chart, because you added post process.

__ ERROR collecting tests/test_components_matplotlib.py _____________
tests/test_components_matplotlib.py:[20](https://github.com/projectmesa/mesa/actions/runs/12984364297/job/36207123671?pr=2644#step:6:21): in <module>
    from mesa.visualization.mpl_space_drawing import (
mesa/visualization/__init__.py:13: in <module>
    from .components import make_plot_component, make_space_component
mesa/visualization/components/__init__.py:7: in <module>
    from .altair_components import (
mesa/visualization/components/altair_components.py:93: in <module>
    post_process: Callable[[alt.Chart], alt.Chart] | None = None,
E   AttributeError: 'NoneType' object has no attribute 'Chart'

Thank You, the issue got resolved by adding altair to the toml file.

nissu99 · 2025-01-30T18:40:03Z

@quaquel @tpike3 i was making a generic get_agent_data function ,should i remove all the old functions like _get_agent_data_new_discrete_space or keeping them will be right?

quaquel · 2025-01-30T19:20:59Z

Removing stuff that has become redundant is fine.

nissu99 · 2025-01-31T10:54:47Z

@quaquel i have added all the stuff,can you review it?

quaquel · 2025-01-31T11:14:23Z

I'll try to review it over the weekend, but I am rather bussy at the moment. This is a part of the code base I am not intimately familiar with and his been a while since I used Altair, so reviewing will take more time than parts of the code base I know inside out.

Sahil-Chhoker

I have done the review of basic rectangular and hex grids, first I would love to get them finished up. Then I also noticed that the implementation of the new Network is also missing. I will do a review again once you make the changes, please take a look at the review and don't hesitate to ask for implementations as well if unable to get them.

Sahil-Chhoker · 2025-02-18T14:02:35Z

mesa/visualization/components/altair_components.py

+def _draw_discrete_grid(space, all_agent_data, agent_portrayal):
+    """Create Altair visualization for Discrete Grid."""
    invalid_tooltips = ["color", "size", "x", "y"]
+    x_y_type = "ordinal"

-    x_y_type = "ordinal" if not isinstance(space, ContinuousSpace) else "nominal"
+    encoding_dict = {
+        "x": alt.X("x", axis=None, type=x_y_type),
+        "y": alt.Y("y", axis=None, type=x_y_type),
+        "tooltip": [
+            alt.Tooltip(key, type=alt.utils.infer_vegalite_type_for_pandas([value]))
+            for key, value in all_agent_data[0].items()
+            if key not in invalid_tooltips
+        ],
+    }
+
+    has_color = "color" in all_agent_data[0]
+    if has_color:
+        encoding_dict["color"] = alt.Color("color", type="nominal")
+    has_size = "size" in all_agent_data[0]
+    if has_size:
+        encoding_dict["size"] = alt.Size("size", type="quantitative")
+
+    chart = (
+        alt.Chart(
+            alt.Data(values=all_agent_data), encoding=alt.Encoding(**encoding_dict)
+        )
+        .mark_point(filled=True)
+        .properties(width=280, height=280)
+    )
+
+    if not has_size:
+        length = min(space.width, space.height)
+        chart = chart.mark_point(size=30000 / length**2, filled=True)
+
+    chart = chart.encode(
+        x=alt.X(
+            "x", axis=None, type=x_y_type, scale=alt.Scale(domain=(0, space.width - 1))
+        ),
+        y=alt.Y(
+            "y", axis=None, type=x_y_type, scale=alt.Scale(domain=(0, space.height - 1))
+        ),
+    )
+
+    return chart


I don't think this still works as expected, did you test this code using the example? For me it looks something like this even on placing 25 agents on 5x5 grid at every position:

Sahil-Chhoker · 2025-02-18T14:16:45Z

mesa/visualization/components/altair_components.py

        case Grid():
-            all_agent_data = _get_agent_data_new_discrete_space(space, agent_portrayal)
+            return _draw_discrete_grid(space, all_agent_data)
        case _Grid():
-            all_agent_data = _get_agent_data_old__discrete_space(space, agent_portrayal)
-        case ContinuousSpace():
-            all_agent_data = _get_agent_data_continuous_space(space, agent_portrayal)
+            return _draw_legacy_grid(space, all_agent_data)
+        case HexGrid():
+            return _draw_hex_grid(space, all_agent_data)


This order will never draw the HexGrid, because the hex grid inherits form the Grid. I think reversing their order will fix it.

Sahil-Chhoker · 2025-02-18T14:21:14Z

mesa/visualization/components/altair_components.py

+        case Grid():
+            # New DiscreteSpace or experimental cell space
+            for cell in space.all_cells:
+                for agent in cell.agents:
+                    data = agent_portrayal(agent)
+                    data.update({"x": cell.coordinate[0], "y": cell.coordinate[1]})
+                    all_agent_data.append(data)

-    Returns:
-        list of dicts
+        case _Grid():
+            # Legacy Grid
+            for content, (x, y) in space.coord_iter():
+                if not content:
+                    continue
+                agents = [content] if not hasattr(content, "__iter__") else content
+                for agent in agents:
+                    data = agent_portrayal(agent)
+                    data.update({"x": x, "y": y})
+                    all_agent_data.append(data)
+
+        case HexGrid():


Again this order won't work, because the HexGrid inherits from Grid.

Sahil-Chhoker · 2025-02-18T14:22:11Z

mesa/visualization/components/altair_components.py

+
+        case HexGrid():
+            # Hex-based grid
+            for content, (q, r) in space.coord_iter():


coord_iter doesn't exist for HexGrid

Sahil-Chhoker · 2025-02-18T14:26:54Z

mesa/visualization/components/altair_components.py

+def _draw_hex_grid(space, all_agent_data, agent_portrayal):
+    """Create Altair visualization for Hex Grid."""
+    invalid_tooltips = ["color", "size", "x", "y", "q", "r"]
+    x_y_type = "quantitative"
+


Hex grid does not look like this:

Review the implementation and visualization from what's done in the matplotlib part.

nissu99 · 2025-02-18T14:45:21Z

@Sahil-Chhoker Sorry for the inconvenience. I will test more carefully this time.

for more information, see https://pre-commit.ci

nissu99 · 2025-03-01T15:11:43Z

@Sahil-Chhoker i have made the changes .

Sahil-Chhoker · 2025-03-01T16:16:28Z

You've done a great job @nissu99 on the grids. It will take some time to test them all but I will do a review soon enough.

Sahil-Chhoker

I have done a basic review, the grid drawing can wait, let's go step by step.
Our first step here should be to finalize the agent data collecting logic, therefore why is the agent data collecting logic not made into a function like is done in matplotlib part?
Also does this implementation cover all the grids (again compare with this)

Sahil-Chhoker · 2025-03-02T03:48:27Z

mesa/visualization/components/altair_components.py

+with contextlib.suppress(ImportError):
+    import altair as alt


Don't suppress the import error here.

Sahil-Chhoker · 2025-03-02T03:49:17Z

mesa/visualization/components/altair_components.py

+import mesa.experimental
+from mesa.experimental.cell_space import HexGrid


change the experimental imports to mesa.discrete_space

Sahil-Chhoker · 2025-03-02T03:51:42Z

mesa/visualization/components/altair_components.py

+                         visualized.  The dictionary can contain the following keys:
+                           - "color":  A string representing the agent's color (e.g., "red", "#FF0000").
+                           - "size":   A number representing the agent's size.
+                           - "tooltip": A string to display as a tooltip when hovering over the agent.


Is this tooltip a new feature for altair? I don't think this is necessary for the moment.

Sahil-Chhoker · 2025-03-02T03:52:30Z

mesa/visualization/components/altair_components.py

    update_counter.get()
    space = getattr(model, "grid", None)
    if space is None:
-        # Sometimes the space is defined as model.space instead of model.grid


we should keep this comment.

Sahil-Chhoker · 2025-03-02T03:52:58Z

mesa/visualization/components/altair_components.py

        space = model.space

    chart = _draw_grid(space, agent_portrayal)
-    # Apply post-processing if provided


we should keep this comment as well

sure, will be more cautious while deleting comments.

nissu99 · 2025-03-02T06:22:33Z

I have done a basic review, the grid drawing can wait, let's go step by step. Our first step here should be to finalize the agent data collecting logic, therefore why is the agent data collecting logic not made into a function like is done in matplotlib part? Also does this implementation cover all the grids (again compare with this)

stuff like vernoi grid has not been added ,will have to look into it to properly add it.

Sahil-Chhoker · 2025-03-02T06:28:05Z

@nissu99 I can see why you got confused, I think he meant the generic function should be called in the respective draw functions and hence agnet_portrayal was passed to the draw functions. Again if you look at the matplotlib side you will get it. I think the exact same method can be used to get the data, can you try importing the method from the matplotlib side and using it to test if that works?

nissu99 · 2025-03-02T06:31:18Z

@nissu99 I can see why you got confused, I think he meant the generic function should be called in the respective draw functions and hence agnet_portrayal was passed to the draw functions. Again if you look at the matplotlib side you will get it. I think the exact same method can be used to get the data, can you try importing the method from the matplotlib side and using it to test if that works

I thought ,later he wants to make some universal function which can be reused.

Sahil-Chhoker · 2025-03-02T06:32:46Z

You don't have to worry about the new API, its still in discussion.

nissu99 · 2025-03-02T07:22:02Z

You don't have to worry about the new API, its still in discussion.

i tried using the collect_agent_data function it does not give the desired results.

Sahil-Chhoker · 2025-03-02T07:45:18Z

How did you test it, can you please elaborate how is it not working?

nissu99 · 2025-03-02T07:51:11Z

will ha

How did you test it, can you please elaborate how is it not working?

i used the internal examples ,somehow it shows no agent showing ,it is not able to extract the data ,will have to properly look into it to understand the issue well.

nissu99 · 2025-03-02T07:52:05Z

Sahil-Chhoker · 2025-03-02T08:11:04Z

That's because you are just getting the agent data, no plotting them on the grid. Maybe check if the data extraction is working or not don't not rely on this visualization.

nissu99 · 2025-03-08T12:13:40Z

@Sahil-Chhoker sorry for not getting back ,just got my college holidays started , i think the extraction is the fault here
when i printed the collect_agent_data returned values it was an empty array .

Sahil-Chhoker · 2025-03-08T14:16:07Z

Its working fine for me, can you test again. I don't think its a difficult task, you just replace the agent data collection logic with the collect_agent_data function call inside the grid draw logic.

nissu99 · 2025-03-08T17:25:41Z

Its working fine for me, can you test again. I don't think its a difficult task, you just replace the agent data collection logic with the collect_agent_data function call inside the grid draw logic.

i get that , it is not working for OrthogonalMooreGrid somehow,for others it works fine.

Sahil-Chhoker · 2025-03-09T05:23:56Z

It's working for OrthogonalMooreGrid as well. Please review your code carefully before commenting, as I may not have the capacity to review it multiple times.

nissu99 · 2025-03-09T12:06:55Z

It worked ,i made a dumb mistake ,should i make a commit for changing the extraction logic?

Sahil-Chhoker · 2025-03-09T13:28:58Z

Yeah, refactor the agent placement logic inline with the extraction logic.

for more information, see https://pre-commit.ci

Sahil-Chhoker · 2025-03-10T03:54:31Z

I encountered several issues while reviewing this PR. First, the previous review comments have not been addressed. Additionally, you're not using the new grids in mesa.discrete_space, among other issues.

Due to the excessive length of this PR, it's difficult for me to review it entirely. I strongly recommend breaking it down into smaller, atomic PRs that address specific issues.

A better approach could be:

Implement rectangular grids with agent placement logic.
Implement hex grids with agent placement logic.
Implement continuous space with agent placement logic.
Implement Voronoi grids with agent placement logic.
Implement network grids with agent placement logic.
Address any remaining grid implementations.
Add the plotting function.

This will make the review process smoother and ensure that changes are properly implemented step by step.

nissu99 and others added 3 commits January 26, 2025 11:22

renamed make_space_altair

566b72f

added make_altair_plot_component support

e1f947c

[pre-commit.ci] auto fixes from pre-commit.com hooks

9e3a625

for more information, see https://pre-commit.ci

nissu99 changed the title ~~ADDS ALTAIR PLOT COMPONENT AND SOME OTHER FIXES #2435~~ ADDS ALTAIR PLOT COMPONENT AND SOME OTHER FIXES Jan 26, 2025

EwoutH added the visualisation label Jan 26, 2025

EwoutH requested review from Corvince and quaquel January 26, 2025 10:41

tpike3 mentioned this pull request Jan 26, 2025

added property_layer with altair #2643

Open

nissu99 and others added 3 commits January 27, 2025 13:15

Update altair_components.py

a88d816

"alt defined"

[pre-commit.ci] auto fixes from pre-commit.com hooks

c579f81

for more information, see https://pre-commit.ci

Merge branch 'main' into main

489c0fd

nissu99 and others added 7 commits January 27, 2025 23:30

Update altair_components.py

95a607b

"removed a line"

Update pyproject.toml

8e1779b

"updated toml"

Update altair_components.py

2b69a62

"removed suppress"

[pre-commit.ci] auto fixes from pre-commit.com hooks

b5613f1

for more information, see https://pre-commit.ci

Update altair_components.py

0d1b8be

"doc string "

[pre-commit.ci] auto fixes from pre-commit.com hooks

ed8ca71

for more information, see https://pre-commit.ci

Update altair_components.py

da8fd53

"operator bug"

nissu99 and others added 2 commits January 31, 2025 11:49

Merge branch 'main' into main

24210f4

blank

4a38eef

Sahil-Chhoker reviewed Feb 18, 2025

View reviewed changes

nissu99 and others added 2 commits March 1, 2025 20:37

fixed altiar plotting

0631373

[pre-commit.ci] auto fixes from pre-commit.com hooks

22044f6

for more information, see https://pre-commit.ci

Sahil-Chhoker reviewed Mar 2, 2025

View reviewed changes

nissu99 mentioned this pull request Mar 9, 2025

Refactor altair in line with matplotlib #2435

Open

nissu99 and others added 6 commits March 10, 2025 02:36

extraction logic changes

0f6238c

extraction changes

c557595

small

ec7dc70

[pre-commit.ci] auto fixes from pre-commit.com hooks

348939a

for more information, see https://pre-commit.ci

docstring

b0192a6

Merge branch 'main' of https://github.com/nissu99/mesa

6d95380

		import mesa.experimental
		from mesa.experimental.cell_space import HexGrid

Adds Altair plot component and some other fixes #2644

Are you sure you want to change the base?

Adds Altair plot component and some other fixes #2644

Conversation

nissu99 commented Jan 26, 2025 • edited Loading

github-actions bot commented Jan 26, 2025

EwoutH commented Jan 26, 2025

tpike3 commented Jan 26, 2025 • edited Loading

nissu99 commented Jan 27, 2025 • edited Loading

tpike3 commented Jan 27, 2025

nissu99 commented Jan 27, 2025

nissu99 commented Jan 30, 2025 • edited Loading

quaquel commented Jan 30, 2025

nissu99 commented Jan 31, 2025

quaquel commented Jan 31, 2025

Sahil-Chhoker left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nissu99 commented Feb 18, 2025

nissu99 commented Mar 1, 2025

Sahil-Chhoker commented Mar 1, 2025

Sahil-Chhoker left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nissu99 commented Mar 2, 2025 • edited Loading

Sahil-Chhoker commented Mar 2, 2025

nissu99 commented Mar 2, 2025

Sahil-Chhoker commented Mar 2, 2025

nissu99 commented Mar 2, 2025

Sahil-Chhoker commented Mar 2, 2025

nissu99 commented Mar 2, 2025

nissu99 commented Mar 2, 2025

Sahil-Chhoker commented Mar 2, 2025 • edited Loading

nissu99 commented Mar 8, 2025

Sahil-Chhoker commented Mar 8, 2025

nissu99 commented Mar 8, 2025 • edited Loading

Sahil-Chhoker commented Mar 9, 2025

nissu99 commented Mar 9, 2025

Sahil-Chhoker commented Mar 9, 2025

Sahil-Chhoker commented Mar 10, 2025

nissu99 commented Jan 26, 2025 •

edited

Loading

tpike3 commented Jan 26, 2025 •

edited

Loading

nissu99 commented Jan 27, 2025 •

edited

Loading

nissu99 commented Jan 30, 2025 •

edited

Loading

Sahil-Chhoker left a comment •

edited

Loading

nissu99 commented Mar 2, 2025 •

edited

Loading

Sahil-Chhoker commented Mar 2, 2025 •

edited

Loading

nissu99 commented Mar 8, 2025 •

edited

Loading