Skip to content

Reviewing a Model for the Library

Jacob Kelter edited this page Jan 25, 2023 · 7 revisions

For the Sample Models, hosted in the Models Library, we use an even stricter holistic standard beyond following the NetLogo Style Guide.

  • The INTERFACE should be intuitive and it should be possible to use the model (at least tinker with it) without having to refer to the Info tab immediately.
  • The INFO tab should succinctly and accurately describe the phenomenon being modeled. A reader who does not have any background in the subject should be able to at least garner some understanding of what is going on.
  • The CODE should be readable (e.g. well structured and well written) and close-to-understandable by a person who is becoming familiar with NetLogo.

Leave comments on the three sections in the following places:

  • For comments on the INTERFACE tab, add a section to the top of the Info tab with using ### Reviewer comments on Interface tab and then write your comments in that section.
  • For comments on the Info tab, add another section with ### Reviewer comments on Info tab and add any overarching comments about the Info tab there. Then, for any in-line comments (e.g., about a specific sentence), add comments surrounded in triple braces right after whatever sentence/section you are commenting on like this {{{ a comment }}}.
  • For comments on the CODE tab, put them in the CODE tab itself. If there are any overall comments, you can put them at the very top of the file. For in-line comments, surround them in triple curly braces so they are easy to search for and find like this: ; {{{ a comment }}}.