Fix PropertyLayer visualization tutorial to use new SpaceRenderer setup API by ShreyasN707 · Pull Request #3223 · mesa/mesa

ShreyasN707 · 2026-01-29T13:00:29Z

This updates the Property Layer Visualization tutorial to use setup_structure, setup_agents, and setup_propertylayer instead of deprecated render(...) arguments, fixing the Binder crash reported in #3216.

issue : #3216

ShreyasN707 · 2026-01-31T14:02:40Z

@EwoutH I have updated the documentation.

quaquel · 2026-02-04T19:08:16Z

docs/tutorials/7_visualization_propertylayer_visualization.ipynb

    "if mesa.__version__.startswith((\"3.0\", \"3.1\", \"3.2\")):\n",
    "    print(\n",
-    "        f\"⚠️  Mesa {mesa.__version__} detected. Visualization features require Mesa 3.3+\"\n",
+    "        f\"\u26a0\ufe0f  Mesa {mesa.__version__} detected. Visualization features require Mesa 3.3+\"\n",


what's going on here? and in other places with weird unicode related stuff?

Both lines render the same warning symbol (⚠️); one uses the literal character and the other a Unicode escape, which is redundant. I’ll clean this up and standardize the warning text.

For me instead of the word "warning", I'd prefer this symbol as it's easy to see.

ok @Sahil-Chhoker .

Sahil-Chhoker · 2026-02-10T03:44:51Z

I'd like the above block to be:

renderer = (
    SpaceRenderer(model, backend="matplotlib")
    .setup_structure(
        lw=2, ls="solid", color="black", alpha=0.1
    )
    .setup_agents(agent_portrayal)
    .setup_propertylayer(propertylayer_portrayal)
)

# Comment/uncomment the line below to toggle gridlines
renderer.draw_structure()

# Comment/uncomment the line below to toggle agents
renderer.draw_agents()

# Comment/uncomment the line below to toggle propertylayer
renderer.draw_propertylayer()

And the bottom block to be:

renderer = (
    SpaceRenderer(model, backend="matplotlib")
    .setup_structure(
        lw=2, ls="solid", color="black", alpha=0.1
    )
    .setup_agents(agent_portrayal)
    .setup_propertylayer(propertylayer_portrayal)
)
renderer.render()

And please verify the syntax before putting it up.

ShreyasN707 · 2026-02-12T17:39:21Z

I'd like the above block to be:

renderer = (
    SpaceRenderer(model, backend="matplotlib")
    .setup_structure(
        lw=2, ls="solid", color="black", alpha=0.1
    )
    .setup_agents(agent_portrayal)
    .setup_propertylayer(propertylayer_portrayal)
)

# Comment/uncomment the line below to toggle gridlines
renderer.draw_structure()

# Comment/uncomment the line below to toggle agents
renderer.draw_agents()

# Comment/uncomment the line below to toggle propertylayer
renderer.draw_propertylayer()

And the bottom block to be:

renderer = (
    SpaceRenderer(model, backend="matplotlib")
    .setup_structure(
        lw=2, ls="solid", color="black", alpha=0.1
    )
    .setup_agents(agent_portrayal)
    .setup_propertylayer(propertylayer_portrayal)
)
renderer.render()

And please verify the syntax before putting it up.

Sure will do it! sorry for late reply was busy with academics.

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

Sahil-Chhoker · 2026-02-13T07:58:57Z

Remove these artifacts, I think %capture% would do the trick.

Also final page is not available, why's that happening?

ShreyasN707 · 2026-02-13T14:38:49Z

I believe the Page not available issue is due to leftover notebook output during the docs build. I’ll suppress the render output using %capture and clear the notebook outputs so the final page renders correctly.

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

Sahil-Chhoker · 2026-02-14T03:47:02Z

The changes of this PR are good, but there seems to be some problem with solara app rendering on readthedocs, it may be an dependency issue as it's in every tutorial visualization.

Failed to load model class 'HtmlModel' from module 'jupyter-vuetify'
Error: Script error for "jupyter-vue", needed by: jupyter-vuetify
http://requirejs.org/docs/errors.html#scripterror
    at makeError (https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js:1:1067)
    at HTMLScriptElement.onScriptError (https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js:1:13218)

@EwoutH do you have any idea what might be causing this? Because upon searching I could only find this old issue which may not be entirely relevant: voila-dashboards/voila#619

