student-housing2205_withINFO.nlogo

;;; ASSIGNMENT 3
;;; GROUP 1: Grace, John, Axel, Sophia

globals [
  percent-similar  ; on the average, what percent of a turtle's neighbors
                   ; are the same color as that turtle?
  percent-unhappy  ; what percent of the turtles are unhappy?
  pandemic-timer   ; monitors ticks until the next pandemic
  peace-price      ; placeholder for price change during pandemics -> allows us to turn pandemics off
]

turtles-own [
  happy?           ; for each turtle, indicates whether at least %-similar-wanted percent of
                   ;   that turtle's neighbors are the same color as the turtle
  similar-nearby   ; how many neighboring patches have a turtle with my color?
  other-nearby     ; how many have a turtle of another color?
  total-nearby     ; sum of previous two variables
  student?         ; defines if a turtle is a student or not
]

patches-own[
  studenthousing?  ; is the patch reserved for students or not?
  price            ; the price of patch
  balcony         ; whether the patch has a balcony
]

to setup
  clear-all
  ; create turtles on random patches.
  ifelse Pandemic = true [set peace-price 1] [set peace-price 0] ; price will later only decrease during pandemics, therefore we set the "peace-price" to 0 here (see update-globals)
  ask patches [

    set pcolor white
    set price random 50
    set balcony (random 2 = 1)
    if random 100 < density [   ; set the occupancy density
      sprout 1 [
        ; 105 is the color number for "blue"
        ; 27 is the color number for "orange"
        set color one-of [105 27]
        set size 1
      ]
    ]
  ]



  create-students ; create students only during setup
  create-studenthousing ; creates patches reserved for students
  ask patches [
    ifelse pcolor = green [ set studenthousing? true ] [ set studenthousing? false]
  ]
  update-turtles
  update-globals
  reset-ticks
end

; run the model for one tick
to go
  if (all? turtles [ happy? ] or ticks = 100) [ stop ]
  move-unhappy-turtles
  update-turtles
  update-globals
  kick-out-non-students
  ifelse ticks mod 5 = 0 [
    set pandemic-timer "pandemic"     ; "pandemic" occurs every 5 ticks
  ] [set pandemic-timer "peacetime"]   ; otherwise no pandemic
  tick
end

to create-students ; create students using input from slider
  let percentage student-slider
  let num-students round ((percentage / 100) * count turtles)

  ask turtles [
    set student? false
  ]

  ask n-of num-students turtles [
    set student? true
  ]
end

;; old create-studenthousing function
;to create-studenthousing
;  let num-housing round (housing-share * count patches)
;  ask patches [
;    set studenthousing? false
;  ]
;  ask n-of num-housing patches [
;    set studenthousing? true
;  ]
;  ask patches[
;    if studenthousing? [set pcolor green]
;  ]
;
;end

to create-studenthousing
  let num-studenthousing student-hubs ; setting the number of student hubs using slider

  repeat num-studenthousing [
    let random-patch one-of patches with [not any? neighbors4 with [pcolor = red]] ; Select a random patch without any neighboring student housing

    ask random-patch [
      set pcolor green ; Set the patch color to designate student housing
    ]
  ]
  spread-studenthousing
end

to spread-studenthousing
  let radius student-housing-radius
  let student-housing-patches patches with [pcolor = green] ; Get all the designated student housing patches

  ask student-housing-patches [

    ask patches in-radius radius [
        set pcolor green ; Set the patch color to designate student housing
      ]
    ]
end

to kick-out-non-students
    ; Iterate over all student-only housing patches
    ask patches with [studenthousing?] [
      ; Remove non-students from the patch
      ask turtles-here with [not student?] [find-new-spot-new]
    ]
end


; unhappy turtles try a new spot
to move-unhappy-turtles
  ask turtles with [ not happy? ]
    [ find-new-spot-new ]
end


