Skip to content

Commit b65fa0a

Browse files
committed
hacky fix
1 parent f5070b7 commit b65fa0a

File tree

4 files changed

+53
-16
lines changed

4 files changed

+53
-16
lines changed

HISTORY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Release History
55
# 3.0.0b1 (2024-10-17)
66

77
## Highlights
8-
Basic exmaples are now importable in Mesa, includes boid_flockers, boltzmann_wealth_model, conways_game_of_life, schelling, and virus_on_network models. With this change they are also integrated into the Mesa tutorial in the docs.
8+
Basic examples are now importable in Mesa, includes boid_flockers, boltzmann_wealth_model, conways_game_of_life, schelling, and virus_on_network models. With this change they are also integrated into the Mesa tutorial in the docs.
99

1010
Also, in this release, visualizations are improved by making visualization elements scalable and more clearly labeling the plots.
1111

docs/README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
1-
Docs for Mesa
2-
=============
1+
# Docs for Mesa
32

43
The readable version of the docs is hosted at [mesa.readthedocs.org](http://mesa.readthedocs.org/).
54

65
This folder contains the docs that build the docs for the core mesa code on readthdocs.
76

8-
### How to publish updates to the docs
7+
## How to publish updates to the docs
98

109
Updating docs can be confusing. Here are the basic setups.
1110

12-
##### Submit a pull request with updates
11+
#### Submit a pull request with updates
1312
1. Create branch (either via branching or fork of repo) -- try to use a descriptive name.
1413
* `git checkout -b doc-updates`
1514
1. Update the docs. Save.
@@ -23,7 +22,7 @@ Updating docs can be confusing. Here are the basic setups.
2322
* `git push origin doc-updates`
2423
1. From here you will want to submit a pull request to main.
2524

26-
##### Update read the docs
25+
#### Update read the docs
2726

2827
From this point, you will need to find someone that has access to readthedocs. Currently, that is [@jackiekazil](https://github.com/jackiekazil), [@rht](https://github.com/rht), and [@tpike3](https://github.com/dmasad).
2928

docs/tutorials/visualization_tutorial.ipynb

Lines changed: 47 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -35,21 +35,58 @@
3535
},
3636
{
3737
"cell_type": "code",
38-
"execution_count": null,
3938
"metadata": {
40-
"tags": []
39+
"tags": [],
40+
"ExecuteTime": {
41+
"end_time": "2024-10-18T07:17:09.866711Z",
42+
"start_time": "2024-10-18T07:17:09.429185Z"
43+
}
4144
},
42-
"outputs": [],
4345
"source": [
4446
"# Install and import the latest Mesa pre-release version\n",
45-
"%pip install --quiet --upgrade --pre mesa\n",
47+
"# %pip install --quiet --upgrade --pre mesa\n",
4648
"import mesa\n",
47-
"print(f\"Mesa version: {mesa.__version__}\")\n",
48-
"\n",
49-
"# You can either define the BoltzmannWealthModel (aka MoneyModel) or install it\n",
50-
"\n",
51-
"from mesa.examples.basic import BoltzmannWealthModel"
52-
]
49+
"print(f\"Mesa version: {mesa.__version__}\")"
50+
],
51+
"outputs": [
52+
{
53+
"name": "stdout",
54+
"output_type": "stream",
55+
"text": [
56+
"Mesa version: 3.0.0b1\n"
57+
]
58+
}
59+
],
60+
"execution_count": 1
61+
},
62+
{
63+
"metadata": {
64+
"ExecuteTime": {
65+
"end_time": "2024-10-18T07:17:11.592085Z",
66+
"start_time": "2024-10-18T07:17:11.293216Z"
67+
}
68+
},
69+
"cell_type": "code",
70+
"source": [
71+
"try:\n",
72+
" from mesa.examples.basic import BoltzmannWealthModel\n",
73+
"except ImportError:\n",
74+
" from MoneyModel import MoneyModel as BoltzmannWealthModel\n"
75+
],
76+
"outputs": [
77+
{
78+
"ename": "ModuleNotFoundError",
79+
"evalue": "No module named 'mesa.examples.basic'",
80+
"output_type": "error",
81+
"traceback": [
82+
"\u001B[0;31m---------------------------------------------------------------------------\u001B[0m",
83+
"\u001B[0;31mModuleNotFoundError\u001B[0m Traceback (most recent call last)",
84+
"Cell \u001B[0;32mIn[2], line 1\u001B[0m\n\u001B[0;32m----> 1\u001B[0m \u001B[38;5;28;01mfrom\u001B[39;00m \u001B[38;5;21;01mmesa\u001B[39;00m\u001B[38;5;21;01m.\u001B[39;00m\u001B[38;5;21;01mexamples\u001B[39;00m\u001B[38;5;21;01m.\u001B[39;00m\u001B[38;5;21;01mbasic\u001B[39;00m \u001B[38;5;28;01mimport\u001B[39;00m BoltzmannWealthModel\n",
85+
"\u001B[0;31mModuleNotFoundError\u001B[0m: No module named 'mesa.examples.basic'"
86+
]
87+
}
88+
],
89+
"execution_count": 2
5390
},
5491
{
5592
"cell_type": "markdown",

examples/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
import basic

0 commit comments

Comments
 (0)