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

Update visualisation docs #2162

Merged
merged 7 commits into from
Jul 3, 2024
Merged

Update visualisation docs #2162

merged 7 commits into from
Jul 3, 2024

Conversation

EwoutH
Copy link
Contributor

@EwoutH EwoutH commented Jul 3, 2024

Update the visualisation docs to the new visualisation method.

  • API documentation
  • Docstring

@EwoutH EwoutH added the docs Release notes label label Jul 3, 2024
   :undoc-members:
   :show-inheritance:
@EwoutH
Copy link
Contributor Author

EwoutH commented Jul 3, 2024

@EwoutH
Copy link
Contributor Author

EwoutH commented Jul 3, 2024

I think it now looks really nice, and I think it's an useful additional source of information to get started with the new visualisation.

Ready for review! Please squash on merge.

@EwoutH EwoutH marked this pull request as ready for review July 3, 2024 12:57
@EwoutH EwoutH requested review from rht, Corvince and tpike3 and removed request for rht July 3, 2024 12:57
Copy link

github-actions bot commented Jul 3, 2024

Performance benchmarks:

Model Size Init time [95% CI] Run time [95% CI]
Schelling small 🔵 +0.2% [-0.1%, +0.4%] 🔵 -0.9% [-1.1%, -0.7%]
Schelling large 🔵 +0.3% [+0.0%, +0.6%] 🔵 -0.7% [-1.5%, +0.2%]
WolfSheep small 🔵 +0.7% [-0.1%, +1.5%] 🔵 -1.3% [-1.6%, -1.1%]
WolfSheep large 🔵 +0.5% [-0.0%, +1.0%] 🔵 +1.4% [-0.2%, +3.2%]
BoidFlockers small 🔵 +0.7% [+0.2%, +1.4%] 🔵 -0.9% [-1.6%, -0.2%]
BoidFlockers large 🔵 -0.1% [-0.9%, +0.7%] 🔵 -1.1% [-1.9%, -0.3%]

@EwoutH EwoutH merged commit 74e2df6 into projectmesa:main Jul 3, 2024
9 of 11 checks passed
@EwoutH EwoutH deleted the viz-docs branch July 3, 2024 13:49
@EwoutH EwoutH restored the viz-docs branch July 10, 2024 15:43
vitorfrois pushed a commit to vitorfrois/mesa that referenced this pull request Jul 15, 2024
- Add docstring to Jupyter viz module and functions
- Render the docstring in Read the Docs: https://mesa.readthedocs.io/en/latest/apis/visualization.html
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Release notes label
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants