Visualisation: Allow different shapes agent portrayals#2164

[Aryan1Mahahjan]

Hi, this is Draft Solution to #2164.

I was thinking about using the below, which use the Encode function attribute

The added code snippet checks for shape and fill keys in agent data. If present, it adds them to the encoding_dict using the corresponding keys shape and fill. This allows you to define visual properties like circle shapes and filled elements for agents in your visualization.

Draft: Addition of 2 keys in enconding_dict: shape(str) and fill(bool)

[github-actions]

Performance benchmarks:

Model	Size	Init time [95% CI]	Run time [95% CI]
Schelling	small	🔵 +0.9% [+0.6%, +1.2%]	🔵 +0.7% [+0.5%, +0.9%]
Schelling	large	🔵 +1.2% [+0.8%, +1.5%]	🔵 +0.6% [+0.2%, +1.1%]
WolfSheep	small	🔵 +0.5% [-0.7%, +1.8%]	🔵 +0.7% [+0.4%, +1.0%]
WolfSheep	large	🔵 +0.4% [+0.2%, +0.6%]	🔵 +0.3% [+0.2%, +0.5%]
BoidFlockers	small	🔵 +3.4% [+2.5%, +4.2%]	🔵 +3.6% [+3.0%, +4.4%]
BoidFlockers	large	🔴 +4.0% [+3.0%, +5.0%]	🔴 +3.9% [+3.4%, +4.4%]

[Aryan1Mahahjan]

Commit Issue with pytest:

I'm having trouble committing changes. When I try to commit, I see an error message related to pytest. Here's the output:

[EwoutH]

Thanks for the PR!

Weird, seems totally unrelated to these changes or our CI. How are you committing?

[rht]

Regarding with the typos, we need to add .venv to .gitignore, because it is a common name for a local virtualenv folder.
Regarding with the PR, it would be great to have a screenshot showcasing that it works in action, by modifying the Schelling_experimental example.

[Aryan1Mahahjan]

I reset my project to an earlier state using Git.

Now, I'm trying to re-install required dependencies like ruff and pytest, but I'm unable to activate the virtual environment (.venv). This prevents me from installing the packages currently.

[rht]

Now, I'm trying to re-install required dependencies like ruff and pytest, but I'm unable to activate the virtual environment (.venv). This prevents me from installing the packages currently.

Can you share the error messages?

[Aryan1Mahahjan]

I did not have this issue when installing the test last time.

[rht]

Your .venv is probably gone (the other possibility is that .venv exists but .venv/bin/activate is not executable, but doesn't have to be executable anyway). You likely have to recreate the virtualenv from scratch.

[EwoutH]

Maybe it's easiest to reinstall at this point.

[Aryan1Mahahjan]

So, Majority of the tests are passing.

There is a 1 failed test and 1 Error.

[EwoutH]

In CI all the tests are passing, so and the warnings are unrelated to this PR. So test-wise we’re good!

Could you update the title of the PR and add a screenshot of how it now looks to the first PR message?

[Aryan1Mahahjan]

[EwoutH]

Sorry, I mean a screenshot of how the visualisation looks with different shapes, to show that it works.

[Aryan1Mahahjan]

Sorry, I mean a screenshot of how the visualisation looks with different shapes, to show that it works.

How should show or generate visualization looks with different is their a test or dataset to show?

[EwoutH]

You could adapt an example model, like: https://github.com/projectmesa/mesa-examples/tree/main/examples/boltzmann_wealth_model_experimental

Or create a simple model yourself.