src/README

   1 Intro
   2 =====
   3 This program is called the bioCity Matrix, and was programmed for my final project in the MAT4199 "Mathematical Models in Evolution and Ecology" class at the University of Ottawa.
   4
   5 It is written in the C++ programming language, without which I probably would not have been able to do a simulation with the speed it provides and the necessary abstraction to painlessly build a virtual world (as compared to C :) ).
   6
   7 I myself am a fan of portability, and indeed the base simulation should painlessly compile on all Unix-like operating systems. Yes, it can be done on Windows as well, but it's more complicated.
   8
   9 For good random number generation I use the GSL scientific library that makes available the Mersenne Twister (mt19937) random number generation algorithm. The GSL as far as I know has only been made to compile under Cygwin (Mingw might work too) so if you would like to get this code to work under Windows, likely you will have to install Cygwin.
  10
  11 How To Use
  12 ==========
  13
  14 So far I've only tested it on Linux.
  15
  16 Unfortunately I've not yet put together configure scripts to make it all nice and neat, so do the following. Install these libraries:
  17
  18 GSL : http://www.gnu.org/software/gsl/
  19 G2: http://g2.sourceforge.net/
  20
  21 Then type "make" in the current directory and hope for the best. If it works you can then type "./bioc" and the program ought to start. As for how to use it: you'll have to edit the source code for now. Sorry. In a couple of weeks I'll make it easy to use.
  22
  23 License
  24 =======
  25
  26 This program is licensed under the GPLv3. The full license is available in the file called "COPYING". If you did not receive this file, please visit http://www.gnu.org/licenses/gpl.html.