to find-new-spot-new

  ; variable to check for available student-only housing nearby
  let student-only-patches patches with [studenthousing? and not any? other turtles-here] in-radius 3

  ; variable to check for available non-student housing nearby
  let non-student-patches patches with [not studenthousing? and not any? other turtles-here] in-radius 3

  ; Check if there are available student-only housing patches nearby
  ifelse student? and any? student-only-patches [
    let target-patch one-of student-only-patches
    ; Move to a random patch within student-only-patches
    move-to target-patch
    ;output-print "found housing as student"
  ]
  ; Check if there are available non-student housing patches
  [ ifelse any? non-student-patches [
    let target-patch one-of non-student-patches
    ; Move to a random patch within non-student-patches
    move-to target-patch
    ;output-print "found housing normal"
  ]
  ; If there is no available housing nearby, move to patch with cheapest price
  [ move-to min-one-of patches with-min [price] [price]
    ;output-print "found housing with price"
  ]]
end


to update-turtles
  ask turtles [
    ; in next two lines, we use "neighbors" to test the eight patches
    ; surrounding the current patch
    set similar-nearby count (turtles-on neighbors)  with [ color = [ color ] of myself ]
    set other-nearby count (turtles-on neighbors) with [ color != [ color ] of myself ]
    set total-nearby similar-nearby + other-nearby
    set happy? similar-nearby >= (%-similar-wanted * total-nearby / 100)
    ; add visualization here
    ask turtles with [student? = true] [set shape "triangle"]
    if visualization = "old" [ set shape "circle" set size 1.3 ]
    if visualization = "square-x" [
      ifelse happy? [ set shape "circle" ] [ set shape "X" ]
    ]
  ]
end


to update-globals

  if pandemic-timer = "pandemic" [ ; increase patch price if there is a pandemic
    ask patches [
      ifelse balcony
        [ set price (price + 5) ]
        [ set price (price - peace-price) ] ; if there is no pandemic, the price won't be decreased.
    ]
  ]

  let similar-neighbors sum [ similar-nearby ] of turtles
  let total-neighbors sum [ total-nearby ] of turtles
  set percent-similar (similar-neighbors / total-neighbors) * 100
  set percent-unhappy (count turtles with [ not happy? ]) / (count turtles) * 100
end


; Copyright of original Model: 1997 Uri Wilensky.
@#$#@#$#@
GRAPHICS-WINDOW
375
10
791
427
-1
-1
8.0
1
10
1
1
1
0
1
1
1
-25
25
-25
25
1
1
1
ticks
30.0

MONITOR
265
365
355
410
% unhappy
percent-unhappy
1
1
11

MONITOR
265
220
355
265
% similar
percent-similar
1
1
11

PLOT
10
140
260
285
Percent Similar
time
%
0.0
5.0
0.0
100.0
true
false
"" ""
PENS
"percent" 1.0 0 -16777216 true "" "plot percent-similar"

SLIDER
10
95
285
128
%-similar-wanted
%-similar-wanted
0
100
50.0
1
1
%
HORIZONTAL

BUTTON
10
55
90
88
setup
setup
NIL
1
T
OBSERVER
NIL
NIL
NIL
NIL
1

BUTTON
200
55
285
88
go
go
T
1
T
OBSERVER
NIL
NIL
NIL
NIL
0

BUTTON
100
55
190
88
go once
go
NIL
1
T
OBSERVER
NIL
NIL
NIL
NIL
0

CHOOSER
801
380
950
425
visualization
visualization
"old" "square-x"
1

SLIDER
10
10
285
43
density
density
50
99
90.0
1
1
%
HORIZONTAL

PLOT
10
295
260
445
Number-unhappy
NIL
NIL
0.0
10.0
0.0
100.0
true
false
"" ""
PENS
"default" 1.0 0 -16777216 true "" "plot count turtles with [not happy?]"

MONITOR
265
315
355
360
num-unhappy
count turtles with [not happy?]
1
1
11

MONITOR
265
170
355
215
# agents
count turtles
1
1
11

SLIDER
85
500
257
533
student-housing-radius
student-housing-radius
1
10
3.0
1
1
NIL
HORIZONTAL

MONITOR
435
455
557
500
pandemic indicator 
pandemic-timer
17
1
11

SLIDER
85
460
257
493
student-slider
student-slider
1
100
1.0
1
1
NIL
HORIZONTAL

SWITCH
600
460
702
493
Pandemic
Pandemic
0
1
-1000

