mesa icon indicating copy to clipboard operation
mesa copied to clipboard

breaking: Remove visualization_old (mesa-viz-tornado)

Open rht opened this issue 1 year ago • 5 comments

TODO:

  • [ ] Merge #2091.
  • [x] Update cookiecutter template.

rht avatar May 08 '24 05:05 rht

This fixes the tests.

rht avatar May 08 '24 05:05 rht

Performance benchmarks:

Model Size Init time [95% CI] Run time [95% CI]
Schelling small 🔵 -0.1% [-0.4%, +0.1%] 🔵 -0.7% [-1.0%, -0.5%]
Schelling large 🔵 -0.9% [-1.6%, -0.2%] 🔵 -2.0% [-2.9%, -1.2%]
WolfSheep small 🔵 -0.3% [-1.4%, +0.9%] 🔵 -1.1% [-1.4%, -0.8%]
WolfSheep large 🔵 -1.3% [-2.0%, -0.5%] 🔵 -2.3% [-3.9%, -0.7%]
BoidFlockers small 🔵 -0.1% [-0.8%, +0.6%] 🔵 -0.7% [-1.3%, -0.1%]
BoidFlockers large 🔵 -1.4% [-2.1%, -0.6%] 🔵 -0.3% [-1.1%, +0.3%]

github-actions[bot] avatar May 08 '24 05:05 github-actions[bot]

To be clear -- Does this do the following?

  • [ ] This fixes the tests mentioned in #2091?
  • [ ] Adds deprecation warning?
  • [ ] Updates cookie cutter template?

Questions --

  1. Does #2091 need to be merged first, but this shortly after?
  2. What are the recommended methods for testing this? (I looked it over, but I wan to make sure I am not missing something.)
  3. This all is consider 2.3 right, not 3.0?

jackiekazil avatar Jun 23 '24 16:06 jackiekazil

To be clear -- Does this do the following?

It does 2 items except for adding the deprecation warning. The deprecation warning is to be added in the branch https://github.com/projectmesa/mesa/tree/2.3.x-maintenance.

Does https://github.com/projectmesa/mesa/pull/2091 need to be merged first, but this shortly after?

#2091 needs to be merged first, then I rebase this PR, and then it can be merged.

What are the recommended methods for testing this? (I looked it over, but I wan to make sure I am not missing something.)

The examples being tested in CI don't have frontend in them. A manual testing would be to test the Solara examples in mesa-examples.

This all is consider 2.3 right, not 3.0?

This is for 3.0.

rht avatar Jun 24 '24 04:06 rht

A manual testing would be to test the Solara examples in mesa-examples.

Without manual changes, they will fail because they still use the mesa.experimental namespace instead of mesa.visualization.

rht avatar Jun 24 '24 04:06 rht

As I mentioned in our dev meeting, my concern is about what the users need to do for this... So if a user wants to stick to tornado visualization, he/she will not be able to use Mesa's new features? Conversely if a user wants to update Mesa, he/she will need to migrate from tornado to jupyter?

I might be wrong but if this is the case, shall we have some kind of migration guide to assist the users' transition, so that they are not confused or frustrated.

wang-boyu avatar Jul 02 '24 13:07 wang-boyu

That would be the idea (and I support it). Old visualisation use Mesa 2.3.x, new visualisation for 3.0.

We can't support everything forever, we have to move forward.

EwoutH avatar Jul 02 '24 16:07 EwoutH

@EwoutH, this feels like a clean way to break it.

@wang-boyu RE:

I might be wrong but if this is the case, shall we have some kind of migration guide to assist the users' transition, so that they are not confused or frustrated.

We could do a write-up for users and announce it. We need 1 or 2 use cases to create adequate documentation. Maybe we clarify that people can and are welcome to ask for help with conversions?

jackiekazil avatar Jul 03 '24 04:07 jackiekazil

I would recommend merging this and then tag a first pre-release (Mesa 3.0.0a0), so users and developers can start testing with the new visualisation.

EwoutH avatar Jul 03 '24 09:07 EwoutH

We can use the two examples in the mesa-examples repo:

  • https://github.com/projectmesa/mesa-examples/tree/main/examples/boltzmann_wealth_model_experimental
  • https://github.com/projectmesa/mesa-examples/tree/main/examples/schelling_experimental

@rht #2091 still need to be merged before this PR?

EwoutH avatar Jul 03 '24 10:07 EwoutH

I have merged #2091 and rebased this PR so that it only has 1 relevant commit.

rht avatar Jul 03 '24 10:07 rht

We can use the two examples in the mesa-examples repo:

https://github.com/projectmesa/mesa-examples/tree/main/examples/boltzmann_wealth_model_experimental
https://github.com/projectmesa/mesa-examples/tree/main/examples/schelling_experimental

I think it should be either one of them, and virus on a network or boid flocker, because the 2 examples you listed have some overlap in the usage of space. Virus on a network uses network visualization, and boid flocker uses continuous space.

rht avatar Jul 03 '24 11:07 rht

Thanks a lot for all the work!

EwoutH avatar Jul 03 '24 11:07 EwoutH

We could do a write-up for users and announce it. We need 1 or 2 use cases to create adequate documentation. Maybe we clarify that people can and are welcome to ask for help with conversions?

Yup for instance NetLogo has transition guide for new releases: https://ccl.northwestern.edu/netlogo/docs/transition.html

wang-boyu avatar Jul 04 '24 01:07 wang-boyu