projectmesa / mesa-examples

Seminal agent-based models developed using Mesa
Other
105 stars 123 forks source link

Improve Virus on Network documentation #100

Closed coderbeta1 closed 4 months ago

coderbeta1 commented 4 months ago

Change 1: Make the ReadMe more descriptive

  1. Added a more detailed explanation of the model
  2. Added an extra method of running the model

Change 2: Doc Strings and Cleaning

Made small changes to make the code more readable and easy to understand at first glance

NOTE: In the model, after running, some of the nodes in the graph are isolated. In my opinion it should be connected (if it was intentional then fine but in case not it needs to be updated with a different graph creation technique)

rht commented 4 months ago

pre-commit checks failed: https://results.pre-commit.ci/run/github/42205414/1708283306.gaMzyn-PS4uAHxWwbDygnQ.

EwoutH commented 4 months ago

pre-commit.ci autofix

tpike3 commented 4 months ago

@coderbeta1 Welcome and thanks for the contribution!

This is a super minor fix, if you would prefer we can do it on our end, just let us know.

Thanks again

EwoutH commented 4 months ago

Merged, thanks for your contribution!