SLIDER
85
545
257
578
student-hubs
student-hubs
1
10
10.0
1
1
NIL
HORIZONTAL

@#$#@#$#@
## HOW TO USE THE MODEL

Click the SETUP button to set up the agents. There are approximately equal numbers of orange and blue agents. The agents are set up so no patch has more than one agent.  Click GO to start the simulation. If agents don't have enough same-color neighbors, they move to a nearby patch. (The topology is wrapping, so that patches on the bottom edge are neighbors with patches on the top and similar for left and right).

The DENSITY slider controls the occupancy density of the neighborhood (and thus the total number of agents). (It takes effect the next time you click SETUP.)  The %-SIMILAR-WANTED slider controls the percentage of same-color agents that each agent wants among its neighbors. For example, if the slider is set at 30, each blue agent wants at least 30% of its neighbors to be blue agents.

The % SIMILAR monitor shows the average percentage of same-color neighbors for each agent. It starts at about 50%, since each agent starts (on average) with an equal number of orange and blue agents as neighbors. The NUM-UNHAPPY monitor shows the number of unhappy agents, and the % UNHAPPY monitor shows the percent of agents that have fewer same-color neighbors than they want (and thus want to move). The % SIMILAR and the NUM-UNHAPPY monitors are also plotted.

The STUDENT-SLIDER lets the user set the percentage of students of all agents, ranging from 1 to 100. This means that at least 1% of all inhabitants are students. The STUDENT-HUBS slider similarly lets the user decide how many blocks of student housing should be simulated, ranging from 1 to 10 hubs. The STUDENT-HOUSING-RADIUS slider then controls the "size" of the student housing using radius. Users can choose to set the radius to values between 1 and 10.

The PANDEMIC switch enables the user to chose if pandemics should happen every fifth tick (ON) or not (OFF). The pandemic monitor shows if there is currently a pandemic happening or not (these periods are called "peacetime").

The VISUALIZATION chooser gives two options for visualizing the agents. The OLD option uses the visualization that was used by the segregation model in the past. The SQUARE-X option visualizes the agents as squares. Unhappy agents are visualized as Xs.
Students are visualized as triangles.


## DESCRIPTION ACCORDING TO ODD PROTOCOL




## CREDITS AND REFERENCES

Railsback, S. F. and Grimm, V. (2019). Agent-Based and Individual-Based Modeling. A Practical Introduction. Princeton and Oxford: Princeton University Press.

Schelling, T. (1978). Micromotives and Macrobehavior. New York: Norton.

Wilensky, U. (1997). NetLogo Segregation model. http://ccl.northwestern.edu/netlogo/models/Segregation. Center for Connected Learning and Computer-Based Modeling, Northwestern University, Evanston, IL.




@#$#@#$#@
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

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

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

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

person2
false
0
Circle -7500403 true true 105 0 90
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 285 180 255 210 165 105
Polygon -7500403 true true 105 90 15 180 60 195 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

square
false
0
Rectangle -7500403 true true 30 30 270 270

square - happy
false
0
Rectangle -7500403 true true 30 30 270 270
Polygon -16777216 false false 75 195 105 240 180 240 210 195 75 195

square - unhappy
false
0
Rectangle -7500403 true true 30 30 270 270
Polygon -16777216 false false 60 225 105 180 195 180 240 225 75 225

square 2
false
0
Rectangle -7500403 true true 30 30 270 270
Rectangle -16777216 true false 60 60 240 240

square-small
false
0
Rectangle -7500403 true true 45 45 255 255

square-x
false
0
Rectangle -7500403 true true 30 30 270 270
Line -16777216 false 75 90 210 210
Line -16777216 false 210 90 75 210

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 0 0 0 300 300 300 30 30

triangle2
false
0
Polygon -7500403 true true 150 0 0 300 300 300

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

x
false
0
Polygon -7500403 true true 300 60 225 0 0 225 60 300
Polygon -7500403 true true 0 60 75 0 300 240 225 300
@#$#@#$#@
NetLogo 6.3.0
@#$#@#$#@
@#$#@#$#@
@#$#@#$#@
@#$#@#$#@
@#$#@#$#@
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
@#$#@#$#@
1
@#$#@#$#@