Skip to content

Commit ba43b57

Browse files
committed
Update Readthedocs URLs
Moving towards the shorter mesa.readthedocs.io/stable/ (instead of mesa.readthedocs.io/en/stable/)
1 parent 4c82989 commit ba43b57

8 files changed

+15
-15
lines changed

.readthedocs.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Read the Docs configuration file
2-
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
2+
# See https://docs.readthedocs.io/stable/config-file/v2.html for details
33

44
# Required
55
version: 2

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Learn the tools, talk to us about what you want to change, and open a small PR.
5353
Awesome! You have the basics of open-source software development (if not check above), but not much modelling experience.
5454

5555
First step is to start thinking like a modeller. To understand the fine details about our library and contribute meaningfully, get some modelling experience:
56-
- Go though our [Introductory Tutorial](https://mesa.readthedocs.io/en/latest/tutorials/intro_tutorial.html) and [Visualization Tutorial](https://mesa.readthedocs.io/en/latest/tutorials/visualization_tutorial.html). While going through them, dive into the source code to really see what everything does.
56+
- Go though our [Introductory Tutorial](https://mesa.readthedocs.io/latest/tutorials/intro_tutorial.html) and [Visualization Tutorial](https://mesa.readthedocs.io/latest/tutorials/visualization_tutorial.html). While going through them, dive into the source code to really see what everything does.
5757
- Follow an ABM course (if possible). They might be a bit outdated programming language wise, but conceptual they're sound.
5858
- This MOOC on ABM concepts: [Agent Based Modeling](https://ocw.tudelft.nl/course-lectures/agent-based-modeling/)
5959
- This MOOC on practical ABM modelling: [Agent-Based Models with Python: An Introduction to Mesa](https://www.complexityexplorer.org/courses/172-agent-based-models-with-python-an-introduction-to-mesa)

HISTORY.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Release History
55
## Highlights
66
Mesa v3.0 alpha 5 release contains many quality of life updates, a big new feature for the DataCollector and a major deprecation.
77

8-
The entire `mesa.time` module, including all schedulers, has been deprecated ([#2306](https://github.com/projectmesa/mesa/pull/2306)). Users are encouraged to transition to AgentSet functionality for more flexible and explicit agent activation patterns. Check the [migration guide](https://mesa.readthedocs.io/en/latest/migration_guide.html#time-and-schedulers) on how to upgrade.
8+
The entire `mesa.time` module, including all schedulers, has been deprecated ([#2306](https://github.com/projectmesa/mesa/pull/2306)). Users are encouraged to transition to AgentSet functionality for more flexible and explicit agent activation patterns. Check the [migration guide](https://mesa.readthedocs.io/latest/migration_guide.html#time-and-schedulers) on how to upgrade.
99

1010
The DataCollector now supports collecting data from specific Agent subclasses using the new `agenttype_reporters` parameter ([#2300](https://github.com/projectmesa/mesa/pull/2300)). This allows collecting different metrics for different agent types. For example:
1111

@@ -71,7 +71,7 @@ Mesa 3.0.0a4 contains two major breaking changes:
7171
Example models were updated in [mesa-examples#194](https://github.com/projectmesa/mesa-examples/pull/194), which shows more examples on how to update existing models.
7272

7373
2. Our visualisation API is being overhauled, to be more flexible and powerful. For more details, see [#2278](https://github.com/projectmesa/mesa/pull/2278).
74-
- An initial update to the tutorial was made in [#2289](https://github.com/projectmesa/mesa/pull/2289) and is [available here](https://mesa.readthedocs.io/en/latest/tutorials/visualization_tutorial.html).
74+
- An initial update to the tutorial was made in [#2289](https://github.com/projectmesa/mesa/pull/2289) and is [available here](https://mesa.readthedocs.io/latest/tutorials/visualization_tutorial.html).
7575
- An initial example model was updated in [mesa-examples#195](https://github.com/projectmesa/mesa-examples/pull/195), and more examples will be updated in [mesa-examples#195](https://github.com/projectmesa/mesa-examples/pull/193).
7676
- The old SolaraViz API is still available at `mesa.experimental`, but might be removed in future releases.
7777

@@ -122,7 +122,7 @@ Our example models also got more love: We removed the `RandomActivation` schedul
122122

123123
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](https://github.com/projectmesa/mesa-examples/pull/157) by @zjost). The first example using the `PropertyLayer` was added, a very fast implementation of Conway's Game of Life ([examples#182](https://github.com/projectmesa/mesa-examples/pull/182)).
124124

125-
To help the transition to Mesa 3.0, we started writing a [migration guide](https://mesa.readthedocs.io/en/latest/migration_guide.html). Progress is tracked in #2233, feedback and help is appreciated! Finally, we also added a new section to our [contributor guide](https://github.com/projectmesa/mesa/blob/main/CONTRIBUTING.md#i-have-no-idea-where-to-start) to get new contributors up to speed.
125+
To help the transition to Mesa 3.0, we started writing a [migration guide](https://mesa.readthedocs.io/latest/migration_guide.html). Progress is tracked in #2233, feedback and help is appreciated! Finally, we also added a new section to our [contributor guide](https://github.com/projectmesa/mesa/blob/main/CONTRIBUTING.md#i-have-no-idea-where-to-start) to get new contributors up to speed.
126126

127127
This pre-release can be installed as always with `pip install --pre mesa`
128128

@@ -213,7 +213,7 @@ This is the first pre-release in the Mesa 3.0 series, which is still in active d
213213
Since it's in active development, more breaking changes may follow and it's not recommended for general usage.
214214

215215
There are two major breaking changes at this point:
216-
- 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](https://mesa.readthedocs.io/en/latest/tutorials/visualization_tutorial.html). More examples and a migration guide will follow later in the Mesa 3.0 development.
216+
- 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](https://mesa.readthedocs.io/latest/tutorials/visualization_tutorial.html). More examples and a migration guide will follow later in the Mesa 3.0 development.
217217
- The `mesa.flat` namespace is removed, since was not used very often.
218218

219219
Mesa 3.0 will require Python 3.10+.

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -57,13 +57,13 @@ For resources or help on using Mesa, check out the following:
5757

5858
- [Intro to Mesa Tutorial](http://mesa.readthedocs.org/en/stable/tutorials/intro_tutorial.html) (An introductory model, the Boltzmann
5959
Wealth Model, for beginners or those new to Mesa.)
60-
- [Visualization Tutorial](https://mesa.readthedocs.io/en/stable/tutorials/visualization_tutorial.html) (An introduction into our Solara visualization)
60+
- [Visualization Tutorial](https://mesa.readthedocs.io/stable/tutorials/visualization_tutorial.html) (An introduction into our Solara visualization)
6161
- [Complexity Explorer Tutorial](https://www.complexityexplorer.org/courses/172-agent-based-models-with-python-an-introduction-to-mesa) (An advanced-beginner model,
6262
SugarScape with Traders, with instructional videos)
6363
- [Mesa Examples](https://github.com/projectmesa/mesa-examples/tree/main/examples) (A repository of seminal ABMs using Mesa and
6464
examples of employing specific Mesa Features)
6565
- [Docs](http://mesa.readthedocs.org/) (Mesa's documentation, API and useful snippets)
66-
- [Development version docs](https://mesa.readthedocs.io/en/latest/) (the latest version docs if you're using a pre-release Mesa version)
66+
- [Development version docs](https://mesa.readthedocs.io/latest/) (the latest version docs if you're using a pre-release Mesa version)
6767
- [Discussions](https://github.com/projectmesa/mesa/discussions) (GitHub threaded discussions about Mesa)
6868
- [Matrix Chat](https://matrix.to/#/#project-mesa:matrix.org) (Chat Forum via Matrix to talk about Mesa)
6969

docs/packages.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,9 @@ Most likely you created an ABM that has the code that you want to share in it, w
7373
7474
**Sharing your package**
7575
76-
> 1. Layout a new file structure to move the code into and then make sure it is callable from Mesa, in a simple, easy to understand way. For example, `from example_package import foo`. See [Creating the Scaffolding](https://python-packaging.readthedocs.io/en/latest/minimal.html#creating-the-scaffolding).
76+
> 1. Layout a new file structure to move the code into and then make sure it is callable from Mesa, in a simple, easy to understand way. For example, `from example_package import foo`. See [Creating the Scaffolding](https://python-packaging.readthedocs.io/latest/minimal.html#creating-the-scaffolding).
7777
>
78-
> 2. [Pick a name](https://python-packaging.readthedocs.io/en/latest/minimal.html#picking-a-name).
78+
> 2. [Pick a name](https://python-packaging.readthedocs.io/latest/minimal.html#picking-a-name).
7979
>
8080
> 3. [Create a repo on GitHub](https://help.github.com/articles/create-a-repo/).
8181
>

docs/tutorials/intro_tutorial.ipynb

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
"\n",
3030
"### More Tutorials: \n",
3131
"\n",
32-
"Visualization: There is a separate [visualization tutorial](https://mesa.readthedocs.io/en/stable/tutorials/visualization_tutorial.html) that will take users through building a visualization for this model (aka Boltzmann Wealth Model)."
32+
"Visualization: There is a separate [visualization tutorial](https://mesa.readthedocs.io/stable/tutorials/visualization_tutorial.html) that will take users through building a visualization for this model (aka Boltzmann Wealth Model)."
3333
]
3434
},
3535
{

docs/tutorials/visualization_tutorial.ipynb

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
"cell_type": "markdown",
1212
"metadata": {},
1313
"source": [
14-
"*This version of the visualisation tutorial is updated for Mesa 3.0, and works with Mesa `3.0.0a4` and above. If you are using Mesa 2.3.x, check out the [stable version](https://mesa.readthedocs.io/en/stable/tutorials/visualization_tutorial.html) of this tutorial on Readthedocs.*\n",
14+
"*This version of the visualisation tutorial is updated for Mesa 3.0, and works with Mesa `3.0.0a4` and above. If you are using Mesa 2.3.x, check out the [stable version](https://mesa.readthedocs.io/stable/tutorials/visualization_tutorial.html) of this tutorial on Readthedocs.*\n",
1515
"\n",
1616
"**Important:** \n",
1717
"- If you are just exploring Mesa and want the fastest way to execute the code we recommend executing this tutorial online in a Colab notebook. [![Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/projectmesa/mesa/blob/main/docs/tutorials/visualization_tutorial.ipynb)\n",
@@ -30,7 +30,7 @@
3030
"source": [
3131
"#### Grid Visualization\n",
3232
"\n",
33-
"To start with, let's have a visualization where we can watch the agents moving around the grid. Let us use the same `MoneyModel` created in the [Introductory Tutorial](https://mesa.readthedocs.io/en/stable/tutorials/intro_tutorial.html).\n"
33+
"To start with, let's have a visualization where we can watch the agents moving around the grid. Let us use the same `MoneyModel` created in the [Introductory Tutorial](https://mesa.readthedocs.io/stable/tutorials/intro_tutorial.html).\n"
3434
]
3535
},
3636
{

mesa/time.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
.. warning::
44
The time module and all its Schedulers are deprecated and will be removed in a future version.
55
They can be replaced with AgentSet functionality. See the migration guide for details:
6-
https://mesa.readthedocs.io/en/latest/migration_guide.html#time-and-schedulers
6+
https://mesa.readthedocs.io/latest/migration_guide.html#time-and-schedulers
77
88
Objects for handling the time component of a model. In particular, this module
99
contains Schedulers, which handle agent activation. A Scheduler is an object
@@ -65,7 +65,7 @@ def __init__(self, model: Model, agents: Iterable[Agent] | None = None) -> None:
6565
warnings.warn(
6666
"The time module and all its Schedulers are deprecated and will be removed in a future version. "
6767
"They can be replaced with AgentSet functionality. See the migration guide for details. "
68-
"https://mesa.readthedocs.io/en/latest/migration_guide.html#time-and-schedulers",
68+
"https://mesa.readthedocs.io/latest/migration_guide.html#time-and-schedulers",
6969
DeprecationWarning,
7070
stacklevel=2,
7171
)

0 commit comments

Comments
 (0)