Merge branch 'main' of https://github.com/erick2307/TUNAMI-EVAC1

README.md

@@ -1,2 +1,20 @@
 # TUNAMI-EVAC1
- An ABM model of tsunami evacuation
+---
+In this repository you will find an [Agent-Based Model](https://en.wikipedia.org/wiki/Agent-based_model) developed for [Tsunami Evacuation](https://link.springer.com/article/10.1007/s00024-015-1105-y) Analysis.  
+The model was developed using [NetLogo](https://ccl.northwestern.edu/netlogo/) v.5.0.1 back in 2012.  
+The details of the development and applications are described in my [PhD Thesis](/resources/PhD_Thesis_ErickMas.pdf) at [Tohoku University](http://www.tohoku.ac.jp/en/).  
+
+The model has not been updated since 2014 (published on April 2022 in Github, I know...why so late? no idea!).  
+My latest trial of the model worked in Version 6.2.2 of NetLogo. (2022.04.20)
+
+The case test in this repo takes about 15 min to run a simulation of a 70 min evacuation.
+
+## Getting Started
+---
+Clone this repo and open the `.nlogo` file in Netlogo.  
+You can download NetLogo [here](https://ccl.northwestern.edu/netlogo/download.shtml).
+
+---
+## Example
+
+[Animation](http://www.regid.irides.tohoku.ac.jp/erick/repository/netlogo/Model67.mp4)