Write Mesa 3.0 migration guide

[EwoutH]

Update: The current version of the migration guide is now available on Read the docs!

It would be very useful have a Mesa 3.0 migration guide. It will also help to start writing it soon, so users have time to read it and update while we're still in alpha/beta.

The migration guide is purely for current functionatity that's removed or changed in an backwards-incompatible way. The release notes will be for new features that don't break older models.

Topics

• Reserved variables (Handling Private/Reserved Variables in Mesa #2230)
  • Change warning when setting model.agents to error #2225
• Model initialization requirement (Require Mesa models to be initialized with super().__init__() #2218)
• Flat namespace removal (Remove mesa.flat namespace #2091)
• Automatic assignment of unique_id to Agents
  • Automatically assign unique_id to Agents #2226
• AgentSet (and model.agents)
  • Change warning when setting model.agents to error #2225
  • Allow AgentSet.do() to take Callable function #2219
  • Split AgentSet into map and do to seperate return types #2237
  • Performance enhancements for Model.agents #2251
• Time and schedulers:
  • model: Automatically increase steps counter #2223
  • Reinstate PR #161: Replace schedulers with AgentSet functionality mesa-examples#183
• Visualisation (breaking: Remove visualization_old (mesa-viz-tornado) #2133 and viz: Combine code for rendering in browser and Jupyter #2180

This list may be incomplete, feel free to extend

A lot of information is already in the PR descriptions themselves. There are also some Mesa-examples updates that could help:

• Resolve all warnings in pytest runs of examples mesa-examples#153
• Use SolaraViz instead of JupyterViz in examples mesa-examples#155
• Replace RandomActivation and SimultaneousActivation schedulers with AgentSet functionality mesa-examples#161

PRs

• Write initial Mesa Migration guide #2257

[EwoutH]

I think the main thing is written, so closing as completed!

[EwoutH]

@quaquel suggested that the seed need to be passed to model when calling super().