From 379c5807ea9a3514392bdb89c9f5b8962826c04b Mon Sep 17 00:00:00 2001 From: Ewout ter Hoeven Date: Thu, 22 Aug 2024 08:29:27 +0200 Subject: [PATCH] Update version and release notes for 3.0.0a2 (#2234) --- HISTORY.md | 31 +++++++++++++++++++++++++++++++ mesa/__init__.py | 2 +- 2 files changed, 32 insertions(+), 1 deletion(-) diff --git a/HISTORY.md b/HISTORY.md index 73dd58343e8..91d4c70356e 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -1,6 +1,37 @@ --- title: Release History --- +# 3.0.0a2 (2024-08-21) +## Highlights +In Mesa 3.0 alpha 2 (`v3.0.0a2`) we've done more clean-up in preparation for Mesa 3.0. We now [require](https://github.com/projectmesa/mesa/pull/2218) `super().__init__()` to run on initializing a Mesa model subclass, `Model.agents` is now fully reserved for the Model's internal AgentSet and we fixed a bug in our Solara space_drawer. + +A new feature was added in [#2219](https://github.com/projectmesa/mesa/pull/2219), which now also allows `AgentSet.do()` to take any callable function, instead of only a string referencing to an Agent method. The argument name was changed from `method_name` to `method`. + +The new Solara visualisation now allows portraying agents in different shapes, checkout some examples in [#2214](https://github.com/projectmesa/mesa/pull/2214). + +We're also working hard on our [example models](https://github.com/projectmesa/mesa-examples). All model warnings were [resolved](https://github.com/projectmesa/mesa-examples/pull/153) and we've [replaced](https://github.com/projectmesa/mesa-examples/pull/161) a lot of schedulers with simpler and more flexible AgentSet functionality. Checkout our [open issues](https://github.com/projectmesa/mesa-examples/issues) if you want to help improve our example models further! + +## What's Changed +### โš ๏ธ Breaking changes +* breaking: Add dependencies argument to custom space_drawer by @rht in https://github.com/projectmesa/mesa/pull/2209 +* Require Mesa models to be initialized with `super().__init__()` by @EwoutH in https://github.com/projectmesa/mesa/pull/2218 +* Allow AgentSet.do() to take Callable function by @quaquel in https://github.com/projectmesa/mesa/pull/2219 +* Change warning when setting model.agents to error by @EwoutH in https://github.com/projectmesa/mesa/pull/2225 +### ๐Ÿงช Experimental features +* devs/eventlist: Add repr method to print EventList pretty by @EwoutH in https://github.com/projectmesa/mesa/pull/2195 +### ๐Ÿ›  Enhancements made +* Visualisation: Allow specifying Agent shapes in agent_portrayal by @rmhopkins4 in https://github.com/projectmesa/mesa/pull/2214 +### ๐Ÿ“œ Documentation improvements +* docs/conf.py: Use modern `intersphinx_mapping` format by @EwoutH in https://github.com/projectmesa/mesa/pull/2206 +* docs: Update Readme and tutorials to mention Mesa 3.0 pre-releases by @EwoutH in https://github.com/projectmesa/mesa/pull/2203 +### ๐Ÿ”ง Maintenance +* CI: Let pytest treat warnings as errors for examples by @EwoutH in https://github.com/projectmesa/mesa/pull/2204 + +## New Contributors +* @rmhopkins4 made their first contribution in https://github.com/projectmesa/mesa/pull/2214 + +**Full Changelog**: https://github.com/projectmesa/mesa/compare/v3.0.0a1...v3.0.0a2 + # 3.0.0a1 (2024-08-01) ## Highlights Mesa 3.0 alpha 1 (`v3.0.0a1`) is another step towards our next major version. This release introduces a name change from JupyterViz (jupyter_viz) to SolaraViz (solara_viz), to better represent the tech stack being used. It also includes two bugfixes also present in 2.3.2. diff --git a/mesa/__init__.py b/mesa/__init__.py index 1c362f45908..50d6b300c47 100644 --- a/mesa/__init__.py +++ b/mesa/__init__.py @@ -24,7 +24,7 @@ ] __title__ = "mesa" -__version__ = "3.0.0a1" +__version__ = "3.0.0a2" __license__ = "Apache 2.0" _this_year = datetime.datetime.now(tz=datetime.timezone.utc).date().year __copyright__ = f"Copyright {_this_year} Project Mesa Team"