COG-ABM tutorial

Git

COG-ABM is using Git for its version control. See http://git-scm.com/video/what-is-version-control to get some grasp on version control.

http://upload.wikimedia.org/wikipedia/commons/4/44/Git_data_flow_simplified.svg

Tutorials

• http://git-scm.com/book
• http://git-scm.com/videos

Important topics

git commands:

• init
• clone
• add
• commit (-a, -m)
• push
• pull
• stash
• merege
• rebase
• mv
• rm
• blame

Some setup

git config --global user.name "Your Name Comes Here"
git config --global user.email you@yourdomain.example.com

git config --global color.diff auto
git config --global color.status auto
git config --global color.branch auto

Other topics

• Useful app - gitg
• SSH Keys - https://help.github.com/categories/56/articles
• Github comments
• great TAB
• BitBucket for students - free private repos!

Python

http://pl.wikibooks.org/wiki/Zanurkuj_w_Pythonie (polish)

• lists, tuples, dicts, strings
• floats to ints etc.
• print
• classes
• lambdas
• comments
• function defaults argument fials
• *args, **kwargs
• or trick
• PEP8
• iterator/generator

Obtaining COG-ABM

You can make fork from official version (from Github site) and than clone or just clone the repo locally.

Clone repository

git clone https://github.com/CogSys/cog-abm.git COG-ABM

Making virtual environment

This step is optional but recommended.

virtualenv --no-site-packages .env
. .env/bin/activate
deactivate

Installing requirements

pip install -r COG-ABM/requirements.txt

if it fails try installing numpy first:

pip install numpy

For Ubuntu might turn out to be needed:

sudo apt-get install libblas-dev liblapack-dev gfortran gfortran-multilib libfreetype6-dev libpng12-dev

Useful packages

pip install ipython ipdb

Running simulation

Go to:

https://github.com/CogSys/cog-abm/blob/master/src/cog_abm/core/simulation.py#L28

and put:

self.dump_often = True
self.pb = True

This will enable dumps used for generating WCS chips preview and show progress bar. By default disabled due to small slowdown.

Go to src/steels directory and run

python steels_main.py -p simulation_GG.xml -f simulation_results

It should take less than 1 minute to finish. If you can't remember the command :) just type:

python steels_main.py --help

Many programs in COG-ABM have this option

python analyzer.py -f simulation_results it DSA
python analyzer.py -f simulation_results it DS
python analyzer.py -f simulation_results -c it DS
python analyzer.py -f simulation_results it DS min_DSA max_DSA -c --xlabel="Iteration" --ylabel="DS"

Presenter

Go to src/presenter directory and run

python munsell_palette.py -d ../steels/