diff --git a/1870-Schliemann-001/.DS_Store b/1870-Schliemann-001/.DS_Store new file mode 100644 index 0000000..a2bd767 Binary files /dev/null and b/1870-Schliemann-001/.DS_Store differ diff --git a/1870-Schliemann-001/.gitignore b/1870-Schliemann-001/.gitignore new file mode 100644 index 0000000..7a60b85 --- /dev/null +++ b/1870-Schliemann-001/.gitignore @@ -0,0 +1,2 @@ +__pycache__/ +*.pyc diff --git a/1870-Schliemann-001/CHANGELOG.md b/1870-Schliemann-001/CHANGELOG.md new file mode 100644 index 0000000..0f6941b --- /dev/null +++ b/1870-Schliemann-001/CHANGELOG.md @@ -0,0 +1,2 @@ +## 1.0.0 +- Creation of the module. \ No newline at end of file diff --git a/1870-Schliemann-001/LICENSE b/1870-Schliemann-001/LICENSE new file mode 100644 index 0000000..0e6178b --- /dev/null +++ b/1870-Schliemann-001/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/1870-Schliemann-001/NASSA.yml b/1870-Schliemann-001/NASSA.yml new file mode 100644 index 0000000..105f19e --- /dev/null +++ b/1870-Schliemann-001/NASSA.yml @@ -0,0 +1,70 @@ +id: 1870-Schliemann-001 +nassaVersion: 0.5.0 +moduleType: Algorithm +title: (DUMMY EXAMPLE) TroyDestroy. Bronze Age siege and its destructive effect on settlement +moduleVersion: 1.0.0 +contributors: + - name: Schliemann, Heinrich + roles: [ "Author", "Copyright Holder" ] + email: schliemann@email.org + orcid: 0000-0002-1825-0097 + - name: Angourakis, Andreas + roles: [ "Author", "Copyright Holder", "Creator" ] + email: andros.spica@gmail.com + orcid: 0000-0002-9946-8142 +lastUpdateDate: 1871-10-20 +description: > + This module takes the strength of two armies, one aggressor and another defender, and calculates the level of destruction of the defenders' city. The destructive effect over the defenders' city is proportional to the two contending strengths and a constant rate per unit of strength of the aggressor matched by the defender. +relatedModules: [ 1874-Schliemann-001 ] +references: + moduleReferences: [ homer_iliad_1865 ] + useExampleReferences: [ nassa_guide_submissions ] +domainKeywords: + regions: + - Global + - Eastern Mediterranean + periods: + - Bronze Age + - Mycenaean + subjects: + - war +modellingKeywords: + - agent + - calculation +programmingKeywords: + - Functional + - Object-oriented +implementations: + - language: NetLogo + softwareDependencies: + - NetLogo >= v6.1.1 + - gis (NetLogo extension) + - language: Python + softwareDependencies: + - Python >= v.3.9 + - math (Python module) + - random (Python module) +docsDir: documentation/ +inputs: + - name: greeks-strength, GREEKS_STRENGTH + type: integer + unit: army strength + description: The strength of the Greek army (attackers), measured in number of soldiers, units, etc. + - name: trojans-strength, TROJANS_STRENGTH + type: integer + unit: army strength + description: The strength of the Trojan army (defenders), measured in number of soldiers, units, etc. + - name: destruction-rate, DESTRUCTION_RATE + type: float + unit: city health / army strength + description: The rate of destruction per unit of attacker strength + - name: init-troy-health, TROY_HEALTH + type: float + unit: city health + description: The general state of the defenders city, measured in population, structures, etc. +outputs: + - name: troy-health, health, City.health + type: float + unit: city health + description: The general state of the defenders city, measured in population, structures, etc. +license: MIT diff --git a/1870-Schliemann-001/README.md b/1870-Schliemann-001/README.md new file mode 100644 index 0000000..a32df19 --- /dev/null +++ b/1870-Schliemann-001/README.md @@ -0,0 +1,25 @@ +# (DUMMY EXAMPLE) TroyDestroy. Bronze Age siege and its destructive effect on settlement + +*by Heinrich "Dummy" Schliemann* (NASSA submission :rocket:) + +This module takes the strength of two armies, one aggressor and another defender, and calculates the level of destruction of the defenders' city. The destructive effect over the defenders' city is proportional to the two contending strengths and a constant rate per unit of strength of the aggressor matched by the defender. + +## License + +**MIT** + +## References + +Homer. 1865. The Iliad of Homer. J. Murray (trad.). + +## Further information + +Corinthian aryballos depicting the trojan war from 1887 jahrbuchdeskaiserich 1200x500 + +This model is a algorithm implemented in NetLogo and Python 3. Disclaimer: the code might require updates since it was written in the 19th century. + +Overview of the algorithm: + +$$warEffect=-destructionRate*\frac{(attackerStrength)^2}{defenderStrength} $$ + +See full list of documentation resources in [`documentation`](documentation/tableOfContents.md). diff --git a/1870-Schliemann-001/documentation/designDetails.md b/1870-Schliemann-001/documentation/designDetails.md new file mode 100644 index 0000000..d841ae8 --- /dev/null +++ b/1870-Schliemann-001/documentation/designDetails.md @@ -0,0 +1,21 @@ +# Design details + +This module takes the strength of two armies, one aggressor and another defender, and calculates the level of destruction of the defenders' city. + +## Inputs + +Four input variables or parameters are required: +- Strength of the attacker's army +- Strength of the defender's army +- Destruction rate modulating how fast the city looses its health during the war +- Health of the defender's city, before the war + +## Output + +- Health of the defender's city, after the war + +## Core algorithm + +The destructive effect over the defenders' city is proportional to the two contending strengths and a constant rate per unit of strength of the aggressor matched by the defender. The specific mathematical formulation is: + +$$warEffect=-destructionRate*\frac{(attackerStrength)^2}{defenderStrength} $$ \ No newline at end of file diff --git a/1870-Schliemann-001/documentation/tableOfContents.md b/1870-Schliemann-001/documentation/tableOfContents.md new file mode 100644 index 0000000..46327c9 --- /dev/null +++ b/1870-Schliemann-001/documentation/tableOfContents.md @@ -0,0 +1,9 @@ +(DUMMY EXAMPLE) TroyDestroy. Bronze Age siege and its destructive effect on settlement +# General documentation +## Table of contents + +- [`designDetails.md`](designDetails.md) : free format document describing the module process, beyond the level of implementation. + +- [NetLogo implementation](/netlogo_implementation/documentation/tableOfContents.md) : documentation specific to the NetLogo implementation. + +- [Python implementation](/python_implementation/documentation/tableOfContents.md) : documentation specific to the Python implementation. \ No newline at end of file diff --git a/1870-Schliemann-001/netlogo_implementation/TroyDestroy.nlogo b/1870-Schliemann-001/netlogo_implementation/TroyDestroy.nlogo new file mode 100644 index 0000000..9a65633 --- /dev/null +++ b/1870-Schliemann-001/netlogo_implementation/TroyDestroy.nlogo @@ -0,0 +1,516 @@ +globals +[ + ;;; input + greeks-strength trojans-strength + destruction-rate + init-troy-health + + ;;; output + troy-health +] + +to setup + + ;;; load input from interface + set greeks-strength par_greeks-strength + set trojans-strength par_trojans-strength + set destruction-rate par_destruction-rate + + set init-troy-health 100 + + set troy-health init-troy-health + +end + +to resolve-trojan-war + + ;;; Resolve the destruction level based on army strengths and a destruction rate and update city health + set troy-health (get-effect-of-war troy-health greeks-strength trojans-strength destruction-rate) + +end + +to-report get-effect-of-war [ cityHealth aggressorStrength defenderStrength destructionRate ] + + ;;; Return the destruction level based on army strengths and a destruction rate + report max (list 0 (cityHealth - destructionRate * (aggressorStrength ^ 2) / defenderStrength)) + +end +@#$#@#$#@ +GRAPHICS-WINDOW +210 +10 +647 +448 +-1 +-1 +13.0 +1 +10 +1 +1 +1 +0 +1 +1 +1 +-16 +16 +-16 +16 +0 +0 +1 +ticks +30.0 + +SLIDER +25 +50 +197 +83 +par_greeks-strength +par_greeks-strength +0 +100 +100.0 +1 +1 +NIL +HORIZONTAL + +SLIDER +26 +91 +198 +124 +par_trojans-strength +par_trojans-strength +0 +100 +50.0 +1 +1 +NIL +HORIZONTAL + +SLIDER +25 +135 +202 +168 +par_destruction-rate +par_destruction-rate +0 +1 +0.42 +0.01 +1 +NIL +HORIZONTAL + +MONITOR +72 +193 +147 +238 +NIL +troy-health +17 +1 +11 + +BUTTON +73 +10 +208 +43 +NIL +resolve-trojan-war +NIL +1 +T +OBSERVER +NIL +NIL +NIL +NIL +1 + +BUTTON +6 +10 +69 +43 +NIL +setup +NIL +1 +T +OBSERVER +NIL +NIL +NIL +NIL +1 + +@#$#@#$#@ +## WHAT IS IT? + +(a general understanding of what the model is trying to show or explain) + +## HOW IT WORKS + +(what rules the agents use to create the overall behavior of the model) + +## HOW TO USE IT + +(how to use the model, including a description of each of the items in the Interface tab) + +## THINGS TO NOTICE + +(suggested things for the user to notice while running the model) + +## THINGS TO TRY + +(suggested things for the user to try to do (move sliders, switches, etc.) with the model) + +## EXTENDING THE MODEL + +(suggested things to add or change in the Code tab to make the model more complicated, detailed, accurate, etc.) + +## NETLOGO FEATURES + +(interesting or unusual features of NetLogo that the model uses, particularly in the Code tab; or where workarounds were needed for missing features) + +## RELATED MODELS + +(models in the NetLogo Models Library and elsewhere which are of related interest) + +## CREDITS AND REFERENCES + +(a reference to the model's URL on the web if it has one, as well as any other necessary credits, citations, and links) +@#$#@#$#@ +default +true +0 +Polygon -7500403 true true 150 5 40 250 150 205 260 250 + +airplane +true +0 +Polygon -7500403 true true 150 0 135 15 120 60 120 105 15 165 15 195 120 180 135 240 105 270 120 285 150 270 180 285 210 270 165 240 180 180 285 195 285 165 180 105 180 60 165 15 + +arrow +true +0 +Polygon -7500403 true true 150 0 0 150 105 150 105 293 195 293 195 150 300 150 + +box +false +0 +Polygon -7500403 true true 150 285 285 225 285 75 150 135 +Polygon -7500403 true true 150 135 15 75 150 15 285 75 +Polygon -7500403 true true 15 75 15 225 150 285 150 135 +Line -16777216 false 150 285 150 135 +Line -16777216 false 150 135 15 75 +Line -16777216 false 150 135 285 75 + +bug +true +0 +Circle -7500403 true true 96 182 108 +Circle -7500403 true true 110 127 80 +Circle -7500403 true true 110 75 80 +Line -7500403 true 150 100 80 30 +Line -7500403 true 150 100 220 30 + +butterfly +true +0 +Polygon -7500403 true true 150 165 209 199 225 225 225 255 195 270 165 255 150 240 +Polygon -7500403 true true 150 165 89 198 75 225 75 255 105 270 135 255 150 240 +Polygon -7500403 true true 139 148 100 105 55 90 25 90 10 105 10 135 25 180 40 195 85 194 139 163 +Polygon -7500403 true true 162 150 200 105 245 90 275 90 290 105 290 135 275 180 260 195 215 195 162 165 +Polygon -16777216 true false 150 255 135 225 120 150 135 120 150 105 165 120 180 150 165 225 +Circle -16777216 true false 135 90 30 +Line -16777216 false 150 105 195 60 +Line -16777216 false 150 105 105 60 + +car +false +0 +Polygon -7500403 true true 300 180 279 164 261 144 240 135 226 132 213 106 203 84 185 63 159 50 135 50 75 60 0 150 0 165 0 225 300 225 300 180 +Circle -16777216 true false 180 180 90 +Circle -16777216 true false 30 180 90 +Polygon -16777216 true false 162 80 132 78 134 135 209 135 194 105 189 96 180 89 +Circle -7500403 true true 47 195 58 +Circle -7500403 true true 195 195 58 + +circle +false +0 +Circle -7500403 true true 0 0 300 + +circle 2 +false +0 +Circle -7500403 true true 0 0 300 +Circle -16777216 true false 30 30 240 + +cow +false +0 +Polygon -7500403 true true 200 193 197 249 179 249 177 196 166 187 140 189 93 191 78 179 72 211 49 209 48 181 37 149 25 120 25 89 45 72 103 84 179 75 198 76 252 64 272 81 293 103 285 121 255 121 242 118 224 167 +Polygon -7500403 true true 73 210 86 251 62 249 48 208 +Polygon -7500403 true true 25 114 16 195 9 204 23 213 25 200 39 123 + +cylinder +false +0 +Circle -7500403 true true 0 0 300 + +dot +false +0 +Circle -7500403 true true 90 90 120 + +face happy +false +0 +Circle -7500403 true true 8 8 285 +Circle -16777216 true false 60 75 60 +Circle -16777216 true false 180 75 60 +Polygon -16777216 true false 150 255 90 239 62 213 47 191 67 179 90 203 109 218 150 225 192 218 210 203 227 181 251 194 236 217 212 240 + +face neutral +false +0 +Circle -7500403 true true 8 7 285 +Circle -16777216 true false 60 75 60 +Circle -16777216 true false 180 75 60 +Rectangle -16777216 true false 60 195 240 225 + +face sad +false +0 +Circle -7500403 true true 8 8 285 +Circle -16777216 true false 60 75 60 +Circle -16777216 true false 180 75 60 +Polygon -16777216 true false 150 168 90 184 62 210 47 232 67 244 90 220 109 205 150 198 192 205 210 220 227 242 251 229 236 206 212 183 + +fish +false +0 +Polygon -1 true false 44 131 21 87 15 86 0 120 15 150 0 180 13 214 20 212 45 166 +Polygon -1 true false 135 195 119 235 95 218 76 210 46 204 60 165 +Polygon -1 true false 75 45 83 77 71 103 86 114 166 78 135 60 +Polygon -7500403 true true 30 136 151 77 226 81 280 119 292 146 292 160 287 170 270 195 195 210 151 212 30 166 +Circle -16777216 true false 215 106 30 + +flag +false +0 +Rectangle -7500403 true true 60 15 75 300 +Polygon -7500403 true true 90 150 270 90 90 30 +Line -7500403 true 75 135 90 135 +Line -7500403 true 75 45 90 45 + +flower +false +0 +Polygon -10899396 true false 135 120 165 165 180 210 180 240 150 300 165 300 195 240 195 195 165 135 +Circle -7500403 true true 85 132 38 +Circle -7500403 true true 130 147 38 +Circle -7500403 true true 192 85 38 +Circle -7500403 true true 85 40 38 +Circle -7500403 true true 177 40 38 +Circle -7500403 true true 177 132 38 +Circle -7500403 true true 70 85 38 +Circle -7500403 true true 130 25 38 +Circle -7500403 true true 96 51 108 +Circle -16777216 true false 113 68 74 +Polygon -10899396 true false 189 233 219 188 249 173 279 188 234 218 +Polygon -10899396 true false 180 255 150 210 105 210 75 240 135 240 + +house +false +0 +Rectangle -7500403 true true 45 120 255 285 +Rectangle -16777216 true false 120 210 180 285 +Polygon -7500403 true true 15 120 150 15 285 120 +Line -16777216 false 30 120 270 120 + +leaf +false +0 +Polygon -7500403 true true 150 210 135 195 120 210 60 210 30 195 60 180 60 165 15 135 30 120 15 105 40 104 45 90 60 90 90 105 105 120 120 120 105 60 120 60 135 30 150 15 165 30 180 60 195 60 180 120 195 120 210 105 240 90 255 90 263 104 285 105 270 120 285 135 240 165 240 180 270 195 240 210 180 210 165 195 +Polygon -7500403 true true 135 195 135 240 120 255 105 255 105 285 135 285 165 240 165 195 + +line +true +0 +Line -7500403 true 150 0 150 300 + +line half +true +0 +Line -7500403 true 150 0 150 150 + +pentagon +false +0 +Polygon -7500403 true true 150 15 15 120 60 285 240 285 285 120 + +person +false +0 +Circle -7500403 true true 110 5 80 +Polygon -7500403 true true 105 90 120 195 90 285 105 300 135 300 150 225 165 300 195 300 210 285 180 195 195 90 +Rectangle -7500403 true true 127 79 172 94 +Polygon -7500403 true true 195 90 240 150 225 180 165 105 +Polygon -7500403 true true 105 90 60 150 75 180 135 105 + +plant +false +0 +Rectangle -7500403 true true 135 90 165 300 +Polygon -7500403 true true 135 255 90 210 45 195 75 255 135 285 +Polygon -7500403 true true 165 255 210 210 255 195 225 255 165 285 +Polygon -7500403 true true 135 180 90 135 45 120 75 180 135 210 +Polygon -7500403 true true 165 180 165 210 225 180 255 120 210 135 +Polygon -7500403 true true 135 105 90 60 45 45 75 105 135 135 +Polygon -7500403 true true 165 105 165 135 225 105 255 45 210 60 +Polygon -7500403 true true 135 90 120 45 150 15 180 45 165 90 + +sheep +false +15 +Circle -1 true true 203 65 88 +Circle -1 true true 70 65 162 +Circle -1 true true 150 105 120 +Polygon -7500403 true false 218 120 240 165 255 165 278 120 +Circle -7500403 true false 214 72 67 +Rectangle -1 true true 164 223 179 298 +Polygon -1 true true 45 285 30 285 30 240 15 195 45 210 +Circle -1 true true 3 83 150 +Rectangle -1 true true 65 221 80 296 +Polygon -1 true true 195 285 210 285 210 240 240 210 195 210 +Polygon -7500403 true false 276 85 285 105 302 99 294 83 +Polygon -7500403 true false 219 85 210 105 193 99 201 83 + +square +false +0 +Rectangle -7500403 true true 30 30 270 270 + +square 2 +false +0 +Rectangle -7500403 true true 30 30 270 270 +Rectangle -16777216 true false 60 60 240 240 + +star +false +0 +Polygon -7500403 true true 151 1 185 108 298 108 207 175 242 282 151 216 59 282 94 175 3 108 116 108 + +target +false +0 +Circle -7500403 true true 0 0 300 +Circle -16777216 true false 30 30 240 +Circle -7500403 true true 60 60 180 +Circle -16777216 true false 90 90 120 +Circle -7500403 true true 120 120 60 + +tree +false +0 +Circle -7500403 true true 118 3 94 +Rectangle -6459832 true false 120 195 180 300 +Circle -7500403 true true 65 21 108 +Circle -7500403 true true 116 41 127 +Circle -7500403 true true 45 90 120 +Circle -7500403 true true 104 74 152 + +triangle +false +0 +Polygon -7500403 true true 150 30 15 255 285 255 + +triangle 2 +false +0 +Polygon -7500403 true true 150 30 15 255 285 255 +Polygon -16777216 true false 151 99 225 223 75 224 + +truck +false +0 +Rectangle -7500403 true true 4 45 195 187 +Polygon -7500403 true true 296 193 296 150 259 134 244 104 208 104 207 194 +Rectangle -1 true false 195 60 195 105 +Polygon -16777216 true false 238 112 252 141 219 141 218 112 +Circle -16777216 true false 234 174 42 +Rectangle -7500403 true true 181 185 214 194 +Circle -16777216 true false 144 174 42 +Circle -16777216 true false 24 174 42 +Circle -7500403 false true 24 174 42 +Circle -7500403 false true 144 174 42 +Circle -7500403 false true 234 174 42 + +turtle +true +0 +Polygon -10899396 true false 215 204 240 233 246 254 228 266 215 252 193 210 +Polygon -10899396 true false 195 90 225 75 245 75 260 89 269 108 261 124 240 105 225 105 210 105 +Polygon -10899396 true false 105 90 75 75 55 75 40 89 31 108 39 124 60 105 75 105 90 105 +Polygon -10899396 true false 132 85 134 64 107 51 108 17 150 2 192 18 192 52 169 65 172 87 +Polygon -10899396 true false 85 204 60 233 54 254 72 266 85 252 107 210 +Polygon -7500403 true true 119 75 179 75 209 101 224 135 220 225 175 261 128 261 81 224 74 135 88 99 + +wheel +false +0 +Circle -7500403 true true 3 3 294 +Circle -16777216 true false 30 30 240 +Line -7500403 true 150 285 150 15 +Line -7500403 true 15 150 285 150 +Circle -7500403 true true 120 120 60 +Line -7500403 true 216 40 79 269 +Line -7500403 true 40 84 269 221 +Line -7500403 true 40 216 269 79 +Line -7500403 true 84 40 221 269 + +wolf +false +0 +Polygon -16777216 true false 253 133 245 131 245 133 +Polygon -7500403 true true 2 194 13 197 30 191 38 193 38 205 20 226 20 257 27 265 38 266 40 260 31 253 31 230 60 206 68 198 75 209 66 228 65 243 82 261 84 268 100 267 103 261 77 239 79 231 100 207 98 196 119 201 143 202 160 195 166 210 172 213 173 238 167 251 160 248 154 265 169 264 178 247 186 240 198 260 200 271 217 271 219 262 207 258 195 230 192 198 210 184 227 164 242 144 259 145 284 151 277 141 293 140 299 134 297 127 273 119 270 105 +Polygon -7500403 true true -1 195 14 180 36 166 40 153 53 140 82 131 134 133 159 126 188 115 227 108 236 102 238 98 268 86 269 92 281 87 269 103 269 113 + +x +false +0 +Polygon -7500403 true true 270 75 225 30 30 225 75 270 +Polygon -7500403 true true 30 75 75 30 270 225 225 270 +@#$#@#$#@ +NetLogo 6.2.2 +@#$#@#$#@ +@#$#@#$#@ +@#$#@#$#@ +@#$#@#$#@ +@#$#@#$#@ +default +0.0 +-0.2 0 0.0 1.0 +0.0 1 1.0 0.0 +0.2 0 0.0 1.0 +link direction +true +0 +Line -7500403 true 150 150 90 180 +Line -7500403 true 150 150 210 180 +@#$#@#$#@ +0 +@#$#@#$#@ diff --git a/1870-Schliemann-001/netlogo_implementation/TroyDestroy_agents.nlogo b/1870-Schliemann-001/netlogo_implementation/TroyDestroy_agents.nlogo new file mode 100644 index 0000000..c65748f --- /dev/null +++ b/1870-Schliemann-001/netlogo_implementation/TroyDestroy_agents.nlogo @@ -0,0 +1,549 @@ +globals +[ + ;;; input + greeks-strength trojans-strength + destruction-rate + init-troy-health + + ;;; output + troy-health +] + +breed [ cities city ] +breed [ armies army ] + +cities-own [ name health ] + +armies-own [ name strength ] + +to setup + + clear-all + + ;;; load input from interface + set greeks-strength par_greeks-strength + set trojans-strength par_trojans-strength + set destruction-rate par_destruction-rate + + set init-troy-health 100 + + ;;; create agents + create-cities 1 + [ + set name "Troy" + set health init-troy-health + ] + + create-armies 1 + [ + set name "Greeks" + set strength par_greeks-strength + ] + + create-armies 1 + [ + set name "Trojans" + set strength par_trojans-strength + ] + + reset-ticks + +end + +to resolve-trojan-war + + ;;; Resolve the destruction level based on army strengths and a destruction rate and update city health + ask cities with [ name = "Troy" ] + [ + let greeks-strength-total sum [strength] of armies with [ name = "Greeks" ] + let trojans-strength-total sum [strength] of armies with [ name = "Trojans" ] + set health (get-effect-of-war health greeks-strength-total trojans-strength-total destruction-rate) + ] + +end + +to-report get-effect-of-war [ cityHealth aggressorStrength defenderStrength destructionRate ] + + ;;; Return the destruction level based on army strengths and a destruction rate + report max (list 0 (cityHealth - destructionRate * (aggressorStrength ^ 2) / (defenderStrength))) + +end +@#$#@#$#@ +GRAPHICS-WINDOW +210 +10 +647 +448 +-1 +-1 +13.0 +1 +10 +1 +1 +1 +0 +1 +1 +1 +-16 +16 +-16 +16 +0 +0 +1 +ticks +30.0 + +SLIDER +25 +50 +197 +83 +par_greeks-strength +par_greeks-strength +0 +100 +100.0 +1 +1 +NIL +HORIZONTAL + +SLIDER +26 +91 +198 +124 +par_trojans-strength +par_trojans-strength +0 +100 +50.0 +1 +1 +NIL +HORIZONTAL + +SLIDER +25 +135 +202 +168 +par_destruction-rate +par_destruction-rate +0 +1 +0.42 +0.01 +1 +NIL +HORIZONTAL + +MONITOR +72 +193 +150 +238 +Troy's health +sum [health] of cities with [name = \"Troy\"] +17 +1 +11 + +BUTTON +73 +10 +208 +43 +NIL +resolve-trojan-war +NIL +1 +T +OBSERVER +NIL +NIL +NIL +NIL +1 + +BUTTON +6 +10 +69 +43 +NIL +setup +NIL +1 +T +OBSERVER +NIL +NIL +NIL +NIL +1 + +@#$#@#$#@ +## WHAT IS IT? + +(a general understanding of what the model is trying to show or explain) + +## HOW IT WORKS + +(what rules the agents use to create the overall behavior of the model) + +## HOW TO USE IT + +(how to use the model, including a description of each of the items in the Interface tab) + +## THINGS TO NOTICE + +(suggested things for the user to notice while running the model) + +## THINGS TO TRY + +(suggested things for the user to try to do (move sliders, switches, etc.) with the model) + +## EXTENDING THE MODEL + +(suggested things to add or change in the Code tab to make the model more complicated, detailed, accurate, etc.) + +## NETLOGO FEATURES + +(interesting or unusual features of NetLogo that the model uses, particularly in the Code tab; or where workarounds were needed for missing features) + +## RELATED MODELS + +(models in the NetLogo Models Library and elsewhere which are of related interest) + +## CREDITS AND REFERENCES + +(a reference to the model's URL on the web if it has one, as well as any other necessary credits, citations, and links) +@#$#@#$#@ +default +true +0 +Polygon -7500403 true true 150 5 40 250 150 205 260 250 + +airplane +true +0 +Polygon -7500403 true true 150 0 135 15 120 60 120 105 15 165 15 195 120 180 135 240 105 270 120 285 150 270 180 285 210 270 165 240 180 180 285 195 285 165 180 105 180 60 165 15 + +arrow +true +0 +Polygon -7500403 true true 150 0 0 150 105 150 105 293 195 293 195 150 300 150 + +box +false +0 +Polygon -7500403 true true 150 285 285 225 285 75 150 135 +Polygon -7500403 true true 150 135 15 75 150 15 285 75 +Polygon -7500403 true true 15 75 15 225 150 285 150 135 +Line -16777216 false 150 285 150 135 +Line -16777216 false 150 135 15 75 +Line -16777216 false 150 135 285 75 + +bug +true +0 +Circle -7500403 true true 96 182 108 +Circle -7500403 true true 110 127 80 +Circle -7500403 true true 110 75 80 +Line -7500403 true 150 100 80 30 +Line -7500403 true 150 100 220 30 + +butterfly +true +0 +Polygon -7500403 true true 150 165 209 199 225 225 225 255 195 270 165 255 150 240 +Polygon -7500403 true true 150 165 89 198 75 225 75 255 105 270 135 255 150 240 +Polygon -7500403 true true 139 148 100 105 55 90 25 90 10 105 10 135 25 180 40 195 85 194 139 163 +Polygon -7500403 true true 162 150 200 105 245 90 275 90 290 105 290 135 275 180 260 195 215 195 162 165 +Polygon -16777216 true false 150 255 135 225 120 150 135 120 150 105 165 120 180 150 165 225 +Circle -16777216 true false 135 90 30 +Line -16777216 false 150 105 195 60 +Line -16777216 false 150 105 105 60 + +car +false +0 +Polygon -7500403 true true 300 180 279 164 261 144 240 135 226 132 213 106 203 84 185 63 159 50 135 50 75 60 0 150 0 165 0 225 300 225 300 180 +Circle -16777216 true false 180 180 90 +Circle -16777216 true false 30 180 90 +Polygon -16777216 true false 162 80 132 78 134 135 209 135 194 105 189 96 180 89 +Circle -7500403 true true 47 195 58 +Circle -7500403 true true 195 195 58 + +circle +false +0 +Circle -7500403 true true 0 0 300 + +circle 2 +false +0 +Circle -7500403 true true 0 0 300 +Circle -16777216 true false 30 30 240 + +cow +false +0 +Polygon -7500403 true true 200 193 197 249 179 249 177 196 166 187 140 189 93 191 78 179 72 211 49 209 48 181 37 149 25 120 25 89 45 72 103 84 179 75 198 76 252 64 272 81 293 103 285 121 255 121 242 118 224 167 +Polygon -7500403 true true 73 210 86 251 62 249 48 208 +Polygon -7500403 true true 25 114 16 195 9 204 23 213 25 200 39 123 + +cylinder +false +0 +Circle -7500403 true true 0 0 300 + +dot +false +0 +Circle -7500403 true true 90 90 120 + +face happy +false +0 +Circle -7500403 true true 8 8 285 +Circle -16777216 true false 60 75 60 +Circle -16777216 true false 180 75 60 +Polygon -16777216 true false 150 255 90 239 62 213 47 191 67 179 90 203 109 218 150 225 192 218 210 203 227 181 251 194 236 217 212 240 + +face neutral +false +0 +Circle -7500403 true true 8 7 285 +Circle -16777216 true false 60 75 60 +Circle -16777216 true false 180 75 60 +Rectangle -16777216 true false 60 195 240 225 + +face sad +false +0 +Circle -7500403 true true 8 8 285 +Circle -16777216 true false 60 75 60 +Circle -16777216 true false 180 75 60 +Polygon -16777216 true false 150 168 90 184 62 210 47 232 67 244 90 220 109 205 150 198 192 205 210 220 227 242 251 229 236 206 212 183 + +fish +false +0 +Polygon -1 true false 44 131 21 87 15 86 0 120 15 150 0 180 13 214 20 212 45 166 +Polygon -1 true false 135 195 119 235 95 218 76 210 46 204 60 165 +Polygon -1 true false 75 45 83 77 71 103 86 114 166 78 135 60 +Polygon -7500403 true true 30 136 151 77 226 81 280 119 292 146 292 160 287 170 270 195 195 210 151 212 30 166 +Circle -16777216 true false 215 106 30 + +flag +false +0 +Rectangle -7500403 true true 60 15 75 300 +Polygon -7500403 true true 90 150 270 90 90 30 +Line -7500403 true 75 135 90 135 +Line -7500403 true 75 45 90 45 + +flower +false +0 +Polygon -10899396 true false 135 120 165 165 180 210 180 240 150 300 165 300 195 240 195 195 165 135 +Circle -7500403 true true 85 132 38 +Circle -7500403 true true 130 147 38 +Circle -7500403 true true 192 85 38 +Circle -7500403 true true 85 40 38 +Circle -7500403 true true 177 40 38 +Circle -7500403 true true 177 132 38 +Circle -7500403 true true 70 85 38 +Circle -7500403 true true 130 25 38 +Circle -7500403 true true 96 51 108 +Circle -16777216 true false 113 68 74 +Polygon -10899396 true false 189 233 219 188 249 173 279 188 234 218 +Polygon -10899396 true false 180 255 150 210 105 210 75 240 135 240 + +house +false +0 +Rectangle -7500403 true true 45 120 255 285 +Rectangle -16777216 true false 120 210 180 285 +Polygon -7500403 true true 15 120 150 15 285 120 +Line -16777216 false 30 120 270 120 + +leaf +false +0 +Polygon -7500403 true true 150 210 135 195 120 210 60 210 30 195 60 180 60 165 15 135 30 120 15 105 40 104 45 90 60 90 90 105 105 120 120 120 105 60 120 60 135 30 150 15 165 30 180 60 195 60 180 120 195 120 210 105 240 90 255 90 263 104 285 105 270 120 285 135 240 165 240 180 270 195 240 210 180 210 165 195 +Polygon -7500403 true true 135 195 135 240 120 255 105 255 105 285 135 285 165 240 165 195 + +line +true +0 +Line -7500403 true 150 0 150 300 + +line half +true +0 +Line -7500403 true 150 0 150 150 + +pentagon +false +0 +Polygon -7500403 true true 150 15 15 120 60 285 240 285 285 120 + +person +false +0 +Circle -7500403 true true 110 5 80 +Polygon -7500403 true true 105 90 120 195 90 285 105 300 135 300 150 225 165 300 195 300 210 285 180 195 195 90 +Rectangle -7500403 true true 127 79 172 94 +Polygon -7500403 true true 195 90 240 150 225 180 165 105 +Polygon -7500403 true true 105 90 60 150 75 180 135 105 + +plant +false +0 +Rectangle -7500403 true true 135 90 165 300 +Polygon -7500403 true true 135 255 90 210 45 195 75 255 135 285 +Polygon -7500403 true true 165 255 210 210 255 195 225 255 165 285 +Polygon -7500403 true true 135 180 90 135 45 120 75 180 135 210 +Polygon -7500403 true true 165 180 165 210 225 180 255 120 210 135 +Polygon -7500403 true true 135 105 90 60 45 45 75 105 135 135 +Polygon -7500403 true true 165 105 165 135 225 105 255 45 210 60 +Polygon -7500403 true true 135 90 120 45 150 15 180 45 165 90 + +sheep +false +15 +Circle -1 true true 203 65 88 +Circle -1 true true 70 65 162 +Circle -1 true true 150 105 120 +Polygon -7500403 true false 218 120 240 165 255 165 278 120 +Circle -7500403 true false 214 72 67 +Rectangle -1 true true 164 223 179 298 +Polygon -1 true true 45 285 30 285 30 240 15 195 45 210 +Circle -1 true true 3 83 150 +Rectangle -1 true true 65 221 80 296 +Polygon -1 true true 195 285 210 285 210 240 240 210 195 210 +Polygon -7500403 true false 276 85 285 105 302 99 294 83 +Polygon -7500403 true false 219 85 210 105 193 99 201 83 + +square +false +0 +Rectangle -7500403 true true 30 30 270 270 + +square 2 +false +0 +Rectangle -7500403 true true 30 30 270 270 +Rectangle -16777216 true false 60 60 240 240 + +star +false +0 +Polygon -7500403 true true 151 1 185 108 298 108 207 175 242 282 151 216 59 282 94 175 3 108 116 108 + +target +false +0 +Circle -7500403 true true 0 0 300 +Circle -16777216 true false 30 30 240 +Circle -7500403 true true 60 60 180 +Circle -16777216 true false 90 90 120 +Circle -7500403 true true 120 120 60 + +tree +false +0 +Circle -7500403 true true 118 3 94 +Rectangle -6459832 true false 120 195 180 300 +Circle -7500403 true true 65 21 108 +Circle -7500403 true true 116 41 127 +Circle -7500403 true true 45 90 120 +Circle -7500403 true true 104 74 152 + +triangle +false +0 +Polygon -7500403 true true 150 30 15 255 285 255 + +triangle 2 +false +0 +Polygon -7500403 true true 150 30 15 255 285 255 +Polygon -16777216 true false 151 99 225 223 75 224 + +truck +false +0 +Rectangle -7500403 true true 4 45 195 187 +Polygon -7500403 true true 296 193 296 150 259 134 244 104 208 104 207 194 +Rectangle -1 true false 195 60 195 105 +Polygon -16777216 true false 238 112 252 141 219 141 218 112 +Circle -16777216 true false 234 174 42 +Rectangle -7500403 true true 181 185 214 194 +Circle -16777216 true false 144 174 42 +Circle -16777216 true false 24 174 42 +Circle -7500403 false true 24 174 42 +Circle -7500403 false true 144 174 42 +Circle -7500403 false true 234 174 42 + +turtle +true +0 +Polygon -10899396 true false 215 204 240 233 246 254 228 266 215 252 193 210 +Polygon -10899396 true false 195 90 225 75 245 75 260 89 269 108 261 124 240 105 225 105 210 105 +Polygon -10899396 true false 105 90 75 75 55 75 40 89 31 108 39 124 60 105 75 105 90 105 +Polygon -10899396 true false 132 85 134 64 107 51 108 17 150 2 192 18 192 52 169 65 172 87 +Polygon -10899396 true false 85 204 60 233 54 254 72 266 85 252 107 210 +Polygon -7500403 true true 119 75 179 75 209 101 224 135 220 225 175 261 128 261 81 224 74 135 88 99 + +wheel +false +0 +Circle -7500403 true true 3 3 294 +Circle -16777216 true false 30 30 240 +Line -7500403 true 150 285 150 15 +Line -7500403 true 15 150 285 150 +Circle -7500403 true true 120 120 60 +Line -7500403 true 216 40 79 269 +Line -7500403 true 40 84 269 221 +Line -7500403 true 40 216 269 79 +Line -7500403 true 84 40 221 269 + +wolf +false +0 +Polygon -16777216 true false 253 133 245 131 245 133 +Polygon -7500403 true true 2 194 13 197 30 191 38 193 38 205 20 226 20 257 27 265 38 266 40 260 31 253 31 230 60 206 68 198 75 209 66 228 65 243 82 261 84 268 100 267 103 261 77 239 79 231 100 207 98 196 119 201 143 202 160 195 166 210 172 213 173 238 167 251 160 248 154 265 169 264 178 247 186 240 198 260 200 271 217 271 219 262 207 258 195 230 192 198 210 184 227 164 242 144 259 145 284 151 277 141 293 140 299 134 297 127 273 119 270 105 +Polygon -7500403 true true -1 195 14 180 36 166 40 153 53 140 82 131 134 133 159 126 188 115 227 108 236 102 238 98 268 86 269 92 281 87 269 103 269 113 + +x +false +0 +Polygon -7500403 true true 270 75 225 30 30 225 75 270 +Polygon -7500403 true true 30 75 75 30 270 225 225 270 +@#$#@#$#@ +NetLogo 6.2.2 +@#$#@#$#@ +@#$#@#$#@ +@#$#@#$#@ +@#$#@#$#@ +@#$#@#$#@ +default +0.0 +-0.2 0 0.0 1.0 +0.0 1 1.0 0.0 +0.2 0 0.0 1.0 +link direction +true +0 +Line -7500403 true 150 150 90 180 +Line -7500403 true 150 150 210 180 +@#$#@#$#@ +0 +@#$#@#$#@ diff --git a/1870-Schliemann-001/netlogo_implementation/documentation/TroyDestroy interface.png b/1870-Schliemann-001/netlogo_implementation/documentation/TroyDestroy interface.png new file mode 100644 index 0000000..45f7f80 Binary files /dev/null and b/1870-Schliemann-001/netlogo_implementation/documentation/TroyDestroy interface.png differ diff --git a/1870-Schliemann-001/netlogo_implementation/documentation/TroyDestroy_agents interface.png b/1870-Schliemann-001/netlogo_implementation/documentation/TroyDestroy_agents interface.png new file mode 100644 index 0000000..49cec52 Binary files /dev/null and b/1870-Schliemann-001/netlogo_implementation/documentation/TroyDestroy_agents interface.png differ diff --git a/1870-Schliemann-001/netlogo_implementation/documentation/instructions.md b/1870-Schliemann-001/netlogo_implementation/documentation/instructions.md new file mode 100644 index 0000000..fabc8ed --- /dev/null +++ b/1870-Schliemann-001/netlogo_implementation/documentation/instructions.md @@ -0,0 +1,23 @@ +# Instructions + +## Version without agents + +1. Select input values in the interface: + 1. `par_greeks-strength`, `par_trojans-strength`: the strength of the contending armies (if could represent number of soldiers, units, etc). The interface sliders allow for 0 to 100, but this is not required by design. + 2. `par_destruction-rate`: this is a multiplier rate expressing how many much attackers strength, weighted in relation to the defenders strength, is necessary to decrease one unit of the city health. +2. Press "setup". Observe that a default value for `troy-health` is assigned in code (`init-troy-health`). +3. Press "resolve-trojan-war". +4. Observe change in `troy-health` + +![](TroyDestroy%20interface.png) + +## Version with agents + +1. Select input values in the interface: + 1. `par_greeks-strength`, `par_trojans-strength`: the strength of the contending armies (if could represent number of soldiers, units, etc). The interface sliders allow for 0 to 100, but this is not required by design. + 2. `par_destruction-rate`: this is a multiplier rate expressing how many much attackers strength, weighted in relation to the defenders strength, is necessary to decrease one unit of the city health. +2. Press "setup". +3. Press "resolve-trojan-war". +4. Observe change in `troy-health` + +![](TroyDestroy_agents%20interface.png) diff --git a/1870-Schliemann-001/netlogo_implementation/documentation/tableOfContents.md b/1870-Schliemann-001/netlogo_implementation/documentation/tableOfContents.md new file mode 100644 index 0000000..ada3749 --- /dev/null +++ b/1870-Schliemann-001/netlogo_implementation/documentation/tableOfContents.md @@ -0,0 +1,13 @@ +(DUMMY EXAMPLE) TroyDestroy. Bronze Age siege and its destructive effect on settlement +# Documentation - NetLogo implementation +## Table of contents + +- [`instructions.md`](instructions.md) + +- [`TroyDestroy interface.png`](TroyDestroy%20interface.png) + +![`TroyDestroy interface.png`](TroyDestroy%20interface.png) + +- [`TroyDestroy_agents interface.png`](TroyDestroy_agents%20interface.png) + +![`TroyDestroy_agents interface.png`](TroyDestroy_agents%20interface.png) diff --git a/1870-Schliemann-001/python_implementation/Army.py b/1870-Schliemann-001/python_implementation/Army.py new file mode 100644 index 0000000..d2332a3 --- /dev/null +++ b/1870-Schliemann-001/python_implementation/Army.py @@ -0,0 +1,5 @@ +class Army: + """Class representing an army""" + + def __init__(self, strength): + self.strength = strength diff --git a/1870-Schliemann-001/python_implementation/City.py b/1870-Schliemann-001/python_implementation/City.py new file mode 100644 index 0000000..c2e6b15 --- /dev/null +++ b/1870-Schliemann-001/python_implementation/City.py @@ -0,0 +1,13 @@ +class City: + """Class representing the city under siege""" + + def __init__(self, health): + self.health = health + + def get_effect_of_war(self, aggressor_strength, defender_strength, destruction_rate): + """Return the destruction level based on army strengths and a destruction rate""" + return max(0, (self.health - destruction_rate * (aggressor_strength ** 2) / defender_strength)) + + def resolve_war(self, aggressor_strength, defender_strength, destruction_rate): + """Resolve the destruction level based on army strengths and a destruction rate and update city health""" + self.health = self.get_effect_of_war(aggressor_strength, defender_strength, destruction_rate) diff --git a/1870-Schliemann-001/python_implementation/demonstration.ipynb b/1870-Schliemann-001/python_implementation/demonstration.ipynb new file mode 100644 index 0000000..70131f7 --- /dev/null +++ b/1870-Schliemann-001/python_implementation/demonstration.ipynb @@ -0,0 +1,112 @@ +{ + "cells": [ + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "# (DUMMY EXAMPLE) TroyDestroy. Bronze Age siege and its destructive effect on settlement\n", + "Import `Army` and `City`:" + ] + }, + { + "cell_type": "code", + "execution_count": 1, + "metadata": {}, + "outputs": [], + "source": [ + "from Army import Army\n", + "from City import City" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Assign input values:" + ] + }, + { + "cell_type": "code", + "execution_count": 2, + "metadata": {}, + "outputs": [], + "source": [ + "GREEKS_STRENGTH = 100\n", + "TROJANS_STRENGTH = 50\n", + "DESTRUCTION_RATE = 0.42\n", + "\n", + "TROY_HEALTH = 100" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Initialise instances of `Army` (Greeks, Trojans) and `City` (Troy):" + ] + }, + { + "cell_type": "code", + "execution_count": 3, + "metadata": {}, + "outputs": [], + "source": [ + "greeks = Army(GREEKS_STRENGTH)\n", + "\n", + "trojans = Army(TROJANS_STRENGTH)\n", + "\n", + "troy = City(TROY_HEALTH)" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Execute the algorithm using the instances and printing the Troy's health before and after the war: " + ] + }, + { + "cell_type": "code", + "execution_count": 4, + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Troy health before war: 100\n", + "Troy health after war: 16.0\n" + ] + } + ], + "source": [ + "print(\"Troy health before war: \" + str(troy.health))\n", + "\n", + "troy.resolve_war(GREEKS_STRENGTH, TROJANS_STRENGTH, DESTRUCTION_RATE)\n", + "\n", + "print(\"Troy health after war: \" + str(troy.health))" + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.9.0" + } + }, + "nbformat": 4, + "nbformat_minor": 2 +} diff --git a/1870-Schliemann-001/python_implementation/documentation/tableOfContents.md b/1870-Schliemann-001/python_implementation/documentation/tableOfContents.md new file mode 100644 index 0000000..c7ecac4 --- /dev/null +++ b/1870-Schliemann-001/python_implementation/documentation/tableOfContents.md @@ -0,0 +1,5 @@ +(DUMMY EXAMPLE) TroyDestroy. Bronze Age siege and its destructive effect on settlement +# Documentation - Python implementation +## Table of contents + +- [`demonstration.ipynb`](demonstration) diff --git a/1870-Schliemann-001/python_implementation/main.py b/1870-Schliemann-001/python_implementation/main.py new file mode 100644 index 0000000..b9e4918 --- /dev/null +++ b/1870-Schliemann-001/python_implementation/main.py @@ -0,0 +1,25 @@ +"""Python implementation of TroyDestroy""" +from Army import Army +from City import City + +# input +GREEKS_STRENGTH = 100 +TROJANS_STRENGTH = 50 +DESTRUCTION_RATE = 0.42 + +TROY_HEALTH = 100 + +# initialise +greeks = Army(GREEKS_STRENGTH) + +trojans = Army(TROJANS_STRENGTH) + +troy = City(TROY_HEALTH) + +print("Troy health before war: " + str(troy.health)) + +# algorithm execution +troy.resolve_war(GREEKS_STRENGTH, TROJANS_STRENGTH, DESTRUCTION_RATE) + +# output +print("Troy health after war: " + str(troy.health)) diff --git a/1870-Schliemann-001/references.bib b/1870-Schliemann-001/references.bib new file mode 100644 index 0000000..6858af8 --- /dev/null +++ b/1870-Schliemann-001/references.bib @@ -0,0 +1,17 @@ + +@book{homer_iliad_1865, + title = {The {Iliad} of {Homer}}, + language = {en}, + publisher = {J. Murray}, + author = {Homer}, + year = {1865}, + note = {Google-Books-ID: EEYbAAAAYAAJ}, +} +@misc{nassa_guide_submissions, + title = {Guide for submissions | NASSA}, + url = {https://archaeology-abm.github.io/NASSA-hub/NASSA-hub/guide-for-submissions.html}, + abstract = {Network for Agent-based modelling of Socio-ecological Systems in Archaeology}, + language = {en-US}, + urldate = {2024-01-29}, + journal = {NASSA}, +}