Skip to content

Commit 062d946

Browse files
authored
docs: Clean-up index.md (#2422)
Clean up index.md, updating the screenshot to a modern SolaraViz one and removing unnecessary information, leading to a clean landing page.
1 parent e1d4811 commit 062d946

File tree

3 files changed

+31
-53
lines changed

3 files changed

+31
-53
lines changed

docs/images/Mesa_Screenshot.png

-70.9 KB
Binary file not shown.

docs/images/wolf_scheep.png

847 KB
Loading

docs/index.md

+31-53
Original file line numberDiff line numberDiff line change
@@ -13,82 +13,60 @@
1313
```
1414

1515
```{image} https://img.shields.io/matrix/project-mesa:matrix.org?label=chat&logo=Matrix
16-
:target: https://matrix.to/#/#project-mesa:matrix.orgs
16+
:target: https://matrix.to/#/#project-mesa:matrix.org
1717
```
1818

1919
[Mesa] is an Apache2 licensed agent-based modeling (or ABM) framework in Python.
2020

21-
The original conference paper is [available here](http://conference.scipy.org.s3-website-us-east-1.amazonaws.com/proceedings/scipy2015/jacqueline_kazil.html).
22-
2321
Mesa allows users to quickly create agent-based models using built-in core components (such as spatial grids and agent schedulers) or customized implementations; visualize them using a browser-based interface; and analyze their results using Python's data analysis tools. Its goal is to be the Python-based counterpart to NetLogo, Repast, or MASON.
2422

25-
26-
![A screenshot of the Schelling Model in Mesa|100%](https://raw.githubusercontent.com/projectmesa/mesa/main/docs/images/Mesa_Screenshot.png)
27-
28-
29-
*Above: A Mesa implementation of the Schelling segregation model,
30-
being visualized in a browser window and analyzed in a Jupyter
31-
notebook.*
23+
![A screenshot of the Wolf Sheep model in Mesa|100%](images/wolf_scheep.png)
24+
*A visualisation of the Wolf Sheep model build with Mesa.*
3225

3326
## Features
3427

35-
- Modular components
36-
- Browser-based visualization
37-
- Built-in tools for analysis
28+
- Built-in core modeling components
29+
- Flexible agent and model management through AgentSet
30+
- Browser-based Solara visualization
31+
- Built-in tools for data collection and analysis
32+
- Example model library
3833

3934
## Using Mesa
35+
### Installation Options
4036

4137
To install our latest stable release (2.4.x), run:
4238

43-
``` bash
39+
```bash
4440
pip install -U mesa
4541
```
4642

47-
Mesa >= 3.0 beta includes several installations options:
43+
To install our latest Mesa 3.0 beta with recommended dependencies:
4844

49-
``` bash
45+
```bash
5046
pip install -U --pre mesa[rec]
5147
```
52-
**mesa[rec]** (recommend install) installs - mesa, [networkx](https://networkx.org/), [matplotlib](https://matplotlib.org/stable/install/index.html)
53-
and [solara](https://solara.dev/)
54-
55-
### Other installation options include:
56-
57-
- **mesa[network]** installs mesa and [networkx](https://networkx.org/)
58-
- **mesa[viz]** installs, mesa, [matplotlib](https://matplotlib.org/stable/install/index.html) and [solara](https://solara.dev/)
59-
- **mesa[dev]** installs mesa[rec], [ruff](https://docs.astral.sh/ruff/), [pytest](https://docs.pytest.org/en/stable/), [pytest-cov](https://pytest-cov.readthedocs.io/en/latest/), [sphinx](https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-e), [pytest-mock](https://pytest-mock.readthedocs.io/en/latest/)
60-
- **mesa[examples]** installs mesa[rec], [pytest](https://docs.pytest.org/en/stable/), and [scipy](https://scipy.org/)
61-
- **mesa[docs]** installs mesa[rec], [sphinx](https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-e), [ipython](https://ipython.readthedocs.io/en/stable/install/kernel_install.html), [pydata_sphinx_theme](https://pydata-sphinx-theme.readthedocs.io/en/stable/),
62-
[seaborn](https://seaborn.pydata.org/), [myst-nb](https://myst-nb.readthedocs.io/en/latest/), [myst-parser](https://myst-parser.readthedocs.io/en/latest/)
63-
64-
Then mesa[all] installs all these sub installation options:
65-
**mesa[all]** = mesa[network,viz,dev,examples,docs]
66-
67-
For more help on using Mesa, check out the following resources:
68-
69-
- [Mesa Overview]
70-
- [Mesa Introductory Tutorial]
71-
- [Mesa Visualization Tutorial]
72-
- [Mesa Examples]
73-
- [GitHub Issue Tracker]
74-
- [Matrix chat room]
75-
- [PyPI]
7648

77-
## Contributing back to Mesa
49+
### Resources
7850

79-
If you run into an issue, please file a [ticket] for us to discuss. If possible, follow up with a pull request.
51+
For help getting started with Mesa, check out these resources:
8052

81-
If you would like to add a feature, please reach out via [ticket] or the [email list] for discussion. A feature is most likely to be added if you build it!
53+
- [Mesa Overview] - Learn about Mesa's core concepts and components
54+
- [Mesa Introductory Tutorial] - Build your first agent-based model
55+
- [Mesa Visualization Tutorial] - Learn how to create interactive visualizations with Solara
56+
- [Migration Guide] - Upgrade to Mesa 3.0
57+
- [Mesa Examples] - Browse user-contributed models and implementations
58+
- [GitHub Discussions] - Ask questions and discuss Mesa
59+
- [Matrix Chat Room] - Real-time chat with the Mesa community
8260

83-
- [Contributors guide]
84-
- [Github]
61+
### Development and Support
8562

86-
## Mesa Packages
63+
Mesa is an open source project and welcomes contributions:
8764

88-
ABM features users have shared that you may want to use in your model
65+
- [GitHub Repository] - Access the source code
66+
- [Issue Tracker] - Report bugs or suggest features
67+
- [Contributors Guide] - Learn how to contribute
8968

90-
- [See the Packages](https://github.com/projectmesa/mesa/wiki)
91-
- {ref}`Mesa-Packages <packages>`
69+
The original Mesa conference paper is [available here](http://conference.scipy.org.s3-website-us-east-1.amazonaws.com/proceedings/scipy2015/jacqueline_kazil.html).
9270

9371
```{toctree}
9472
:hidden: true
@@ -112,13 +90,13 @@ Mesa Packages <packages>
11290
- {ref}`search`
11391

11492
[contributors guide]: https://github.com/projectmesa/mesa/blob/main/CONTRIBUTING.md
115-
[github]: https://github.com/projectmesa/mesa/
116-
[github issue tracker]: https://github.com/projectmesa/mesa/issues
93+
[github repository]: https://github.com/projectmesa/mesa/
94+
[github discussions]: https://github.com/projectmesa/mesa/discussions
95+
[issue tracker]: https://github.com/projectmesa/mesa/issues
11796
[matrix chat room]: https://matrix.to/#/#project-mesa:matrix.org
11897
[mesa]: https://github.com/projectmesa/mesa/
11998
[mesa overview]: overview
12099
[mesa examples]: https://github.com/projectmesa/mesa-examples
121100
[mesa introductory tutorial]: tutorials/intro_tutorial
122101
[mesa visualization tutorial]: tutorials/visualization_tutorial
123-
[pypi]: https://pypi.python.org/pypi/Mesa/
124-
[ticket]: https://github.com/projectmesa/mesa/issues
102+
[migration guide]: migration_guide

0 commit comments

Comments
 (0)