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

Minor Typos #2100

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
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
10 changes: 5 additions & 5 deletions docs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ Most models consist of one class to represent the model itself; one class (or mo

- `mesa.Model`
- `mesa.Agent`
- [mesa.time](apis/time.md)
- [mesa.space](apis/space.md)
- [mesa.time](https://mesa.readthedocs.io/en/stable/apis/time.html)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The branch name (stable) can't be hardcoded, because with this, new changes from the PRs can no longer be checked.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see there are other versions for the rtd, like stable and latest. But I am not 100% sure what my approach should be here?
Should defining a variable which captures the current version of readthedocs and use that + [the correct address] to redirect the links or something else?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You have to figure out RTD and Sphinx configuration such that apis/space.md gets translated to the correct URL path upon build.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh yes, I thought it needs to be configured using the folder structure rather than hardcoding the paths, because it looked like auto-documentation generator tool. Will look into it, and try to solve the issue. Thanks!

- [mesa.space](https://mesa.readthedocs.io/en/stable/apis/space.html)

The skeleton of a model might look like this:

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

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.
You should see agents 0-4, activated in random order. See the [tutorial](https://mesa.readthedocs.io/en/stable/tutorials/intro_tutorial.html) 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.md)
- [mesa.batchrunner](apis/batchrunner.md)
- [mesa.datacollection](https://mesa.readthedocs.io/en/stable/apis/datacollection.html)
- [mesa.batchrunner](https://mesa.readthedocs.io/en/stable/apis/batchrunner.html)

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

Expand Down