ShreyasN707 · 2026-02-14T04:40:24Z

The changes of this PR are good, but there seems to be some problem with solara app rendering on readthedocs, it may be an dependency issue as it's in every tutorial visualization.
Failed to load model class 'HtmlModel' from module 'jupyter-vuetify'
Error: Script error for "jupyter-vue", needed by: jupyter-vuetify
http://requirejs.org/docs/errors.html#scripterror
    at makeError (https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js:1:1067)
    at HTMLScriptElement.onScriptError (https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js:1:13218)
@EwoutH do you have any idea what might be causing this? Because upon searching I could only find this old issue which may not be entirely relevant: voila-dashboards/voila#619

Even I faced the same. This seems to be related to the Jupyter widget environment (likely ipywidgets / jupyter-vuetify) i.e:

Failed to load model class 'HtmlModel' from module 'jupyter-vuetify'
Script error for "jupyter-vue"

quaquel · 2026-02-23T07:52:18Z

Can you take a look at the conflict and update this PR accordingly.

ShreyasN707 · 2026-02-25T05:07:24Z

yes will do it

quaquel · 2026-03-09T16:13:44Z

Closing this as stale

ShreyasN707 and others added 2 commits January 29, 2026 18:27

Fix PropertyLayer visualization tutorial

4b52c6c

Merge branch 'main' into property_layer_documentation

eb0c329

falloficarus22 mentioned this pull request Jan 30, 2026

Tracking Issue: Update SpaceRenderer API in All Tutorials #3228

Closed

4 tasks

Merge branch 'main' into property_layer_documentation

dd0eb1e

quaquel added the docs Release notes label label Feb 1, 2026

Merge branch 'main' into property_layer_documentation

1ad8110

quaquel reviewed Feb 4, 2026

View reviewed changes

ShreyasN707 and others added 3 commits February 5, 2026 16:04

Merge branch 'main' into property_layer_documentation

aebd1f0

Clean up redundant unicode warning in docs

62dabf9

Merge branch 'main' into property_layer_documentation

00dec46

EwoutH requested a review from Sahil-Chhoker February 6, 2026 15:26

Merge branch 'main' into property_layer_documentation

bb0e465

This was referenced Feb 9, 2026

fix: handle deprecated space_kwargs gracefully in SpaceRenderer.rende… #3269

Merged

Property Layer Visualization Example AttributeError: 'space_kwargs' #3216

Closed

Merge branch 'main' into property_layer_documentation

93e0317

Merge branch 'main' into property_layer_documentation

8ba6186

ShreyasN707 and others added 3 commits February 12, 2026 23:38

Update PropertyLayer tutorial examples to match SpaceRenderer usage

d33c83b

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

ab72205

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

Use warning symbol instead of text in PropertyLayer tutorial

fda9421

ShreyasN707 and others added 6 commits February 13, 2026 20:08

Merge branch 'main' into property_layer_documentation

d263f61

Clean notebook outputs and suppress rendering artifacts

2662a21

Suppress visualization artifacts and clean notebook outputs

7ae1a5f

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

5017818

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

Suppress visualization artifacts and clean notebook outputs

91e8b5d

Merge branch 'main' into property_layer_documentation

e9fda16

quaquel closed this Mar 9, 2026

Uh oh!

Conversation

ShreyasN707 commented Jan 29, 2026

Uh oh!

ShreyasN707 commented Jan 31, 2026

Uh oh!

quaquel Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

ShreyasN707 Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

Sahil-Chhoker Feb 7, 2026

Choose a reason for hiding this comment

Uh oh!

ShreyasN707 Feb 12, 2026

Choose a reason for hiding this comment

Uh oh!

Sahil-Chhoker commented Feb 10, 2026

Uh oh!

ShreyasN707 commented Feb 12, 2026

Uh oh!

Sahil-Chhoker commented Feb 13, 2026

Uh oh!

ShreyasN707 commented Feb 13, 2026

Uh oh!

Sahil-Chhoker commented Feb 14, 2026

Uh oh!

ShreyasN707 commented Feb 14, 2026

Uh oh!

quaquel commented Feb 23, 2026

Uh oh!

ShreyasN707 commented Feb 25, 2026

Uh oh!

quaquel commented Mar 9, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants