Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes Broken Links In Mesa Documentation #2099

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ mesa runserver examples/wolf_sheep

For more help on using Mesa, check out the following resources:

- [Mesa Overview]
- [Mesa Introductory Tutorial]
- [Mesa Visualization Tutorial]
- [GitHub Issue Tracker]
Expand Down Expand Up @@ -99,7 +100,8 @@ tutorials/adv_tutorial_legacy.ipynb
[github]: https://github.com/projectmesa/mesa/
[github issue tracker]: https://github.com/projectmesa/mesa/issues
[mesa]: https://github.com/projectmesa/mesa/
[mesa introductory tutorial]: tutorials/intro_tutorial.html
[mesa visualization tutorial]: tutorials/visualization_tutorial.html
[mesa overview]: https://github.com/projectmesa/mesa/blob/main/docs/overview.md
[mesa introductory tutorial]: https://github.com/projectmesa/mesa/blob/main/docs/tutorials/intro_tutorial.ipynb
[mesa visualization tutorial]: https://github.com/projectmesa/mesa/blob/main/docs/tutorials/visualization_tutorial.ipynb
[pypi]: https://pypi.python.org/pypi/Mesa/
[ticket]: https://github.com/projectmesa/mesa/issues
13 changes: 7 additions & 6 deletions docs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,10 @@ Mesa is modular, meaning that its modeling, analysis and visualization component

Most models consist of one class to represent the model itself; one class (or more) for agents; a scheduler to handle time (what order the agents act in), and possibly a space for the agents to inhabit and move through. These are implemented in Mesa's modeling modules:

- `mesa.Model`, `mesa.Agent`
- [mesa.time](apis/time.html)
- [mesa.space](apis/space.html)
- `mesa.Model`
- `mesa.Agent`
- [mesa.time](apis/time.md)
- [mesa.space](apis/space.md)

The skeleton of a model might look like this:

Expand Down Expand Up @@ -56,16 +57,16 @@ model = MyModel(5)
model.step()
```

You should see agents 0-4, activated in random order. See the [tutorial](tutorials/intro_tutorial.html) or API documentation for more detail on how to add model functionality.
You should see agents 0-4, activated in random order. See the [tutorial](tutorials/intro_tutorial.ipynb) or API documentation for more detail on how to add model functionality.

To bootstrap a new model install mesa and run `mesa startproject`

### Analysis modules

If you're using modeling for research, you'll want a way to collect the data each model run generates. You'll probably also want to run the model multiple times, to see how some output changes with different parameters. Data collection and batch running are implemented in the appropriately-named analysis modules:

- [mesa.datacollection](apis/datacollection.html)
- [mesa.batchrunner](apis/batchrunner.html)
- [mesa.datacollection](apis/datacollection.md)
- [mesa.batchrunner](apis/batchrunner.md)

You'd add a data collector to the model like this:

Expand Down