Gene-Environment iNteraction Simulator 2 Files

==============================================
PACKAGE NAME ---> GENS2
VERSION ----> 2.3
LICENCE---> GPL
CREATED BY-> Giovanni Scala <juen85[at]gmail.com>
==============================================

INDEX:

-> Requirements
-> About this package
-> Installation
-> Files and their Proper Directories
-> Playing this plugin
-> Known Bugs & Issues
-> Version History
-> Incompatibilities & Save game warnings
-> Credits & Usage


==============================================
REQUIREMENTS:
==============================================
Before running setup.py make sure following python modules are installed:

python >= 2.6
setuptools
simuPOP
numpy = 1.6.0
scipy = 0.9
openopt = 0.38 (full suite suggested)
wxpython (optional)

==============================================
ABOUT THIS PACKAGE:
===============================================
This package contains python modules to run GENS2 simulation,
and libraries that can be used in simuPOP simulations 
( see simuPOP project for more info).


===============================================
INSTALLATION:
===============================================
Extract the content of the archive in a folder and move to it.
With administrative privileges run :

python setup.py install 


===============================================
FILES USED AND THEIR PROPER DIRECTORIES:
===============================================
With this distribution are provided also a test population "test.pop"
and some configuration file "*.conf" for testing purpose.
If you want to try the application with testing values you must
copy those files in your working directory and select the provided 
test population.

Every time you run GENS2 it will be save a series o files with .conf 
extension to remember input through various simulations, if don't wont 
this just delete those files from your working directory.

===============================================
USING GENS2:
===============================================
There are three way to use GENS2 modules:
	-through a GUI based wizard using command 'python gensGUI.py'
	-through command line typing ' python GENS2.py arguments...] 
	 where 'arguments' indicate a series of argument passed to the application.
	 Type 'python GENS2.py -h' for help about parameters and their meaning.
	-through interactive terminal typing 'python GENS2.py --gui=False'

===============================================
KNOWN ISSUES OR BUGS:
===============================================
The present GENS2 distribution has been tested with the numpy version 1.6.0, scipy version 0.9 and openopt  version 0.38.  Although other versions may be suitable as well, we suggest to use them to avoid unexpected results. 

===============================================
VERSION HISTORY
===============================================
GENS 1.0
GENS 2.0-BETA
GENS 2.1-BETA
GENS 2.2-BETA
GENS 2.3