Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename JupyterViz to SolaraViz #2187

Merged
merged 2 commits into from
Jul 29, 2024
Merged

Conversation

rht
Copy link
Contributor

@rht rht commented Jul 29, 2024

Fixes #2175.

@rht
Copy link
Contributor Author

rht commented Jul 29, 2024

Note: JupyterViz is still available. It's an alias to SolaraViz. i.e. This is not a breaking change.

Copy link

Performance benchmarks:

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

@EwoutH
Copy link
Member

EwoutH commented Jul 29, 2024

Thanks for the PR! Just to double check, SolaraViz is the most descriptive and fitting name we could give the current visualisation, right? You said something about other backends, but that would be new classes right?

@rht
Copy link
Contributor Author

rht commented Jul 29, 2024

Just to double check, SolaraViz is the most descriptive and fitting name we could give the current visualisation, right?

Actually, it could have been called just Visualization. But I'm fine either way.

Another backend would be Dash, see. e.g. vizro which has really good looking visualization: https://github.com/mckinsey/vizro.

@EwoutH
Copy link
Member

EwoutH commented Jul 29, 2024

But then that would be a new function right? So instead of importing

from mesa.visualization import SolaraViz

We add a new, second function called DashViz for visualization, so you could also do:

from mesa.visualization import DashViz

@rht
Copy link
Contributor Author

rht commented Jul 29, 2024

Yes, it would be a new function/class.

@rht rht merged commit 92e744b into projectmesa:main Jul 29, 2024
10 of 11 checks passed
@rht rht deleted the rename_to_solaraviz branch July 29, 2024 19:23
@EwoutH EwoutH added the enhancement Release notes label label Aug 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Release notes label
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename JupyterViz to SolaraViz
2 participants