Models not loading correctly after updating Mesa Geo Package

[sknill-tm]

Hello, I have recently update the mesa-geo package to the latest version (believe I was going from 1.2 to 4.0) and this has thrown up a few errors with my existing code. I have made the relevant changes so the code should be operational with 4.0 but for some reason the server loads but it has not been populated. See below:

In an attempt to get the code working again, I have created a separate environment to host a previous state of the mesa geo packages so that I could run my legacy code. I am able to get the server to load and the relevant agents to populate, however the model will not actually run or step.

Appreciate the support.

[rht]

Any error messages from the browser console or the Python server itself?

[wang-boyu]

TypeError: _recreate_rtree() missing 1 required positional argument: 'new_agents'

This is weird because new_agents is optional and defaults to None:

mesa-geo/mesa_geo/geospace.py

Line 166 in 99eeec3

def _recreate_rtree(self, new_agents=None):

Could you please share your Python version and how Mesa-Geo was installed? If possible, could you have a separate, clean virtual environment and re-install Mesa-Geo from scratch?

And yes a minimal reproducer of the model would be great.

By the way, in v0.3.0 there are two breaking changes:

• rename model.grid to model.space remove __geo_interface__ functions #40
• rename GeoAgent's shape attribute to geometry rename GeoAgent's shape attribute to geometry #57

Not sure whether this will help or not.

[sknill-tm]

Thanks, creating a new virtual env with Python 3.9 and Mesa-Geo 0.4 appears to have gotten the model working again (agents populate and model runs as expected). However, the agent attributes are not displaying anymore (see screenshot below) is this to do with another revision in the code?

Noted re the breaking points - these have all been updated in the code.

Thanks again for all the help!

[wang-boyu]

Excellent!

To display agent attributes, you will need to specify them in the portrayal_method function, with a description key in the returned dictionary.

For example to show agent's unique_id attribute:

def schelling_draw(agent):
    """
    Portrayal Method for canvas
    """
    portrayal = dict()
    portrayal["description"] = agent.unique_id  # <------- add this for display
    if agent.atype is None:
        portrayal["color"] = "Grey"
    elif agent.atype == 0:
        portrayal["color"] = "Red"
    else:
        portrayal["color"] = "Blue"
    return 

It is documented here:

mesa-geo/mesa_geo/visualization/modules/MapVisualization.py

Lines 37 to 40 in 99eeec3

	For a GeoAgent, the portrayal method should return a dictionary.
	For a Line or a Polygon, the available options can be found at: https://leafletjs.com/reference.html#path-option
	For a Point, the available options can be found at: https://leafletjs.com/reference.html#circlemarker-option
	In addition, the portrayal dictionary can contain a "description" key, which will be used as the popup text.

Let me know whether this works for you.

[sknill-tm]

Thanks for sharing.

I have tried to pull through the ID and agent type, but it looks like only the second call (agent type) is pulling through. They also seem to pull through in a vertical fashion (see below)

[wang-boyu]

Sorry I might have made a mistake in previous comments. Could you try to define the description field itself as a dictionary?

For example:

def schelling_draw(agent):
    """
    Portrayal Method for canvas
    """
    portrayal = dict()
    
    # add this for display
    portrayal["description"] = {
        "id": agent.unique_id,
        "other_property": agent.other_property,
    }

    if agent.atype is None:
        portrayal["color"] = "Grey"
    elif agent.atype == 0:
        portrayal["color"] = "Red"
    else:
        portrayal["color"] = "Blue"
    return