Skip to content

Commit 476a259

Browse files
committed
Add README
1 parent 7d329f0 commit 476a259

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed

README.rst

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
TourExec
2+
========
3+
4+
This repository contains the software associated with
5+
`Robert Axelrod <http://www-personal.umich.edu/%7Eaxe/>`_'s book `The Complexity of
6+
Cooperation: Agent-Based Models of Competition and Collaboration
7+
<http://press.princeton.edu/titles/6144.html>`_ (Princeton University Press).
8+
9+
The code was originally published by the
10+
`University of Michigan Center for the Study of Complex Systems <http://lsa.umich.edu/cscs/>`_
11+
and is now available from
12+
`Robert Axelrod's personal website <http://www-personal.umich.edu/~axe/research/Software/CC/CC2.html>`_.
13+
14+
The original code has been modified in this repository to ensure that it will
15+
compile successfully using a modern Fortran compiler.
16+
17+
Prerequisites
18+
-------------
19+
20+
You will need the `make <https://www.gnu.org/software/make/>`_ and
21+
`gfortran <https://gcc.gnu.org/fortran/>`_ tools installed on your system
22+
and available from your command line.
23+
24+
To check if you already have them installed:
25+
26+
$ make -v
27+
28+
Should return something similar to:
29+
30+
$ GNU Make 3.81
31+
$ Copyright (C) 2006 Free Software Foundation, Inc.
32+
$ This is free software; see the source for copying conditions.
33+
$ There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A
34+
$ PARTICULAR PURPOSE.
35+
36+
and
37+
38+
$ gfortran -v
39+
40+
should return something similar to:
41+
42+
$ Using built-in specs.
43+
$ Thread model: posix
44+
$ gcc version 7.1.0
45+
46+
Installation
47+
------------
48+
49+
Clone the repository and compile the Fortran code:
50+
51+
$ git clone https://github.com/Axelrod-Python/TourExec.git
52+
$ cd TourExec
53+
$ make
54+
55+
You should now have a `bin` directory containing the the executable file,
56+
`tourexec`, which you can run:
57+
58+
$ cd ../bin
59+
$ ./tourexec

0 commit comments

Comments
 (0)