From 2cdbcb6289c7ed0a7b086768bf5930f05c30568b Mon Sep 17 00:00:00 2001 From: Ewout ter Hoeven Date: Sat, 5 Oct 2024 09:43:51 +0200 Subject: [PATCH] Update version and release notes for 3.0.0b0 (#2339) --- HISTORY.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ mesa/__init__.py | 2 +- 2 files changed, 45 insertions(+), 1 deletion(-) diff --git a/HISTORY.md b/HISTORY.md index c1eb2c8f759..1558c0416af 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -1,6 +1,50 @@ --- title: Release History --- +# 3.0.0b0 (2024-10-04) +## Highlights +We're proud to release the first Mesa 3.0 beta! This pre-release announces that we're ready for Mesa 3.0 to be tested by all our regular users. We try to not making breaking changes anymore, but focus on resolving bugs and imperfections. + +In this beta, not so much has changed as in the alphas (we're stabilizing, that's a good sign), but there are still a few notable things: +- Agents now have to be initialized without their `unique_id`. See [#2328](https://github.com/projectmesa/mesa/pull/2328) and the [Migration guide](https://mesa.readthedocs.io/latest/migration_guide.html#automatic-assignment-of-unique-id-to-agents). +- PropertyLayers can now be visualized! See [#2336](https://github.com/projectmesa/mesa/pull/2336) for details and some examples, and [mesa-examples#214](https://github.com/projectmesa/mesa-examples/pull/214) as a simple example model. +- We reduced the core dependencies of Mesa, so that's a lighter and simpler install. You can now use extras to install the dependencies, for example add `[viz]` to install all visualisation dependencies: `pip install -U --pre mesa[viz]`. See [#2265](https://github.com/projectmesa/mesa/pull/2265) for details. +- The [Mesa Overview](https://mesa.readthedocs.io/latest/overview.html) as fully updated for 3.0. We highly recommend reading though it! +- We made some more progress on the experimental Cell Space, adding movement and integrating the PropertyLayer. Among others, Agents have nu initial movement capabilities for grids. Development continues during the betas and + +We plan to release one or two more beta's in the coming weeks, and tag a release candidate and Mesa 3.0 late October. In the [v3.0 milestone](https://github.com/projectmesa/mesa/milestone/43) are the critical items on our todo-list. + +You can install this pre-release as usual with: + +```bash +pip install --upgrade --pre mesa +``` +We're very curious what you think, try it out and ask any questions or share any feedback [here](https://github.com/projectmesa/mesa/discussions/2338)! + +## What's Changed +### โš ๏ธ Breaking changes +* update `Agent.__init__` to remove deprecation warning by @quaquel in https://github.com/projectmesa/mesa/pull/2328 +### ๐ŸŽ‰ New features added +* Visualize PropertyLayers by @EwoutH in https://github.com/projectmesa/mesa/pull/2336 +### ๐Ÿงช Experimental features +* Encapsulate cell movement in properties by @quaquel in https://github.com/projectmesa/mesa/pull/2333 +* experimental: Integrate PropertyLayers into cell space by @EwoutH in https://github.com/projectmesa/mesa/pull/2319 +* Generalize CellAgent by @Corvince in https://github.com/projectmesa/mesa/pull/2292 +### ๐Ÿ›  Enhancements made +* Reduce core dependencies, split in optional dependencies by @EwoutH in https://github.com/projectmesa/mesa/pull/2265 +### ๐Ÿ› Bugs fixed +* viz: stop running and disable buttons when model.running is False by @wang-boyu in https://github.com/projectmesa/mesa/pull/2332 +### ๐Ÿ“œ Documentation improvements +* docs: Update overview for Mesa 3.0 by @EwoutH in https://github.com/projectmesa/mesa/pull/2317 +* Readthedocs: Add version switch and update URL by @EwoutH in https://github.com/projectmesa/mesa/pull/2324 +### ๐Ÿ”ง Maintenance +* tests: Resolve warnings by removing scheduler and updating arguments by @EwoutH in https://github.com/projectmesa/mesa/pull/2329 +* add super call to Model and remove self.schedule by @quaquel in https://github.com/projectmesa/mesa/pull/2334 +### Other changes +* Deprecate `initialize_data_collector` by @EwoutH in https://github.com/projectmesa/mesa/pull/2327 + +**Full Changelog**: https://github.com/projectmesa/mesa/compare/v3.0.0a5...v3.0.0b0 + # 3.0.0a5 (2024-09-21) ## Highlights Mesa v3.0 alpha 5 release contains many quality of life updates, a big new feature for the DataCollector and a major deprecation. diff --git a/mesa/__init__.py b/mesa/__init__.py index 20ace7cf141..6214d18dacd 100644 --- a/mesa/__init__.py +++ b/mesa/__init__.py @@ -23,7 +23,7 @@ ] __title__ = "mesa" -__version__ = "3.0.0a5" +__version__ = "3.0.0b0" __license__ = "Apache 2.0" _this_year = datetime.datetime.now(tz=datetime.timezone.utc).date().year __copyright__ = f"Copyright {_this_year} Project Mesa Team"