Skip to content

Commit 8e0ba9e

Browse files
rhttpike3
authored andcommitted
Update README to describe mesa_models and experimental feature
1 parent a110532 commit 8e0ba9e

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,17 @@
22

33
This repository contains examples that work with Mesa and illustrate different features of Mesa.
44

5-
To contribute to this repository, see `CONTRIBUTING.rst`_
5+
To contribute to this repository, see [CONTRIBUTING.rst](https://github.com/projectmesa/mesa-examples/blob/main/CONTRIBUTING.rst).
66

7-
.. _`CONTRIBUTING.rst` : https://github.com/projectmesa/mesa-examples/blob/main/CONTRIBUTING.rst
7+
This repo also contains a package that readily lets you import and run some of the examples:
8+
```console
9+
$ # This will install the "mesa_models" package
10+
$ pip install git+https://github.com/projectmesa/mesa-examples
11+
```
12+
```python
13+
from mesa_models.boltzmann_wealth_model.model import BoltzmannWealthModel
14+
```
15+
You can see the available models at [setup.cfg](https://github.com/projectmesa/mesa-examples/blob/main/setup.cfg).
16+
17+
The package also contains experimental code, which will be in the main Mesa package once they have stabilized.
18+
You can see an example of the `JupyterViz` function in the experimental boltzmann wealth model's [app.py](https://github.com/projectmesa/mesa-examples/blob/main/examples/boltzmann_wealth_model_experimental/app.py).

0 commit comments

Comments
 (0)