title |
---|
Release History |
With Mesa 3.1.0 we're back on our regular release schedule after the big Mesa 3.0 release, with some exciting new features.
This release adds experimental support for Observables and Computed, enabling a more reactive and responsive programming model for agent-based simulations. The new Observable
and Computable
classes allow developers to declaratively define attributes that automatically emit signals when their values change, and compute derived values that update dynamically. This lays the groundwork for more advanced event handling and data visualization features in future releases (#2291).
The experimental cell space module has been updated with full support for n-dimensional property layers. These allow agents to easily interact with and modify spatial properties of the environment, such as terrain, resources, or environmental conditions. The new implementation provides a more intuitive attribute-based API and ensures tight integration with the cell space architecture (#2512).
Mesa now includes built-in support for logging using the standard Python logging
module. This provides developers with a flexible and powerful way to add structured diagnostic and debug output to their simulations, without the need for custom logging solutions. The logging system is integrated throughout the library, including the new SolaraViz visualization system (#2506).
Creating multiple agents with varying initialization parameters is now significantly easier with the new Agent.create_agents
class method. This factory function supports both uniform and per-agent parameters, simplifying the code required to set up a simulation with a large number of heterogeneous agents (#2351).
In addition to the major new features, this release includes a number of smaller enhancements and bug fixes that improve the overall developer experience. These include removing deprecated functionality, cleaning up examples, and addressing various edge cases reported by the community. Mesa 3.1 requires Python 3.11 or higher.
- Add support for Observables to MESA by @quaquel in projectmesa#2291
- Add full support for property layers to cell spaces by @quaquel in projectmesa#2512
- Add logging to MESA by @quaquel in projectmesa#2506
- Add
create_agents
factory method to Agent by @quaquel in projectmesa#2351
- Add seed control to all examples by @quaquel in projectmesa#2496
- doc fix for pip install error on mac by @quaquel in projectmesa#2508
- Refactored docs for Introductory Tutorial by @Spartan-71 in projectmesa#2511
- Add module-level docstring to experimental features by @EwoutH in projectmesa#2532
- Remove deprecated time module by @EwoutH in projectmesa#2476
- Drop support for Python 3.10, require Python >= 3.11 by @EwoutH in projectmesa#2474
- Remove deprecated functionality by @EwoutH in projectmesa#2483
- Remove visualization modules from
mesa.experimental
by @quaquel in projectmesa#2495 - Cleanup two occurrences of removed scheduler by @EwoutH in projectmesa#2499
- move _setup_agent_registration into
Model.__init__
by @quaquel in projectmesa#2501 - remove devs related examples from devs/examples by @quaquel in projectmesa#2507
- added empty iterable checks and updated tests by @Sahil-Chhoker in projectmesa#2523
- Fix: running Mesa in Docker with Schelling model by @AdamZh0u in projectmesa#2524
- @Spartan-71 made their first contribution in projectmesa#2511
- @Sahil-Chhoker made their first contribution in projectmesa#2523
- @AdamZh0u made their first contribution in projectmesa#2524
Full Changelog: https://github.com/projectmesa/mesa/compare/v3.0.3...v3.1.0
A small bugfix release that fixes two bugs.
- cell_space: Allow CellCollection to be empty by @EwoutH in projectmesa#2502
- Only set model_parameters once by @Corvince in projectmesa#2505
Full Changelog: https://github.com/projectmesa/mesa/compare/v3.0.2...v3.0.3
Mesa 3.0.2 is a small follow-up patch release, in which we fixed a lot of small bugs in the example models their visualisation, and improved their testing.
- allow components as a positional argument again by @Corvince in projectmesa#2488
- examples: Add required components keyword by @EwoutH in projectmesa#2485
- examples: Fix boid_flockers viz by @EwoutH in projectmesa#2492
- examples: Fix schelling viz by @EwoutH in projectmesa#2490
- example: Add input sliders to Sugerscape viz by @EwoutH in projectmesa#2487
- examples/gol: Add initial fraction alive, add sliders to viz by @EwoutH in projectmesa#2489
- test app init of examples by @Corvince in projectmesa#2491
Full Changelog: https://github.com/projectmesa/mesa/compare/v3.0.1...v3.0.2
After our huge 3.0.0 release, Mesa 3.0.1 follows up with two improvements to experimental features, examples and docs.
- Bugfixes to DEVS by @quaquel in projectmesa#2478
- Support simulators in SolaraViz by @quaquel in projectmesa#2470
- issue a user warning if random is None by @quaquel in projectmesa#2479
- Integrate benchmarks and example models by @EwoutH in projectmesa#2473
- docs/tutorial: Replace scheduler in MoneyModel by @EwoutH in projectmesa#2475
- docs: update migration_guide.md by @eltociear in projectmesa#2480
- Update some DeprecationWarnings to note they are removed in Mesa 3.1 by @EwoutH in projectmesa#2481
- @eltociear made their first contribution in projectmesa#2480
Full Changelog: https://github.com/projectmesa/mesa/compare/v3.0.0...v3.0.1
Mesa 3.0 brings major improvements to agent-based modeling, making it more intuitive and powerful while reducing complexity. This release modernizes core functionalities and introduces new capabilities for both beginners and advanced users.
The centerpiece of Mesa 3.0 is its new agent management system. Agents are now automatically tracked and assigned unique IDs, eliminating common boilerplate code. The new AgentSet functionality provides an elegant and flexible way to work with agents, for example:
# Find agents meeting specific criteria
wealthy_agents = model.agents.select(lambda a: a.wealth > 1000)
# Group and analyze agents
grouped = model.agents.groupby("state")
state_stats = grouped.agg({
"count": len,
"avg_age": ("age", np.mean),
"total_wealth": ("wealth", sum)
})
# Activate agents in different patterns
model.agents.shuffle_do("step") # Random activation
model.agents.select(lambda a: a.energy > 0).do("move") # Conditional activation
The AgentSet provides powerful methods for filtering, grouping, and analyzing agents, making it easier to express complex model logic. Each model automatically maintains an AgentSet containing all agents (model.agents
) and separate AgentSets for each agent type (model.agents_by_type
). See the full AgentSet docs here.
Mesa 3.0's new experimental visualization system, SolaraViz, provides a modern, interactive interface for model exploration:
from mesa.visualization import SolaraViz, make_space_component, make_plot_component
visualization = SolaraViz(
model,
[
make_space_component(agent_portrayal),
make_plot_component(["population", "average_wealth"]),
lambda m: f"Step {m.steps}: {len(m.agents)} agents" # Custom text component
],
model_params=parameter_controls
)
Key visualization features:
- Interactive browser-based interface with real-time updates
- Support for both grid-based and network models
- Visualization of PropertyLayers and hexagonal grids
- Custom components using Matplotlib or text
- Improved performance and responsiveness
Check out the Visualization Tutorial to get started.
Note: SolaraViz is in active development. We might make API breaking changes between Mesa 3.0 and 3.1.
The DataCollector now supports collecting different metrics for different agent types, using agenttype_reporters
:
self.datacollector = DataCollector(
model_reporters={"total_wealth": lambda m: m.agents.agg("wealth", sum)},
agent_reporters={"age": "age", "wealth": "wealth"},
agenttype_reporters={
Predator: {"kills": "kills_count"},
Prey: {"distance_fled": "total_flight_distance"}
}
)
Mesa 3.0 introduces several experimental features for advanced modeling:
- Cell Space with integrated PropertyLayers and improved agent movement capabilities
- Voronoi grid implementation
- Event-scheduling simulation capabilities
These experimental features are in active development and might break API between releases.
See our Mesa 3.0 migration guide for a full overview.
If you want to move existing models from Mesa 2.x to 3.0, there are a few things you have to change.
- Models must explicitly initialize the Mesa base class:
class MyModel(mesa.Model):
def __init__(self, n_agents, seed=None):
super().__init__(seed=seed) # Required in Mesa 3.0
- Agents are created without manual ID assignment:
# Old
agent = MyAgent(unique_id=1, model=self)
# New
agent = MyAgent(model=self)
- Scheduler replacement with AgentSet operations:
# Old (RandomActivation)
self.schedule = RandomActivation(self)
self.schedule.step()
# New
self.agents.shuffle_do("step")
# Old (SimultaneousActivation)
self.schedule = SimultaneousActivation(self)
self.schedule.step()
# New
self.agents.do("step")
self.agents.do("advance")
Furthermore:
- Steps counter automatically increments
mesa.flat
namespace removed- Python 3.10+ required
- Reserved model variables (
agents
,steps
, etc.) protected - Simplified DataCollector initialization
- Old visualization system replaced by SolaraViz
Install Mesa 3.0:
pip install --upgrade mesa
If building a new model, we recommend checking out the updated Mesa Overview and Introductory Tutorial.
For updating existing models, we recommend upgrading in steps:
- Update to latest Mesa 2.x
- Address deprecation warnings
- Upgrade to Mesa 3.0
- Replace schedulers with AgentSet functionality
A detailed migration guide is available to help moving to Mesa 3.0. For questions or support, join our GitHub Discussions or Matrix Chat.
We would love to hear what you think about Mesa 3.0! Say hello here and leave any feedback on 3.0 here.
We're releasing the Mesa 3.0 Release Candidate, ready for final testing before we release Mesa 3.0 later this week!
In this last 3.0 pre-release, the visualisation has been thoroughly updated, with a brand new API. Visualizing the experimental Cell Space, including PropertyLayers and hexogonal grids, is now also supported.
We're still working very active on the visualisation, so we have marked that experimental for Mesa 3.0. We will stabilize SolaraViz in Mesa 3.1.
Any feedback and last-minute bug reports are welcome here.
- Viz: Refactor Matplotlib plotting by @quaquel in projectmesa#2430
- api reorganization by @quaquel in projectmesa#2447
- Mark SolaraViz as experimental for Mesa 3.0 by @EwoutH in projectmesa#2459
- expand ax.scatter kwargs that can be used by @quaquel in projectmesa#2445
- Fix #2452 - handle solara viz model params better by @Corvince in projectmesa#2454
- Update MoneyModel.py by @quaquel in projectmesa#2458
- Updates to Epstein example by @quaquel in projectmesa#2429
- Update examples to use updated space drawing by @quaquel in projectmesa#2442
- Update wolf-sheep png and fix typo in file name by @quaquel in projectmesa#2444
- Include main examples readme in docs by @quaquel in projectmesa#2448
- remove how-to guide and update docs in places by @quaquel in projectmesa#2449
- remove deprecated HexGrid class by @quaquel in projectmesa#2441
- rename make_plot_measure to make_plot_component and add some kwargs by @quaquel in projectmesa#2446
Full Changelog: https://github.com/projectmesa/mesa/compare/v3.0.0b2...v3.0.0rc0
Mesa 3.0 beta 2 includes major work on the example models, docs, a new tutorial and visualisation.
The included example models are now part of the Mesa package itself and directly importable, using:
from mesa.examples import BoidFlockers, BoltzmannWealthModel, ConwaysGameOfLife, ...
The advanced examples were also restructured and cleaned up.
The tutorial was completely rewritten for Mesa 3.0, including it's latest features and practices. Many of our other docs also received some love, and almost everything is now ready for Mesa 3.0.
A new feature to remove all agents from the model was added, and the visualisation now supports drawing the experimental discrete spaces in both matplotlib and altair. All agents which are in a space can now conveniently be accessed with .agents
.
The rarely used mesa startproject
cookiecutter feature was removed. We updated our best-practice guide to include how to structure a modern Mesa project, which is now very straightforward.
- remove cookiecutter by @quaquel in projectmesa#2421
- Add support for drawing discrete grids by @quaquel in projectmesa#2386
- Altair spaces by @quaquel in projectmesa#2397
- remove_all_agents method added to model by @quaquel in projectmesa#2394
- Pass through model.rgn in agent analogous to model.random by @quaquel in projectmesa#2400
- add agents property to all spaces by @quaquel in projectmesa#2418
- update_tutorial environment by @tpike3 in projectmesa#2411
- Fix for mistaken removal of _draw_grid by @quaquel in projectmesa#2398
- fixes weakref bug in shuffe_do by @quaquel in projectmesa#2399
- refactor: Simplify Schelling code by @rht in projectmesa#2353
- Move examples into mesa by @Corvince in projectmesa#2387
- Explicitly test basic examples by @quaquel in projectmesa#2390
- Make example import absolute by @quaquel in projectmesa#2402
- Cleanup and restructure EpsteinCivilViolence and PdGrid examples by @EwoutH in projectmesa#2408
- Reorganize advanced examples: wolf_sheep and sugarscape_g1mt by @quaquel in projectmesa#2410
- reactivate ruff for advanced examples and include them in tests by @quaquel in projectmesa#2414
- Include examples in readthedocs (port) by @EwoutH in projectmesa#2392
- Update into_tutorial by @tpike3 in projectmesa#2372
- Update Schelling Readme.md by @quaquel in projectmesa#2406
- Update Conway example by @quaquel in projectmesa#2403
- Boltzman readme by @quaquel in projectmesa#2405
- Update Readme.md of Boid flockers by @quaquel in projectmesa#2404
- add advanced examples to rtd by @quaquel in projectmesa#2413
- Tutorial Improvements by @tpike3 in projectmesa#2415
- space: Add note that Grids are maintenance only by @EwoutH in projectmesa#2420
- Migration guide: Update automatic unique_id assignment examples by @EwoutH in projectmesa#2419
- Update docstring of SimEvent by @quaquel in projectmesa#2417
- best-practices: Update Model Layout section by @EwoutH in projectmesa#2424
- docs: Clean-up index.md by @EwoutH in projectmesa#2422
- Add empty
pull_request_template.md
to enable PR template chooser by @EwoutH in projectmesa#2409
Full Changelog: https://github.com/projectmesa/mesa/compare/v3.0.0b1...v3.0.0b2
Mesa 3.0 beta 1 is our last beta release before the Mesa 3.0 stable release. We are restructuring our examples and have move 9 core examples from mesa-examples to mesa itself (#2358). The 5 basic examples are now directly importable (#2381):
from examples.basic import BoidFlockers, BoltzmannWealthModel, ConwaysGameOfLife, Schelling, VirusOnNetwork
The 5 basic examples will always use stable Mesa features, we are also working on 4 more advanced example which can also include experimental features.
All our core examples can now be viewed in the examples
folder. mesa-examples will continue to exists for user showcases. We're also working on making the examples visible in the ReadtheDocs (#2382) and on an website (mesa-examples#139). Follow all our work on the examples in this tracking issue #2364.
Furthermore, the visualizations are improved by making visualization elements scalable and more clearly labeling the plots, and the Model now has an rng
argument for an SPEC 7 compliant NumPy random number generator (#2352). Following SPEC 7, you have to pass either seed
or rng
. Whichever one you pass will be used to seed both random.Random
, and numpy.random.Generator.
- replace model with random in AgentSet init by @quaquel in projectmesa#2350
- cell space: Add convenience properties for grid width and height by @quaquel in projectmesa#2348
- Bugfix for deepcopy / pickling discrete spaces by @quaquel in projectmesa#2378
- Move core example models back (v2) by @EwoutH in projectmesa#2358
- Add Model.rng for SPEC-7 compliant numpy random number generation by @quaquel in projectmesa#2352
- use GridDraggable instead of Column in SolaraViz by @wang-boyu in projectmesa#2344
- update legend, xlabel & format of matplotlib plots by @wang-boyu in projectmesa#2346
- init.py: Import mesa.experimental by @EwoutH in projectmesa#2374
- Importable examples by @Corvince in projectmesa#2381
- experimental init: Fix Solara import by making it lazy by @EwoutH in projectmesa#2357
- fix: pass
model.random
to schedulers by @quaquel in projectmesa#2359 - fix: register agent after creating unique_id and pos attributes by @wang-boyu in projectmesa#2368
- solara: viz tutorial: fix histogram code by @Corvince in projectmesa#2379
- Cleanup and restructure basic example models by @EwoutH in projectmesa#2365
- Ruff basic examples by @EwoutH in projectmesa#2370
- Update migration_guide.md by @quaquel in projectmesa#2347
- Code coverage: ignore experimental and visualization by @Corvince in projectmesa#2361
- add codecov token, fixes #2363 by @Corvince in projectmesa#2366
- add test_time back by @quaquel in projectmesa#2367
- Release notes: Add example category by @EwoutH in projectmesa#2369
Full Changelog: https://github.com/projectmesa/mesa/compare/v3.0.0b0...v3.0.0b1
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 and the Migration guide. - PropertyLayers can now be visualized! See #2336 for details and some examples, and mesa-examples#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 for details. - The Mesa Overview 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 are the critical items on our todo-list.
You can install this pre-release as usual with:
pip install --upgrade --pre mesa
We're very curious what you think, try it out and ask any questions or share any feedback here!
- update
Agent.__init__
to remove deprecation warning by @quaquel in projectmesa#2328
- Visualize PropertyLayers by @EwoutH in projectmesa#2336
- Encapsulate cell movement in properties by @quaquel in projectmesa#2333
- experimental: Integrate PropertyLayers into cell space by @EwoutH in projectmesa#2319
- Generalize CellAgent by @Corvince in projectmesa#2292
- Reduce core dependencies, split in optional dependencies by @EwoutH in projectmesa#2265
- viz: stop running and disable buttons when model.running is False by @wang-boyu in projectmesa#2332
- docs: Update overview for Mesa 3.0 by @EwoutH in projectmesa#2317
- Readthedocs: Add version switch and update URL by @EwoutH in projectmesa#2324
- tests: Resolve warnings by removing scheduler and updating arguments by @EwoutH in projectmesa#2329
- add super call to Model and remove self.schedule by @quaquel in projectmesa#2334
- Deprecate
initialize_data_collector
by @EwoutH in projectmesa#2327
Full Changelog: https://github.com/projectmesa/mesa/compare/v3.0.0a5...v3.0.0b0
Mesa v3.0 alpha 5 release contains many quality of life updates, a big new feature for the DataCollector and a major deprecation.
The entire mesa.time
module, including all schedulers, has been deprecated (#2306). Users are encouraged to transition to AgentSet functionality for more flexible and explicit agent activation patterns. Check the migration guide on how to upgrade.
The DataCollector now supports collecting data from specific Agent subclasses using the new agenttype_reporters
parameter (#2300). This allows collecting different metrics for different agent types. For example:
self.datacollector = DataCollector(
agenttype_reporters={
Wolf: {"sheep_eaten": "sheep_eaten"},
Sheep: {"wool": "wool_amount"}
}
)
Furthermore, a new shuffle_do()
method for AgentSets provides a faster way to perform shuffle().do()
(#2283). The GroupBy class gained count()
and agg()
methods to count the number of agents in groups and aggregate variables of them (#2290).
In the experimental Cell Space, the CellCollection.select
method was updated to use at_most
instead of n
, aligning with the AgentSet API (#2307). Additionally, the Cell class now features a dedicated neighborhood
property for direct neighbors (default radius=1) and a get_neighborhood
method for larger radii (#2309).
Finally, SolaraViz received updates improving its interface and performance (#2299, #2304). Cell connections in grids and networks are now public and named for more intuitive agent movements (#2296). The Model class initialization process was simplified by moving random seed and random object creation to __init__
(#1940). Documentation has been extensively updated, including enforcing Google docstrings (#2294) and reorganizing the API documentation (#2298) for better clarity and navigation.
While the Mesa 3.0 timeline is still being discussed, we're aiming at the first Mesa 3.0 beta in October followed by a stable release in November. Testing new features and sharing feedback is appreciated!
- GroupBy: Add
count
andagg
methods by @EwoutH in projectmesa#2290 - datacollector: Allow collecting data from Agent (sub)classes by @EwoutH in projectmesa#2300
- Add optimized shuffle_do() method to AgentSet by @EwoutH in projectmesa#2283
- Make cell connections public and named by @Corvince in projectmesa#2296
- SolaraViz Updates by @Corvince in projectmesa#2299
- Solara viz: use_task for non-threaded continuous play by @Corvince in projectmesa#2304
- Update to CellCollection.select by @quaquel in projectmesa#2307
- Have a dedicated neighborhood property and a get_neighborhood method on Cell by @quaquel in projectmesa#2309
- Enforce google docstrings by @quaquel in projectmesa#2294
- Api docs by @quaquel in projectmesa#2298
- update migration guide to describe solaraviz updates by @Corvince in projectmesa#2297
- Migration Guide: Add Model initialization requirement and automatic Agent.unique_id assignment by @EwoutH in projectmesa#2302
- Deprecate Time module and all its Schedulers by @EwoutH in projectmesa#2306
- intro_tutorial: Don't initialize agents with an unique_id by @EwoutH in projectmesa#2315
- Migration guide: Intro, upgrade strategy, model.agents, headers by @EwoutH in projectmesa#2314
- make typing behavior of AgentSet.get explicit by @quaquel in projectmesa#2293
- model: Move random seed and random to init by @rht in projectmesa#1940
- Remove schedulers from benchmark models. by @quaquel in projectmesa#2308
Full Changelog: https://github.com/projectmesa/mesa/compare/v3.0.0a4...v3.0.0a5
Mesa 3.0.0a4 contains two major breaking changes:
-
The Agent's
unique_id
is now automatically assigned, so doesn't need to be passed to the Agent class anymore. In a subclassed custom Agent, like normally used, this now looks like this:class Wolf(Agent): - def __init__(self, unique_id, model, energy=None): + def __init__(self, model, energy=None): # When initializing the super class (Agent), passing unique_id isn't needed anymore - super().__init__(unique_id, model) + super().__init__(model) - wolf = Wolf(unique_id, model) + wolf = Wolf(model)
Example models were updated in mesa-examples#194, which shows more examples on how to update existing models.
-
Our visualisation API is being overhauled, to be more flexible and powerful. For more details, see #2278.
- An initial update to the tutorial was made in #2289 and is available here.
- An initial example model was updated in mesa-examples#195, and more examples will be updated in mesa-examples#195.
- The old SolaraViz API is still available at
mesa.experimental
, but might be removed in future releases.
Furthermore, the AgentSet has a new agg
method to quickly get an aggerate value (for example min_energy = model.agents.agg("energy", min)
) (#2266), The Model get_agents_of_type
function is replaced by directly exposing the agents_by_type
property (which can be accessed as a dict) (#2267, mesa-examples#190) and the AgentSet get() methods can now handle missing values by replacing it with a default value (#2279).
Finally, it fixes a bug in which the Grid's move_agent_to_one_of
method with selection="closest"
selected a location deterministically, instead of randomly (#2118).
- move solara_viz back to experimental by @Corvince in projectmesa#2278
- track unique_id automatically by @quaquel in projectmesa#2260
- AgentSet: Add
agg
method by @EwoutH in projectmesa#2266 - Implement new SolaraViz API by @Corvince in projectmesa#2263
- Model: Replace
get_agents_of_type
method withagents_by_type
property by @EwoutH in projectmesa#2267 - add default SolaraViz by @Corvince in projectmesa#2280
- Simplify ModelController by @Corvince in projectmesa#2282
- Add default values and missing value handling to
agentset.get
by @quaquel in projectmesa#2279
- Fix deterministic behavior in
move_agent_to_one_of
withselection="closest"
by @OrenBochman in projectmesa#2118
- docs: Fix Visualization Tutorial (main branch) by @EwoutH in projectmesa#2271
- Docs: Fix broken relative links by removing
.html
suffix by @EwoutH in projectmesa#2274 - Readthedocs: Don't let notebook failures pass silently by @EwoutH in projectmesa#2276
- Update viz tutorial to the new API by @Corvince in projectmesa#2289
- Resolve multiprocessing warning, state Python 3.13 support by @rht in projectmesa#2246
- @OrenBochman made their first contribution in projectmesa#2118
Full Changelog: https://github.com/projectmesa/mesa/compare/v3.0.0a3...v3.0.0a4
Developments toward Mesa 3.0 are steaming ahead, and our fourth alpha release is packed with features and updates - only 8 days after our third.
Mesa 3.0.0a3 contains one breaking change: We now automatically increase the steps
counter by one at the beginning of each Model.steps()
call. That means increasing steps
by hand isn't necessary anymore.
The big new features is the experimental Voronoi grid that @vitorfrois implemented in #2084. It allows creating cells in a Voronoi layout as part of the experimental cell space. An example using it to model Cholera spread can be found here.
The AgentSet got a lot of love with two brand new methods: .groupby()
to split in groups (#2220) and .set()
to easily assign variables to all agents in that set (#2254). The select()
method is improved by allowing to select at most a fraction of the agents (#2253), and we split the do()
method in do()
and map()
to make a distinction between the return types (#2237).
Furthermore, we improved the performance of accessing Model.agents
, squashed a bug in SolaraViz, started testing on Python 3.13 and added a new benchmark model.
Our example models also got more love: We removed the RandomActivation
scheduler in 14 models and removed SimultaneousActivation in 3 models (examples#183). They now use the automatic step increase and AgentSet functionality. We started testing our GIS model in CI (examples#171) and resolved a lot of bugs in them (examples#172, help appreciated!).
Finally, we have two brand new examples: An Ant Colony Optimization model using an Ant System approach to the Traveling Salesman problem, a Mesa NetworkGrid, and a custom visualisation with SolaraViz (examples#157 by @zjost). The first example using the PropertyLayer
was added, a very fast implementation of Conway's Game of Life (examples#182).
To help the transition to Mesa 3.0, we started writing a migration guide. Progress is tracked in #2233, feedback and help is appreciated! Finally, we also added a new section to our contributor guide to get new contributors up to speed.
This pre-release can be installed as always with pip install --pre mesa
- model: Automatically increase
steps
counter by @EwoutH in projectmesa#2223
- Voronoi Tessellation based Discrete Space by @vitorfrois in projectmesa#2084
- Add AgentSet.groupby by @quaquel in projectmesa#2220
- AgentSet: Add
set
method by @EwoutH in projectmesa#2254
- Split AgentSet into map and do to separate return types by @quaquel in projectmesa#2237
- Performance enhancements for Model.agents by @quaquel in projectmesa#2251
- AgentSet: Allow selecting a fraction of agents in the AgentSet by @EwoutH in projectmesa#2253
- SolaraViz: Reset components when params are changed by @rht in projectmesa#2240
- Contribution: Add "I have no idea where to start" section by @EwoutH in projectmesa#2258
- Write initial Mesa Migration guide by @EwoutH in projectmesa#2257
- CI: Add test job for Python 3.13 by @EwoutH in projectmesa#2173
- Add pull request templates by @EwoutH in projectmesa#2217
- benchmarks: Add BoltzmannWealth model by @EwoutH in projectmesa#2252
- CI: Add optional dependency for examples by @EwoutH in projectmesa#2261
- @vitorfrois made their first contribution in projectmesa#2084
Full Changelog: https://github.com/projectmesa/mesa/compare/v3.0.0a2...v3.0.0a3
In Mesa 3.0 alpha 2 (v3.0.0a2
) we've done more clean-up in preparation for Mesa 3.0. We now require 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, 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.
We're also working hard on our example models. All model warnings were resolved and we've replaced a lot of schedulers with simpler and more flexible AgentSet functionality. Checkout our open issues if you want to help improve our example models further!
- breaking: Add dependencies argument to custom space_drawer by @rht in projectmesa#2209
- Require Mesa models to be initialized with
super().__init__()
by @EwoutH in projectmesa#2218 - Allow AgentSet.do() to take Callable function by @quaquel in projectmesa#2219
- Change warning when setting model.agents to error by @EwoutH in projectmesa#2225
- devs/eventlist: Add repr method to print EventList pretty by @EwoutH in projectmesa#2195
- Visualisation: Allow specifying Agent shapes in agent_portrayal by @rmhopkins4 in projectmesa#2214
- docs/conf.py: Use modern
intersphinx_mapping
format by @EwoutH in projectmesa#2206 - docs: Update Readme and tutorials to mention Mesa 3.0 pre-releases by @EwoutH in projectmesa#2203
- CI: Let pytest treat warnings as errors for examples by @EwoutH in projectmesa#2204
- @rmhopkins4 made their first contribution in projectmesa#2214
Full Changelog: https://github.com/projectmesa/mesa/compare/v3.0.0a1...v3.0.0a2
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.
- viz: Combine code for rendering in browser and Jupyter by @rht in projectmesa#2180
- Rename JupyterViz to SolaraViz by @rht in projectmesa#2187
- refactor: Rename jupyter_viz namespace to solara_viz by @rht in projectmesa#2188
- fix: Render agent marker radius correctly by @rht in projectmesa#2181
- fix: Use model.schedule.steps -> mode._steps for batch_run by @rht in projectmesa#2183
- Add original conference paper link to docs by @ENUMERA8OR in projectmesa#2160
- @ENUMERA8OR made their first contribution in projectmesa#2160
Full Changelog: https://github.com/projectmesa/mesa/compare/v3.0.0a0...v3.0.0a1
This is the first pre-release in the Mesa 3.0 series, which is still in active development. The v3.0.0a0
pre-release can help active Mesa developers help starting to test the latest features in their models.
Since it's in active development, more breaking changes may follow and it's not recommended for general usage.
There are two major breaking changes at this point:
- The old visualisation is removed, in favor of the new, Solara based, Jupyter Viz. This was already available in the 2.3.x release series, but is now stabilized. Checkout out our new Visualization Tutorial. More examples and a migration guide will follow later in the Mesa 3.0 development.
- The
mesa.flat
namespace is removed, since was not used very often.
Mesa 3.0 will require Python 3.10+.
This pre-release can be installed with pip install mesa --upgrade --pre
.
- Remove mesa.flat namespace by @rht in projectmesa#2091
- breaking: Remove visualization_old (mesa-viz-tornado) by @rht in projectmesa#2133
- Set JupyterViz as stable by @rht in projectmesa#2090
- Jupyter_viz: Allow measures to be None by @EwoutH in projectmesa#2163
- Jupyter Viz: Don't avoid interactive backend by @EwoutH in projectmesa#2165
- Fix image on landing page of docs. by @jackiekazil in projectmesa#2146
- Replace links in docs - google group to matrix. by @jackiekazil in projectmesa#2148
- Update visualisation docs by @EwoutH in projectmesa#2162
- CI: Add weekly scheduled run to all CI workflows by @EwoutH in projectmesa#2130
- Drop support for Python 3.9, require Python >= 3.10 by @EwoutH in projectmesa#2132
- Add script to list unlabeled PR's since latest release by @rht in projectmesa#2047
- @stephenfmann made their first contribution in projectmesa#2154
Full Changelog: https://github.com/projectmesa/mesa/compare/v2.3.1...v3.0.0a0
Mesa 2.3.2 is a small patch release which fixes two bugs, one to the batch_run function still depending on schedule.steps
, and one in the agent marker visualisation.
- fix: Render agent marker radius correctly by @rht in projectmesa#2181
- fix: Use model.schedule.steps -> mode._steps for batch_run by @rht in projectmesa#2183
Full Changelog: https://github.com/projectmesa/mesa/compare/v2.3.1...v2.3.2
Mesa 2.3.1 is a small patch release with a datacollector bug fixed and improved documentation.
- datacollector: store separate snapshots of model data per step by @EwoutH in projectmesa#2129
- Add experimental features to documentation as per #2122 by @stephenfmann in projectmesa#2154
Full Changelog: https://github.com/projectmesa/mesa/compare/v2.3.0...v2.3.1
Mesa 2.3.0 is a big feature release and the last feature release before 3.0.
There are two main new features:
- The experimental cell-centric discrete spaces, as added in #1994. It allows having cells with not only properties but also active behaviors: the
CellAgent
. Its inspired by NetLogo's patches but extend and generalize this concept further. - Full support for discrete event scheduling, as added in #2066. It allows scheduling events (like Agent actions) at any time, including non-integer timesteps.
There are a lot of other features: The Jupyter visualisation now supports easier way to specify sliders, NetworkGrid.get_neighbors()
supports a radius, AgentSet.get()
can retrieve multiple attributes and there are now benchmarks to track Mesa performance during development.
Finally, 2.3.0 stabilizes the AgentSet
(including model.agents
), making it the first experimental Mesa feature that is taken out of it's experimental phase.
Install this release with:
pip install --upgrade mesa
The Mesa 2.3.x-series supports Python 3.9 to 3.12. The next major release will require Python 3.10.
- Add cell-centric discrete spaces (experimental) by @Corvince in projectmesa#1994
- Add performance benchmarking scripts by @EwoutH in projectmesa#1979
- feat: Implement Slider class for JupyterViz by @rht in projectmesa#1972
- Stabilize AgentSet by @EwoutH in projectmesa#2065
- Support discrete event scheduling by @quaquel in projectmesa#2066
- JupyterViz: Automatically deduce display name from model class by @rht in projectmesa#1975
- Add radius argument to NetworkGrid.get_neighbors() by @EwoutH in projectmesa#1973
- Speedup of Agentset.shuffle by @quaquel in projectmesa#2010
- feat: Let mesa runserver detect server.py as fallback by @rht in projectmesa#2015
- JupyterViz: {Convert make_plot & prepare ColorCard} to become Solara component by @rht in projectmesa#2020
- new feature: AgentSet.get can retrieve one or more then one attribute by @quaquel in projectmesa#2044
- Update CODE_OF_CONDUCT.md to version 2+ of contrib covenant by @jackiekazil in projectmesa#2052
- Improve flocking benchmark by @coderbeta1 in projectmesa#2054
- Remove JupyterViz Altair marker overlap for huge grid size by @rht in projectmesa#2062
- Add tooltip option to Altair chart by @FoFFolo in projectmesa#2082
- feat: Display model seed & allow user to specify it in JupyterViz by @rht in projectmesa#2069
- warn if placing already placed agent by @puer-robustus in projectmesa#2083
- fix: Apply default value to slider by @rht in projectmesa#2016
- fix: Initialize model _steps and _time during new by @rht in projectmesa#2026
- fix: Use model.schedule only when it is not None by @rht in projectmesa#2050
- fix: Remove JupyterViz grid marker overlap for huge grid size by @rht in projectmesa#2049
- Improve readability of badges by @rht in projectmesa#2009
- More pythonic implementation of wolf sheep by @quaquel in projectmesa#2011
- Adding super().init() to MoneyModel tutorial by @sw23 in projectmesa#2025
- docs: Convert howto.rst -> howto.md via rst2myst by @rht in projectmesa#2033
- docs: Convert best-practices,overview,packages,mesa,index to .md via rst2myst by @rht in projectmesa#2034
- docs: Convert api/.rst -> api/.md via rst2myst by @rht in projectmesa#2035
- docs: Rewrite howto.md using ChatGPT for clarity and conciseness by @rht in projectmesa#2037
- docs: Corrected Contributing Guide Link to Ensure Accessibility by @sahusiddharth in projectmesa#2057
- Rename links to internal .rst files to .md by @rht in projectmesa#2058
- docs: improve introductory tutorial by @puer-robustus in projectmesa#2087
- Quality of Life: Make codecov less meticulous by @Corvince in projectmesa#1966
- Add CI workflow for performance benchmarks by @EwoutH in projectmesa#1983
- tests: Resolve warnings by defining PropertyLayer dtypes by @EwoutH in projectmesa#1987
- benchmarks.yml: Fix PR branch checkout when triggered by comment by @EwoutH in projectmesa#1998
- Quality of life: automatically fix ruff errors by @Corvince in projectmesa#2004
- benchmarks.yml: Run on addition of label instead of comment by @EwoutH in projectmesa#2002
- ci: Move codespell to pre-commit by @rht in projectmesa#2040
- Schelling by @coderbeta1 in projectmesa#2053
- Move ruff lint settings into dedicated section by @Corvince in projectmesa#2073
- ci: Use uv pip for faster build by @rht in projectmesa#2038
- test: Remove place_agent duplicate warnings by @rht in projectmesa#2086
- Minor edits to benchmarking code by @quaquel in projectmesa#1985
- build(deps): bump codecov/codecov-action from 3 to 4 by @dependabot in projectmesa#2030
- [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in projectmesa#2029
- tests: Speed up test_batch_run by @rht in projectmesa#2039
- Update benchmarks.yml by @Corvince in projectmesa#2043
- docs: Convert visualization .rst -> .md via rst2myst by @rht in projectmesa#2036
- docs: Convert CONTRIBUTING .rst -> .md via rst2myst by @rht in projectmesa#2041
- Correct wolf energy gained from eating sheep by @JackAtOmenApps in projectmesa#2048
- feat: Implement Altair version of grid visualization by @rht in projectmesa#1991
- @sw23 made their first contribution in projectmesa#2025
- @JackAtOmenApps made their first contribution in projectmesa#2048
- @coderbeta1 made their first contribution in projectmesa#2054
- @sahusiddharth made their first contribution in projectmesa#2057
- @FoFFolo made their first contribution in projectmesa#2082
- @puer-robustus made their first contribution in projectmesa#2083
Full Changelog: https://github.com/projectmesa/mesa/compare/v2.2.4...2.3.0
Mesa 2.3.0-rc1 is pre-release in preparation for 2.3.0 stable. It had the same release notes as 2.3.0.
Mesa v2.2.4 is a small but important bugfix release for the 2.2 release series. It fixes an essential bug in where agents weren't shuffled in the BaseScheduler
, affecting mainly the RandomActivation
scheduler (effectively making it sequential activation)(#2007). It also fixes a small behaviour change in RandomActivationByType.agents_by_type()
(#1996). Furthermore, this release adds an internal clock to the Model
, which allows to use a Mesa model without a scheduler (using the AgentSet
API)(#1942).
Updating from previous 2.2 releases is highly recommended, especially when using the RandomActivation
scheduler.
- refactor: Remove dependence on model.schedule, add clock to Model by @rht in projectmesa#1942
- Fix AgentSet inplace shuffle (and thus RandomActivation), add tests by @EwoutH and @quaquel in projectmesa#2007
- fix: Reverse dict key and value for agents_by_type by @rht in projectmesa#1996
Full Changelog: https://github.com/projectmesa/mesa/compare/v2.2.3...v2.2.4
Mesa 2.2.3 is a small release with two improvements to the experimental Solara visualisation, on request of one of our contributors. No stable features have changed.
- solara_viz: Add borders around ContinuousSpace by @EwoutH in projectmesa#1988
- fix: Explicitly specify JupyterViz space view limits by @rht in projectmesa#1984
Full Changelog: https://github.com/projectmesa/mesa/compare/v2.2.2...v2.2.3
Mesa 2.2.2 is a small bugfix release, for models in which users had defined Model.agents
(self.agents
in a Model (sub)class). This is deprecated, but for now allowed. See #1919 (comment).
- Allow user models to assign
Model.agents
for now, but add warning by @quaquel in #1976
Full Changelog: https://github.com/projectmesa/mesa/compare/v2.2.1...v2.2.2
After the huge 2.2.0 release we are releasing 2.2.1 which addresses a few bugs, unintended behaviors and a performance regression. #1960 makes sure agent addition and removal is handled correct, #1965 fixed an unintended behavior change in RandomActivationByType.agents_by_type
and #1964 makes sure we're at least as fast as before 2.2.0, if not faster. The introduction tutorial is also extended with #1955.
We highly recommend updating to 2.2.1 if you're using 2.2.0.
- jupyter_viz: Implement multiline plot by @rht in projectmesa#1941
- make mesa runable without some dependencies by @Corvince in projectmesa#1950
- Improve performance of AgentSet and iter_cell_list_contents by @Corvince in projectmesa#1964
- Bugfix in agentset to handle addition and removal correctly by @quaquel in projectmesa#1960
- Make RandomActivationByType.agents_by_type backward compatible by @quaquel in projectmesa#1965
- Refer to just Python instead of Python 3 by @rht in projectmesa#1957
- intro tutorial: Analysing model reporters by @EwoutH in projectmesa#1955
- Migrate from setuptools to hatch by @rht in projectmesa#1882
- ci: Add tests for mesa-examples by @rht in projectmesa#1956
- refactor: Move Matplotlib-specific Solara components to separate file by @rht in projectmesa#1943
Full Changelog: https://github.com/projectmesa/mesa/compare/v2.2.0...v2.2.1
The 2.2.0 release of the Mesa library introduces several updates and new features for managing and scheduling agents and modelling the environment, along with an experimental release policy aimed at enhancing development speed and community feedback. Below are key highlights of the new (experimental) features in this release. Mesa 2.2.0 supports Python 3.9+.
Despite the minor version number, this is one of our biggest releases yet.
This release introduces an experimental feature policy aimed at accelerating development and gathering community feedback. Features like #1890, #1898, and #1916 are marked as experimental under this policy.
Policy overview:
- Experimental features can be added or changed in any release, even patch releases.
- They don’t need a diligent review for every change, allowing for quicker development cycles.
- Community feedback is encouraged through discussion threads.
This update introduces a agents
variable to the Mesa Model
class, offering a first step in supporting multiple agent types as first class citizens. Each Model
is now initialized with an self.agents
variable (an AgentSet
) in which all the agents are tracked. You can now always ask which agents are in the model with model.agents
. It's the foundation which will allow us to solve problems with scheduling, data collection and visualisation of multiple agent types in the future.
The new AgentSet
class encapsulates and manages collections of agents, streamlining the process of selecting, sorting, and applying actions to groups of agents.
Key features:
- Flexible and efficient agent management and manipulation.
- Methods like
select
,shuffle
,sort
, anddo
for intuitive operations.
Example:
# Applying a method to each agent
model.agents.do('step')
# Filtering and shuffling agents
shuffled_agents = model.agents.select(lambda agent: agent.attribute > threshold).shuffle()
The AgentSet is an experimental feature. We would love feedback on it in #1919.
The introduction of PropertyLayer
and the extension of SingleGrid
and MultiGrid
classes to support cell properties mark a significant enhancement in Mesa's environmental modeling capabilities. It allows to add different layers of variables to grids, that can be used to represent spatial environmental properties, such as elevation, pollution, flood levels or foliage.
Key features:
- Efficient management of environmental properties like terrain types and resources.
- Dynamic interaction between agents and their environment.
- Fast modification and selection of cells based on one or multiple properties
Example:
from mesa.space import SingleGrid, PropertyLayer
grid = SingleGrid(10, 10, False)
property_layer = PropertyLayer("elevation", 10, 10, default_value=0)
grid.add_property_layer(property_layer)
# Modify multiple cells values
grid.properties["elevation"].modify_cells(np.multiply, 2)
# Select cells that have an elevation of at least 50
high_elevation_cells = grid.properties["elevation"].select_cells(condition=lambda x: x > 50)
The PropertyLayer is an experimental feature. We would love feedback on it in #1932.
The DiscreteEventScheduler
is an innovative addition to the Mesa time module, tailored for discrete event simulations. This scheduler advances simulations based on specific event timings rather than regular intervals, providing more flexibility in modeling complex systems.
Key Features:
- Efficient handling of events scheduled for specific simulation times.
- Randomized execution order for events scheduled at the same time.
The DiscreteEventScheduler is an experimental feature. We would love feedback on it in #1923.
- Native support for multiple agent types by @EwoutH in projectmesa#1894
- space: Implement PropertyLayer and _PropertyGrid by @EwoutH in projectmesa#1898
- Add DiscreteEventScheduler by @EwoutH in projectmesa#1890
- Introduce AgentSet class by @EwoutH in projectmesa#1916
- Reimplement schedulers to use AgentSet by @quaquel in projectmesa#1926
- space: Let move_agent choose from multiple positions by @EwoutH in projectmesa#1920
- Work around for initializing model._agent by @quaquel in projectmesa#1928
- Honor disabled space drawer option when rendering in the browser by @rlskoeser in projectmesa#1907
- Document empties property by @EwoutH in projectmesa#1888
- docs: Fix README.md inline code formatting by @rht in projectmesa#1887
- ci: Speed up pip install by caching deps install output by @rht in projectmesa#1885
- Create release.yml file for automatic release notes generation by @EwoutH in projectmesa#1925
- Drop support for Python 3.8 by @rht in projectmesa#1756
- @quaquel made their first contribution in projectmesa#1928
Full Changelog: https://github.com/projectmesa/mesa/compare/v2.1.5...v2.2.0
This release has some critical fixes to JupyterViz/Solara frontend to prevent flickering and improve the display of the jupyter plots. It also has improvements to datacollection and the documentation.
Improvements
- datacollection: check if model reporters is a partial function (#1872)
Docs and Tutorial
- docs: convert README from
.rst
to.md
(#1881) - docs: convert HISTORY from
.rst
to.md
(#1873) - docs: enhance docstrings for scheduler classes in
mesa.time
(#1866)
CI and WorkFlows
- ci: Remove redundant Ruff workflow from GitHub Actions (#1880)
- Replace Black with ruff format (#1880)
- Migrate setup from
setup.py
topyproject.toml
(#1870)
Solara/JupyterViz
- fix: Do render_in_jupyter on Colab env (#1884)
- Convert make_space into Solara component (#1877)
- remove controls for dragging and resizing (#1878)
- Improve ColorCard layout (#1876)
- refactor: Define current_step as reactive (#1875)
- fix: optimize controller and plots to fill screen in jupyter (#1868)
- fix: ensure space and plot subcomponent are not rendered on step (#1867)
This release updates mesa-viz-tornado dependency v0.1.3. This removes the external JavaScript templates and prevents 404 errors
- bugfix: ensure mesa_viz_tornado>=0.1.3 #1862
This release contains several improvements, fixes, and new features to the JupyterViz/Solara frontend. It's a patch release instead of a minor release because the JupyterViz frontend is still considered experimental.
Improvements
- model: ensure model is initialized with random seed based #1814
- space: check if position values are tuples #1831
- datacollection: add agent collection by type, documentation, and tests #1838
Docs and Tutorial
- tutorial: explain how to set up reporter for multiple agents #1717
- docs: rename useful snippets to how to guide #1839
CI and WorkFlows
- Release CI: update to run workflows on releases #1479
- CI: Update GHA workflows with Python 3.12 #1840
- update ruff version #1824, #1841
- Ensure mesa_viz_tornado>=0.1.2 #1860
Solara/JupyterViz
- perf: increase speed of Solara render #1819
- implement drawer for continuous space and refactor code #1830
- fix: configure change handler for checkbox input #1844
- fix: ensure playing starts after model param change #1851
This release contains fixes, and several improvements and new features to the JupyterViz/Solara frontend. It's a patch release instead of a minor release because the JupyterViz frontend is still considered experimental.
Improvements
- perf: Access grid only once #1751
- docs: compile notebooks at build time #1753
- docs: Remove nbsphinx and explicit .ipynb suffix #1754
- rtd: Use gruvbox-dark as style #1719
- build(deps): bump actions/checkout from 3 to 4 #1790
Solara/JupyterViz
- solara: Implement visualization for network grid #1767
- Add support for select input type #1779
- Add step count display to JupyterViz #1775
- Simplify solara code #1786
- Add docstring for jupyterviz make_user_input that documents supported inputs #1784
- Revise, test, & document JupyterViz options for drawing agent space #1783
- Add UserInputs component #1788
- Fix: Remove dict merge operator, python 3.8 compat #1793
- feat: Add reset button to JupyterViz #1795
- Add support for solara.Checkbox user input #1798
- viz tutorial: Update custom plot to reflect new code #1799
- fix: Don't continue playing when a model is reset #1796
- Docker: Update to use Solara viz #1757
Refactors
- Move viz stuff to mesa-viz-tornado Git repo #1746
- simplify get neighborhood #1760
- remove attrgetter performance optimization #1809
Fixes
- fix: Add Matplotlib as dependency #1747
- fix install for visualization tutorial in colab #1752
- fix: Allow multiple connections in Solara #1759
- Revert "Ensure sphinx>=7" #1762
- fix README pic to remove line on left side #1763
- space: Ensure get_neighborhood output & cache are immutable #1780
- fix: Use .pytemplate for name for cookiecutter #1785
- HISTORY.rst: Correct neighbor_iter() replacement in 2.0.0 #1807
- docs: Always link to stable version #1810
- Remove exclude_none_values #1813
This release improves the introductory and visualization tutorial. Ensures both are Google Colab compatible with working badges.
Changes:
: - Update intro_tutorial
to warn users to ensure up to date
version, and make colab compatible #1739, #1744
- Improve new/experimental Solara based visualization to ensure
pause button works #1745
- Fix bug in space.py
-> get_heading()
#1739
This release creates mesa.experimental
namespace, this solves the
issue that PyPI release will not allow git-based install.
Users should read the Mesa 2.0.0 release note (directly below this), as this contains the details about the breaking changes and other major changes that were part of Mesa 2.0 release.
Changes:
: - Creates mesa.experimental
namespace #1736
- Fix Ruff lint error #1737
- Update permissions for PyPI #1732
Special notes
Mesa 2.0 includes:
: - an experimental pure python user interface/ visualization that
is also jupyter compatible please see the
visualization tutorial
_
- an improved datacollector
that allows collection by agent type
- several breaking changes that provide significant improvements
to Mesa.
Breaking Changes:
-
space: change
coord_iter
to return(content,(x,y))
instead of(content, x,y)
; this reduces known errors of scheduler to grid mismatch #1566, #1723 -
space: change NetworkGrid
get_neighbors
toget_neighborhood
; improves performance #1542 -
space: raise exception when pos is out of bounds in
Grid.get_neighborhood
#1524
space: remove deprecations (#1520, #1687, #1688):
: - `find_empty()`: convert this to `move_to_empty()`
- `num_agents`: removed parameter from `move_to_empty()`
- `position_agent()`: convert this to `place_agent`
- `neighbor_iter()`: convert this to `iter_neighbors()`
batchrunner: remove deprecations #1627
: - `class BatchRunner` and `class BatchRunnerMP`: convert these
to `batch_run()`
- Please see this `batch_run() example`\_ if you would like to
see an an implementation.
visualization: easier visualization creation #1693
: - `UserSettableParameter(['number', 'slider','checkbox', 'choice', 'StaticText'])`:
convert to `NumberInput` , `Slider`, `CheckBox`, `Choice`,
`StaticText`
- Please see this `visualization example`\_ if you would like
to see an implementation.
New Features:
- datacollector: can now handle data collection by agent type #1419, #1702
- time: allows for model level
StageActivation
#1709 - visualization:
ChartModule
can have dynamically named properties #1685 - visualization: improved stop server to end visualizations #1646
- experimental python front end option: integrated the initial prototype of the pure python front end option #1698, #1726
Improvements
-
update HexGrid and create HexSingleGrid and HexMultiGrid #1581
-
correct
get_heading
for toroidal space #1686 -
update slider to start at 1FPS #1674
-
update links to examples repo due to creation of mesa_examples #1636, #1637
** CI Improvements**
: - update Ruff #1724
- remove Pipfile and Pipfile.lock #1692
- enable Codespell in Jupyter #1695
- improve regex for better build #1669, #1671
- exclude notebooks form linter #1670
- updated pip for zsh #1644
- CLI quality of life improvements #1640
**Docs Improvements**
: - update to PyData theme #1699
- remove .rst to create simpler build #1363, #1624
- use seaborn in tutorials #1718
- fix types and errors in docs #1624, #1705, #1706, #1720
- improve tutorials #1636, #1637, #1639, #1641, #1647, #1648,
#1650, #1656, #1658, #1659, #1695, #1697,
- add nbsphinx to adv_tutorial #1694
- replace `const chart` for `var chart` in advanced tutorial
#1679
- update LICENSE to 2023 #1683
This release fixes projectmesa#1606,
where mesa startproject
doesn't work.
Changes:
- fix: Include cookiecutter folders in install content #1611
- Fix Ruff errors and pin Ruff version #1609
- datacollector: Add warning when returning empty dataframe with no reporters defined #1614
Special notes
New features:
- Implement radius for NetworkGrid.get_neighbors #1564
Some highlights for the perf improvements:
- Use getattr for attribute strings in model data collection #1590 this is a 2x speedup over the relevant line
- Faster is_integer function for common cases #1597 is for 1.3x speedup for grid access (grid[x, y])
- Refactor iter/get_cell_list_contents methods #1570 at least 1.3x speedup for iter/get_cell_list_contents
- Evaluate empties set more lazily #1546 (comment) ~1.3x speedup for place_agent, remove_agent, and move_agent
Improvements
-
ci: Add testing on Python 3.11 #1519
-
Remove auto-update GH Actions for Pipfile.lock #1558
ruff
: - ruff: Add isort #1594
- ci: Replace flake8 with Ruff #1587
- ruff: Add more rules based on Zulip\'s config #1596
-
perf: faster is_integer function for common cases #1597
-
Remove _reporter_decorator #1591
-
Change index at DataFrame creation in get_agent_vars_dataframe #1586
-
Make Grid class private #1575
-
Make the internal grid and empties_built in Grid class private #1568
-
Simplify code in ContinuousSpace #1536
-
Improve docstrings of ContinuousSpace #1535
-
Simplify accept_tuple_argument decorator in space.py #1531
-
Enhance schedulers to support intra-step removal of agents #1523
-
perf: Refactor iter_cell_list_contents Performance #1527
-
Replace two loops with dictionary comprehension, list- with generator comprehension #1458
-
Make MultiGrid.place_agent faster #1508
-
Update space module-level docstring summary #1518
-
Update NetworkGrid.__init__ docstring #1514
-
Deprecate SingleGrid.position_agent #1512
-
Make swap_pos part of Grid instead of SingleGrid #1507
-
Refactor NetworkGrid docstrings and iter/get_cell_list_contents #1498
-
Hexgrid: use get_neighborhood in iter_neighbors #1504
-
Auto update year for copyright in docs #1503
-
Refactor Grid.move_to_empty #1482
-
Put "Mesa" instead of "it" in README #1490
-
Batchrunner: Remove unnecessary dict transformation, .keys() in len() #1460
-
Add Dependabot configuration for GitHub Actions update check #1480
-
Use list transformation only when shuffled is True #1478
-
Implement swap_pos #1474
-
Clean up DataCollector #1475
Fixes
-
Update resources in README #1605
-
Fix accident from projectmesa#1488 #1489
-
pre-commit autoupdate #1598, #1576, #1548, #1494
-
Fix docstring of DataCollector #1592
-
Update Pipfile.lock (dependencies) #1495 #1487
build(deps):
: - build(deps): bump codecov/codecov-action from 2 to 3
dependencies Pull requests that update a dependency file
#1486
- build(deps): bump actions/upload-artifact from 2 to 3
dependencies Pull requests that update a dependency file
#1485
- build(deps): bump peter-evans/create-pull-request from 3 to
4 dependencies Pull requests that update a dependency file
#1484
- build(deps): bump actions/setup-python from 3 to 4
dependencies Pull requests that update a dependency file
#1483
-
Establish reproducibility for NetworkGrid.get_neighbors when radius > 1 #1569
-
Format js code #1554
-
Add some missing const declarations #1549
-
fix tutorial url in examples #1538
-
Update cookiecutter to flat import style. #1525
-
Fix bug in Grid.get_neighborhood #1517
-
Revert changes of #1478 and #1456 #1516
-
Fix return types of some NetworkGrid methods #1505
-
Update year for copyright #1501
-
Add default_value function to NetworkGrid #1497
-
Remove extraneous spaces from docstrings in modules 2 #1496
-
Remove extraneous spaces from docstrings in modules #1493
-
SingleGrid: Remove extraneous attribute declaration (empties) #1491
This release fixes projectmesa#1461 where custom user-specified portrayal images don't load in the visualization server.
Special notes
- Perf: ContinuousSpace: speed-up add/remove agents #1376. This is a ~6x performance improvement for add/remove.
- fix: time: Recompute agent_keys between stages #1391. This is a
correctness fix for
SimultaneousActivation
andStagedActivation
when agents are being removed during simulation. - ModularServer: Always set model.running = True on reset #1399. With
this change, specifying
self.running = True
in your model__init__
is now optional. Mesa's visualization server will automatically sets it toTrue
in the beginning of a simulation. - feat: Allow user-specified local dir to be served by Tornado #1435.
This simplifies the usage of
ModularServer
in Mesa-Geo. - Allow batch_run to take arbitrary parameters #1413. With this
change, you can finally use any arbitrary Python objects as
batch_run
parameters, where previously they are restricted to hashable objects only. - Prevent seed and random from being shared between instances #1439. With this fix, a model instance has their own isolated RNG.
Improvements
CI Updates
: - ci: Cancel previous obsolete runs #1378
- ci: update black to prevent click error #1382
- Add \"falsy\" to .codespellignore #1412
- Upgrade pre-commit CI (with pyupgrade and syntax checks)
#1422
Tests
: - test: RandomActivationByType: Test adding agents with
duplicate ID #1392
Dependency updates
: - Update Pipfile.lock (dependencies) #1398
- Update Pipfile.lock (dependencies) #1408
- Update Pipfile.lock (dependencies) #1434
Docs
: - docs: Add Tim Pope\'s guideline for proper Git commit msg
#1379
- readme: Improve the pip install for Git repo instruction
#1416
- Docs: Remove trailing whitespaces #1421
- Fixes #1423 - fixes build badge in docs #1424
Refactors
: - refactor: Apply pyupgrade \--py37-plus #1429
- refactor ModularServer (moving code into \_\_init\_\_) #1403
-
Perf: ContinuousSpace: speed-up add/remove agents #1376
-
Remove monospace formatting for hyperlinks #1388
-
ModularServer: Always set model.running = True on reset #1399
-
Allow batch_run to take arbitrary parameters #1413
-
ModularServer: Put new optional arg port last #1432
-
feat: Allow user-specified local dir to be served by Tornado #1435
-
Improve and measure speed of clamp function #1440
Fixes
- Fix stray " in modular_template.html #1380
- Fix zoom on network visualisation #1381
- Fix broken monospace links #1387
- fix: Ensure agent id is unique in RandomActivationByType.add #1386
- fix: time: Recompute agent_keys between stages #1391
- Fix batchrunner progress bar #1395
- Fix stray " in visualisation dropdown labels #1409
- space: Fix type error for Python < 3.9 #1430
- Prevent seed and random from being shared between instances #1439
Special notes
- BREAKING: Rename mesa.visualizations.TextVisualization.TextElement to ASCIIElement
- POTENTIALLY BREAKING: Default batch_run to 1 CPU #1300
- Simplified namespace implements - see Improvements section.
Improvements
Implement simplified namespace
: - docs: simplified namespace tutorial update #1361
- examples: Convert shape_example, sugarscape_cg,
virus_on_network, wolf_sheep to simple namespace #1339
- Convert hex_snowflake, pd_grid, schelling to simple
namespace; \[BREAKING\] Remove class name collision #1333
- examples: Convert color_patches, conways_game_of_life,
epstein_civil_violence, forest_fire to simple namespace
#1331
- Examples: Convert boltzmann_wealth_model_network and chart
to simple namespace #1322
- examples: Convert boid_flockers, boltzmann_wealth_model to
simple namespace #1321
- examples: Convert bank_reserves to simple namespace #1317
- add batch_run to simple namespace #1316
- Implement simpler Mesa namespace #1294
mypy
: - mypy: Use \"\|\" operator instead of Union/Optional #1345
- mypy: Improve space.py annotation, part 2 #1219
- mypy: Improve annotations #1212
Userparam class updates
: - feat: Implement NumberInput UserParam class #1343
- feat: Implement StaticText UserParam #1342
- feat: Implement Choice UserParam class #1338
- feat: Implement Checkbox UserParam class #1332
-
feat: Implement Slider UserParam class #1272
: - examples: Convert to using Slider UserParam class
#1340
Front-end updates
: - frontend: Add alignment options to agent portrayals in
CanvasGridVisualization #1349
- frontend: Update Bootstrap 4.6.1 -\> 5.1.3 #1325
- ChartModule.js: Use more semantic HTML element creation
method #1319
- Issue #1232; Replaced usage of var to const/let in some
files #1248
- \[Issue 1232\] Refactor NetworkModuleSigma PieChartModule
TextModule JS #1246
- js: Update D3 from 4.13.0 to 7.4.3 #1270
- support package and local css includes #1283
- Upgrade to Bootstrap 4! #1282
- refactor: update var to const/let in InteractionHandler.js
#1273
- Change remaining vendored JS dependencies to be downloaded
during install #1268
- Download jQuery and D3 during install #1260
- CSS support for custom visualization element #1267
- style: prettify js files #1266
- refactor: Change var to const/let for remaining js files
#1265
- Remove NetworkModule_sigma and its dependencies #1262
- js: Download bootstrap-slider during install #1257
- js deps: Move Bootstrap to be inside external folder #1236
- Apply prettier to NetworkModule_d3.js #1225
- js: Download Bootstrap on-the-fly during install instead
#1220
- Install JS dependencies using Fanstatic #1195
-
JQuery updates
: - examples: Remove all usage of jQuery #1356
- Remove jQuery dependency completely #1355
- refactor: frontend: Remove remaining usage of jQuery
#1351
- refactor: frontend: Remove usage of jQuery for most
of the JS code #1348
- refactor: frontend: Remove jQuery usage in
CanvasHexModule.js & CanvasModule.js #1347
- refactor: frontend: Remove jQuery usage in
BarChartModule.js #1326
- visualization: Specify tooltip without jQuery #1308
CI Updates
: - ci: Ensure wheel is install before pip install step #1312
- Fix contributing (increasing black version) #1303
- ci: Disable PyPy for now #1254
- CI: Update checkout, setup-python and cache actions to v3
#1217
- CI: Split off codespell job, don\'t run build on doc changes
#1170
- ci: Add 6 min timeout for the test jobs #1194
- CI: test flake: batch runner sometimes takes 6 hours then
gets killed by GitHub Actions #1166
- ci: Enable cache for all Python versions 🇺🇦 #1177
- CI: Create Action to publish to PyPI on release #1169
- CI: Python 3.6 should be removed because it has reached EOL
#1165
- Update Black formatting (no spaces for power operator) #1160
- Improve code quality with static analysis #1328
- CI test: Increase timeout to 10 minutes #1250
Dependency updates
: - build(deps): bump cookiecutter from 2.1.0 to 2.1.1
dependencies #1360
- Update Pipfile.lock (dependencies) #1374, #1350, #1301,
#1224, #1203, #1135 by github-actions bot
- Migrate D3 from v4 to v7 #1088
Other Improvements
: - feat: Implement auto-conversion of function to TextElement
#1346
- Readme: Add Matrix badge and description #1164
- examples: Convert nodes to list when drawing random
sample#1330
- examples: Use nicer color for bank_reserves #1324
- examples: Use nicer color for chart #1323
- model: Implement initialize_data_collector #1287
- CONTRIBUTING: Add instruction to enable git pull autorebase
#1298
- Improve MANIFEST.in #1281
- refactor: Merge \_remove_agent into remove_agent #1245
- examples: Remove usage of internal method \_remove_agent
#1241
- refactor: Make \_place_agent args consistent with
place_agent #1240
- Redirect user to GH discussions for seeking help #1237
- setup.py: Update setup classifiers and add python_requires
for Python\>=3.7 #1215
- The tutorial.rst doesn\'t mention that the Pandas DataFrame
output can be in CSV #1148
- Deprecate neighbor_iter in favor of iter_neighbors #1184
- Add snippet about using numpy\'s random #1204
- docs: make windows multiprocessing code appear #1201
- Capitalize CSV whenever applicable #1200
- update intro tutorial for pandas and CSV and batch_run and
windows #1196
- docker-compose.yml: Make it consistent with Dockerfile #1197
- Improve Dockerfile #1193
- update to include Matrix and GitHub discussion links #1179
- Update docs to remove old discussion forums #1171
- Add \"Grass\" curve to wolf_sheep example chart #1178
- feat: Implement random activation by type #1162
Fixes
-
Git tags out of sync with conda and PyPi (0.8.8 and 0.8.9 missing on git) #1076
-
fix: Remove mesa.visualization.Number #1352
-
CI: the "install dependencies" step is slow #1163
Readme related
: - readme: Clarify/Update Docker instruction #1222, #1214
- Readme: Fix links to docs #1205
-
Add mesa/visualization/templates/js/external to gitignore #1320
-
fix: sugarscape_cg: Use better way to check if a cell is occupied by SsAgent #1313
-
fix double multiply of iterations in singleprocess #1310
-
pre-commit: fix required python version, correct example commit messa... #1302
-
fix: Make bank_reserves batch_run example work #1293
-
Fixes #498. Replaces canvas_width with grid_rows to fill out color patches 3 - Accept easy task!!! #989
-
update pre-commit to include jupyter; fix warning #1190
-
fix: Grid.__getitem__: Handle Numpy integers #1181
-
fix: Make argument order in example models consistent #1176
-
issue template: Linkify discussions url #1239
-
batch_run: Do not iterate values when it is a single string #1289
-
examples: Clarify install instruction in wolf_sheep #1275
-
test: Disable batchrunnerMP (CI: test flake: batch runner sometimes takes 6 hours then gets killed by GitHub Actions #1166) #1256
-
examples: correcting comment in examples/pd_grid/pd_grid/agent.py #1247
-
space: Clarify the return object of get_cell_list_contents #1242
-
width and height were changed up #1149
-
fix typo in best-practices.rst #1368
-
fix: examples: Make space x, y order consistent #1366
Improvements
-
Update number_processes and associated docs #1141
-
[PERF] Improve move_to_empty performance #1116
-
Adding logic to check whether there is agent data #1115
-
Convert all text strings to f-strings #1099
-
Format Python and Jupyter Notebook files with Black #1078
-
README: Add info on how to cite Mesa #1046
-
Re-Implementation of BatchRunner #924
CI Related
: - CI: Add workflow to update Pipfile.lock every month #1018
- CI: Lint typos with Codespell #1098
- CI: Only run Codecov on Ubuntu jobs and update to v2 #1083
- CI: Maintenance: Update to Python 3.10, split of lint jobs
#1074
Dependency updates
: - Updates to Pipfile.lock (dependencies) #1114, #1086, #1080
- Update Pipfile to use Python 3.9 #1075
- Update Chart.js to 3.6.1 (v3) #1087
- Update Chart.js to version 2.9.4 #1084
- Pyupgrade 3.6: Update syntax with Python 3.6+ features #1105
- Bump urllib3 from 1.26.2 to 1.26.5 #1043
- Update packages.rst #1068
Docs
: - Update docs/README.md #1118
- Update number_processes and associated docs #1141
- Update section \'Batch Run\' of introductory tutorial #1119
- Readme: Add command to install specific branch #1111
- Docs: Add back some comments in space.py #1091
- Docs: Remove trailing white spaces #1106
- Update intro_tutorial.rst #1097, #1095
- Tweaking and improving the documentation #1072
Fixes
-
Rename i_steps -> data_collection_period and add docstring #1120
-
bank_reserves: Say that the commented out legacy code is for comparison #1110
-
Fix broken image on PyPI #1071
Docs
: - Fix numbering typos in docs/README.md #1117
- Readme: Fix command for installing custom branch on fork
#1144
- Docs: space.py: Fix single case of neighbor spelled as
neighbour #1090
Note: Master branch was renamed to Main on 03/13/2021
Improvements
Master to Main change:
: - Docs/examples: Update links to use main instead of master as
branch #1012
- CI: Run on pushed to main and release branches #1011
Github Actions
: - GitHub Actions: run black only on ubuntu 3.8 #996
- GA: Only run CI when pushed to master #974
- GA: Add pypy3 #972
- rename github action to \"build\", remove redundant flake8
check #971
- GA: Run on Windows and macOS #970
- Add GitHub Action for continuous integration testing #966
-
[PERF] Add neighborhood cache to grids and improve iter_cell_list_contents #823
-
forest_fire: Remove unnecessary code #981
-
Migrate away from type comments #984
-
Update License #985
-
Public remove_agent function for NetworkGrid #1001
-
Date update to release #962
-
Advanced indexing of grid #820
Fixes
- Correct spelling #999
- Update Pipfile.lock #983
- Fix order of variable_params in model and agent vars data frames #979
- Fix asyncio on windows with python 3.6 #973
Note: This is the last version to support Python 3.5.
Improvements
- Added pre-commit to automatically maintain a standard formatting with black #732
Fixes
-
MultiGrid: Set to using list for cell content #783
Docs
: - Fixed broken link to templates list in advanced tutorial.
#833
- Fixed image links in rst #838
- Cleaned html to attempt correct build #839
- Fixed links on Boltzmann model #843
- Documentation update - batchrunner & data collector #870
- Deleted readthedocs.yml #946
- Doc builds #837, #840, #844, #941, #942
-
Fixed bulleted list in contribution read me #836
-
Updated test_examples.py, changed unused generator expression to actually run the models. #829
-
Fixed #827 issue (example Epstein Civil Violence Jupyter Notebook typos) #828
-
Eliminated Ipython3 references #841
-
Fixed cookie cutter Fixes #850. #853
-
Removed relative imports -- fix #855. #863
-
Updated pytest requirement to fix issues on travis #864
-
Made linux compatible - travis #886
-
Fixed python 3.5 fails, boid failure #889, #898
-
Travis: Removed python 3.5 #899
-
Fixed example testing issues close multiprocess pools #890
-
Used ordered dict to make compatible with python 3.5 #892
-
Increased number of test to fix codecov patch #916
-
Fixed for #919, adding an exception for duplicate ids. #920
Batchrunner
: - Batch runner redux #917
- Fixed empty/None `variable_parameters` argument to
BatchRunner (#861) #862
- Added ordereddict to BatchrunerMP for python 3.5 #893
- Fixed python 3.5 fails bathrunnerMP (multiple tries) #897,
#896, #895
- Batchrunner_redux fixes #928
-
Fixed variables names, mp function locations, datacollector #933
-
ModularServer updated: Fix EventLoop and changes to default port #936
-
Ran black 20.8b1, which formats docstrings #951
Improvements
-
Enable BatchRunner to run specified set of parameter combinations #651 (#607)
-
Restructured runcontrol.js #661
-
Add pipenv support for mesa #678
-
Increase test coverage and change to codecov #692
-
Updates Travis to explicitly set the dist to be Xenial #699
-
time: Remove resolved TODO on random seed of random scheduler #708
-
hex_snowflake: Update description to be more informative #712
-
Added Coverall to Codecov in Contributing file #734
-
Makes opening the browser optional when launching the server #755 #754
-
NetworkGrid: Update to networkx 2.4 API #763
-
Apply black to mesa/ directory #775
-
Updated travis to 3.8 and updated gitignore #777
-
Add information (to docstring) on image as agent portrayal shape #791
-
Change grid empties from list to set #649 (improves speed)
Adding mypy annotation
: - space: Add type annotation to Grid class #779
- add Mypy annotation to time, agent, and model #792
- space: Add mypy annotation to the remaining
methods/functions #796
Docs related
: - Bulk merge of docs from \'docs\' to \'master\' #684
-
Created useful snippets code section in the docs #668 #669
: - Updating index.rst #672
- Clarify runserver snippet in index.rst #682
- Add documentation for feature (pipenv) added in #678 #683
-
Add docs for BatchRunner to support Variable and Fixed Parameter Contribution #679 #683
: - Resources #651 in docs branch #691. This preps for
#683 to be merged.
- intro tutorial: Clarify a function that is not defined in
the class #705
- Updates formatting the readme Docs markdown #737
Examples related
: - Schelling: Separate text-only viz into run_ascii.py #706
- examples/Readme.md: Update description to be consistent with
the folder names #707
Fixes
-
Fixes link to update code coverage module - Updates Removing last link to coveralls and replacing to codecoverage #748
-
Fixes D3 Network Visualization to update (rather than overwrite) #765 #767
-
Fix parameter order in initializing SingleGrid object #770 #769
-
Updating pipenv link #773
-
Fixed pip install from github by specifying egg #802
Compatibility fixes
: - Fixes VisualizationServer to be compatible with recent
versions of Tornado #655
- Fixes #749 networkx incompatibility #750
Fixing typos
: - Fixes documentation typos in example code #695 #696
- Fixes typo in ModularServer\'s last parameter #711
- Fixed typo in BarChartModule line 100 #747
- Fix typo in documentation #809
Doc fixes (not relating to typos)
: - Update tutorial to point to correct repo location #671 #670
- Updating sphinx and reverting issues #674 #675 #677 #681
- Fixes code blocks that weren\'t showing up in the tutorial
#686
- Remove figure from advanced tutorial showing the empty
visualization #729
- Removes git clone from tutorial - Update intro_tutorial.rst
#730
- Fixes citation links in docs tutorial section #736
- Fix histogram in advanced tutorial #794 #610
- Fixes Advanced Tutorial #elements #804 #803
Fixes to examples
: - Fixing test_random_walk bug - wolf sheep. #821
- Fixes shape_example server launch #762 #756
- Fixing broken table in pd_grid example #824
Improvements
- add docker-compose + Dockerfile support #593
- install: Remove jupyter requirement #614
- Add Bar and Pie Chart visualization #594 #490
- Make models pickleable #582
Fixes
- Year update. Happy New Year! #613
- Fixed problem with grid and chart visualization javascript #612 #615
- removed extra" .random" on line 178. #654
- updated requirement for networkx #644 #646
- Fix VisualizationServer to be compatible with recent versions of Tornado #655
Improvements
- Added mouse interactionHandler to close #457, fixed hexgrid drawLines #465
- Run examples as part of the tests #529, #564
- Add a github issue template. #560
- Changes nose to pytest #561
- Update and clean up cookiecutter layout #563
- Updating setup to move requirements to setup.py. #566
- Fixes #570 removed and updated stale comments in space.py #571
- Adding model random number generator with __new__ #572
- Faster agent attribute collection #576
- Update install command to be edible #578
- Adding read the docs yml. #579
- agents can be removed and added during Scheduler.step() #584
- Adding a description to bank_reserves. #587
- F8 cleanup #600
Fixes
- Fixes #543 (User Settable Parameters fail to work for non-string datatype #543) #544
- Adding missing requirements files to examples. #550
- Fixes issue #548, flockers visualization not showing up #548
- updated BatchRunner (throwing error when passing in agent reporters) #556
- Removing version numbers and fixing flake8 issues. #562
- Fix issue #548 (Flockers visualization is not working) #566
- Fixes code formatting in readmes. #577
- Batchrunner.fix (BatchRunner's "variable parameters" is not strictly optional) #596
Improvements
- Mesa Packages docs created (#464, #480, #484, #503, #504)
- Change size and tooltip text of nodes in D3 network visualization #468
- Multiprocessing BatchRunner with pathos #506
- Schedule.agent.dict - Implement tracking the agents in the scheduler via OrderedDict #510
- Use click and add
mesa run
#522 - Add a code of conduct #530
Fixes
- iter_neighborhood() now gives correct neighborhoods for both von Neumann and Moore #459
- fix typo #461
- Flockers update & subsequent "F" versus "f" fix on Unix/Mac - #477, #518, #525, #500
- Fixing date on release. #453
- Batchrunner fixes: properly initialize models with correct parameters during subsequent runs. #486
- Tornado Version Bug Fixes (upgrading #489, downgrading #497, adding to setup.py #527)
- fix minor flake8 issues #519
- align required dependencies between setup.py and requirements.txt #523, #528, #535
- Fixes #499 grid size issue. #539
Improvements
- Datacollector fix #445
- A first network grid model with visualization, using NetworkX and sigma.js #388
- Cache pip packages for Travis setup #427
- Remove localhost hardcoding + allow secure sockets #421
- Update Chart.js to version 2.7.1 #401
- Bank reserves example #432
- Extended Grid to support hexagonal grids #409
Fixes
- Faster ContinuousSpace neighbor search #439
- Updating license year to 2018 #450
- Updating language on license in contributing file #446
- Updating license year to 2018 #450
- Removed mutable defaults from DataCollector constructor #434
- [BUGFIX] Torus adjustment in Grid class #429
- Batchrunfixedparameters #423
- [BUGFIX] Fix sidebar visibility in Edge #436
- Updating Travis svg to target #master, not branches. #343
- Email list language updates and link updates #399
- Fix math problems in flockers; use numpy in space #378
- Only start tornado ioloop if necessary #339
- ContinuousSpace: Fix get_distance calculation on toroidal boundary condition #430
Improvements
- Split parameter_values into fixed & variable parameters in batchrunner #393
Fixes
-
Updating License year to 2017 -- very minor update #391
-
Flockers: fix param naming #398
-
Remove unused class parameters. #400
-
[hotfix!] Disable e2e viz test for now. #414
Fixing bug in release process. \[6a8ecb6\]
: - See <https://github.com/pypa/pypi-legacy/issues/670>.
Improvements
-
Bootstrap UI starter #383
-
Add Sugarscape Constant Growback example #385
-
Add best-practices document and describe models. #371
Refactored & model standards related:
: - Prisoner\'s Dilemma refactor to meet new model standard
format. #377
- refactored boltzmann wealth model to new layout #376
- Update tutorial to follow new model standards #370
- Moving wolf sheep pngs to sub-folder for better organization
#372
- Add best-practices document and describe models. #371
-
Modified loop over agents in schedule step method #356
-
Added function to use local images as shapes in GridDraw #355
Fixes
- Fix math problems in flockers; use numpy in space #378
- Seed both global random number generators #373, #368
- Dictionary parameters fix #309
- Downgrade setuptools to fix #353
- Minor forest fire fix #338, #346
- Allow fixed seed for replication #107
- Fix tutorial and example readme for port change 8b57aa
Improvements
- Updating contribution file to prevent future travis breaks #336
- Updating Travis svg to target #master, not branches. #343
- implement "end" message in visualization #346
- Move empty-cell functions to baseclass Grid #349
Fixes
- Only start tornado ioloop if necessary #339
- fix boundaries of ContinousSpace #345
Improvements
- Fixes #324 -- renames all examples to be the pythonic format of naming #328
- Changing to port 8521, fixes #320. #321
- Opens a browser window when launching the server #323
- Ticket #314 - added progress bar to BatchRunner #316
- Auto update year for copyright. #329
Fixes
- Minor bug fixes - Update ForestFire example notebook to new API, and rename Basic to Shape Example. #318
- On-demand model stepping rather than an endless buffer #310
- Updating contribution to prevent future travis breaks #330
Improvements
- Fixes - variable name heading0/1 in ArrowHead shape is not intuitive. #295 #301
- Fixes - ArrowHead shape is not reflecting in the docs of api #300 #301
- Fixes - Documentation is not reflecting latest changes wrt width-height argument order in Grid() #296 #301
Theme: Scipy Sprints 2016 ( '-')人(゚_゚ ) & Then some.
Feature adds
- Add new shapes & direction indication in CanvasGrid #285
- Provides support for text overlay on Circle and Rectangle shapes. #265
Improvements
- Fixes Parameters of CanvasGrid(): row, col, height, width inverted #285
- Fixes 'coordinates on grid are used inconsistently throughout the code' #285
- Moves Agent and Model class outside of __init__.py #285
- Minor pep updates to boltzmann. #269
- Fix link to intro tutorial. #267
- Updating template text visualization/ModularVisualization.md #273
- Update intro_notebook and documents to include self.running = True in MoneyModel #275
- Update .rst file location to make sure ReadTheDocs works correctly #276
- Remove Mock code causing recursion and preventing build of docs. #281
- MultiGrid docstring missing methods #282
- No Docstring for model.grid.get_cell_list_contents #282
- Refactor forest fire example #223 #288
- Updating kernel version on forest fire model. #290
- Making examples pep complaint. fixes #270 #291
- Fixed pep8 examples and #292 #294
- Fixes #283 - Fixes formatting on viz readme #299
- Have Agent use self.model instead of passing it around #297
Pre-sprints
- Update of tutorial files and docs #176, #172
- Adds np.int64() functions around some variables to get rid error caused by numpy update #188
- Made examples Readme.md more readable #189
From PyCon Sprints
- Updating model example readmes #207
- Added nose to requirements #208
- Updated link on style google style guide #209
- Reset visualization when websocket connection is opened #210
- Remove unused scipy dependency #211
- Introduce a requirements.txt for the tutorial. #212
- Remove references to running in tutorial #213
- Simplify travis.yml; add python versions #215
- Update Flocker Readme.md #216
- Syntax error in .rst was swallowing a code block #217
- Fixup HistogramModule in the tutorial. #218
- add more test coverage to time #221
- add a requirements.txt for WolfSheep. #222
- add a requirements.txt for Schelling. #224
- Refactor color patches example #227
- Ignored _build sphinx docs still in repo #228
- Intro Tut completely in ipynb #230
- pass optional port parameter to ModularServer.launch #231
- open vis immediately when running color patches #232
- Adds .DS_store to .gitignore #237
- Documentation Update #240
- Small fix for reading links #241
- Test batchrunner #243
- clean up TextVisualization #245
- Documentation Update #250
- Update Game of Life example to new format #253
- Update Flockers example to new format #254
- Update Epstein model to new layout #255
- Subclassing object is unnecessary in Python 3 #258
Post PyCon Sprints
- Adds a copy of jquery directly into the code. #261
- #184 Adding terminal echo for server launch to signal person running the model
- #183 Adding Conway's Game of Life simulation to the examples.
- #170 Adding multi-stage activation
- #169 Wolf-Sheep Cleanup
- Updates requirements to latest libraries
Improvements
- Allow cell_list_content methods in Grids to accept single tuples in addition to lists
Theme: Scipy Sprints ( '-')人(゚_゚ )
Improvements
- Standardizes the arguments passed to spatial functions to only tuples, not separate x and y coordinates. (Breaks backwards compatibility)
0.6.5.1 (2015-07-11) ++++++++++++++++++
Theme: Scipy Sprints ( '-')人(゚_゚ )
Improvements
- Adding version, license, copyright, title to __init__.py
- Auto updating version in setup.py
Fixes
- Updating MANIFEST.in to include visualization templates that were missing.
Theme: Scipy Sprints ( '-')人(゚_゚ )
Edits
- Additions to tutorial doc
- Minor edits to README & Intro
- Minor edits / clean up to setup.py
- Removing .ipynb_checkpoints
- Removing out-of-date planning documentation.
Fixes
- Use setuptools' find_packages function to get the list of packages to install, fixes #141
Improvements
- Use package_data for include the web files
- Use a MANIFEST.in file to include the LICENSE file in source distributions
- Using conda on Travis allows much faster builds and test runs
-
Improvement: Adding continuous space.
-
Improvement: Adding a simultaneous activation scheduler.
New models:
: - Flockers
- Spatial Demographic Prisoner\'s Dilemma (PD_Grid)
- Fixes: Order of operations reversed: agent is removed first and then it is placed.
- Improvement:
LICENSE
_ was updates from MIT to Apache 2.0.
- Improvement: Add modular server feature, which breaks up a model into a .py file and a .js file. This breaks backwards compatibility.
Code that is pre-0.6.0 is very unstable.
Our initial release was 0.5.0 (2014-11).
It included code for placing agents on a grid; a data collector and batch runner; and a front-end visualization using HTML 5 and JavaScript.
General
- Objects create -- Agent, Time, Space
- Project moved to Python 3
- Tornado server setup
Front-end
- Front-end grid implemented
- ASCII visualization implemented
Examples models
- Forest Fire
- Schelling
- Wolf-Sheep Predation
0.1.0 (2014-09-19)
- A conversation
- Birth