Skip to content

Commit 3c4f884

Browse files
authored
Update release notes and version for 0.9.0a0 (#253)
* Update release notes and version for 0.9.0a0 * Readme: Mention how you can install pre-releases
1 parent 397fa42 commit 3c4f884

File tree

3 files changed

+57
-6
lines changed

3 files changed

+57
-6
lines changed

HISTORY.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,54 @@
11
Release History
22
---------------
3+
# 0.9.0a0 (2024-09-27)
4+
## Highlights
5+
The Mesa-geo `v0.9.0a0` pre-release is the first Mesa-geo version compatible with Mesa 3.0.
6+
7+
One of the most notable changes is the automatic assignment of unique IDs to agents. This eliminates the need for manual ID specification, simplifying agent creation. For example, where you previously might have initialized an agent with:
8+
9+
```python
10+
agent = MyGeoAgent(unique_id=1, model=model, geometry=point, crs="EPSG:4326")
11+
```
12+
13+
You now simply omit the `unique_id`:
14+
15+
```python
16+
agent = MyGeoAgent(model=model, geometry=point, crs="EPSG:4326")
17+
```
18+
19+
Mesa-geo can now directly use Mesa 3.0's SolaraViz visualisation, with an additional `make_geospace_leaflet` method to support geospaces. The new visualization can be used like:
20+
21+
```python
22+
from mesa.visualization import SolaraViz
23+
import mesa_geo.visualization as mgv
24+
25+
model = GeoSIR()
26+
SolaraViz(
27+
model,
28+
name="GeoSIR",
29+
components=[
30+
mgv.make_geospace_leaflet(SIR_draw, zoom=12, scroll_wheel_zoom=False),
31+
mesa.visualization.make_plot_measure(["infected", "susceptible", "recovered", "dead"]),
32+
mesa.visualization.make_plot_measure(["safe", "hotspot"]),
33+
]
34+
)
35+
```
36+
37+
The `v0.9.0a0` pre-release is a snapshot release to allow starting testing against Mesa 3.0, and might introduce new breaking changes in upcoming (pre-)releases.
38+
39+
## What's Changed
40+
### ⚠️ Breaking changes
41+
* Require Mesa 3.0 by @EwoutH in https://github.com/projectmesa/mesa-geo/pull/244
42+
* Automatically assign unique_id's by @EwoutH in https://github.com/projectmesa/mesa-geo/pull/248
43+
### 🛠 Enhancements made
44+
* add method to make geospace as a solara component by @wang-boyu in https://github.com/projectmesa/mesa-geo/pull/246
45+
### 🐛 Bugs fixed
46+
* raster_layer: Don't pass unique_id to Agent in Cell by @EwoutH in https://github.com/projectmesa/mesa-geo/pull/249
47+
### 📜 Documentation improvements
48+
* Readthedocs: Don't let notebook failures pass silently by @EwoutH in https://github.com/projectmesa/mesa-geo/pull/250
49+
* intro tutorial: Remove unique_id from Agent init by @EwoutH in https://github.com/projectmesa/mesa-geo/pull/251
50+
51+
**Full Changelog**: https://github.com/projectmesa/mesa-geo/compare/v0.8.1...v0.9.0a0
352

453
# 0.8.1 (2024-09-03)
554
## Highlights

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,22 @@ Mesa-Geo implements a `GeoSpace` that can host GIS-based `GeoAgents`, which are
1111

1212
## Using Mesa-Geo
1313

14-
To install Mesa-Geo, run
14+
To install Mesa-Geo, run:
15+
```bash
16+
pip install -U mesa-geo
17+
```
1518

19+
Mesa-Geo pre-releases can be installed with:
1620
```bash
17-
pip install mesa-geo
21+
pip install -U --pre mesa-geo
1822
```
1923

2024
You can also use `pip` to install the GitHub version:
21-
2225
```bash
23-
pip install -e git+https://github.com/projectmesa/mesa-geo.git#egg=mesa-geo
26+
pip install -U -e git+https://github.com/projectmesa/mesa-geo.git#egg=mesa-geo
2427
```
2528

2629
Or any other (development) branch on this repo or your own fork:
27-
2830
``` bash
2931
pip install -U -e git+https://github.com/YOUR_FORK/mesa-geo@YOUR_BRANCH#egg=mesa-geo
3032
```

mesa_geo/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
]
2525

2626
__title__ = "Mesa-Geo"
27-
__version__ = "0.9.0-dev"
27+
__version__ = "0.9.0a0"
2828
__license__ = "Apache 2.0"
2929
_this_year = datetime.datetime.now(tz=datetime.timezone.utc).date().year
3030
__copyright__ = f"Copyright {_this_year} Project Mesa Team"

0 commit comments

Comments
 (0)