/appl/repast/Demos-3/Readme.txt 
-------------------------------

This directory contains various demos of repast models, 
mainly intended for educational purposes (vs "real research").   
However, they can serve as starting points for models to be used for research.
In each directory, see the Readme.txt as a starting point.

Note there is a utility for copying any of the models
(or any model of your derived from these) into
a new directory of your own, perhaps with a new name:

   /appl/repast/Demos-3/bin/copyProject.pl 
             
This is a generic perl script to copy and optionally rename a 
program (package).   Run with -h to get help:
   /appl/repast/Demos-3/bin/copyProject.pl -h
on to use it.   This should be usable with any of the
programs below, to copy from there into another user's space,
perhaps renaming the program (package).

NB: Some of the notes-*.txt files in the directories below
may be a bit out of date.  E.g., they may talk about making copies
of the models "by hand" vs. using the above copyProject.pl script.

----------------------------------------------------------------------------


heatBugs3/   *** Recommended version for new users ***
             This has methods and classes so that heatBugs can be
             run via drone.  Also added a few new features to the
             basic model (e.g., a randomMoveProbability).   
             See various notes* files for the parts that were added
             and what they are for...these can be used as a guide
             to adding these features to other Repast models.
     
             See this directory:
                /users/rlr/RePast/Demos-2/heatBugs 
             for the version from Repast distribution, but using ant build.xml
             to control compiling, running, saving.  This directory also has
             notes on the general structure of repast models
             based on the SimModelImpl class.

SIR1/        A simple SIR epidemiological model, using discrete time.

SIR1_DS/     SIR1 but using a simple DES dynamic schedule.

RandomMoveInGrid/
             A simple starting point for agents in a 2D grid,
	     using discrete time updating.  This does use the ModelParameters
	     class from UM, so it can be used with Drone.
	     Thus its a good place to start building more complex models,
	     even if you end up tearing out the 2D space!

MinimalA/    An extremely simple 'starting point' -- it has a minmal Agent
             that does almost nothing each time step.  The GUI has nothing
             besides the basic RePast control panel.
             This is a good place to start if you want to build your own
             model in a way that will be easy to use with drone.

Template2/   Another 'starting point' program --- it has minimal Agent's that
             do minimal actions, so that its easy to replace those
             with a "real model".  However, this is a bit
             more complicated that some of the above models, in that it
             has generic codes for saving all GUI-changes to report files,
             for reading those from files to reproduce runs, loading
             agents from an xml formated file, etc.











===========================================================================
===========================================================================
===========================================================================
*
* The rest of this file are some notes on converting projects, etc.
* You probably don't need to read this.
*
===========================================================================
===========================================================================
===========================================================================
How to Convert from RePast 2.2 to 3.0
-------------------------------------

The simplest way to convert your CSCS model from RePast 2.2 to RePast
3.0 is to use the script we created. The script is:

/appl/repast/convert-repast2.2-to-repast3.0.sh

To use the script, simply type:

/appl/repast/convert-repast2.2-to-repast3.0.sh [directory of your model]

If the script does not work, use the instructions below to convert
your model manually.
--------------------------------------------------------------------
How to upgrade to latest (1.5.0) Java

To upgrade to this newer release, edit your ~/.antrc file and change
the JAVA_HOME line to say:

export JAVA_HOME=/appl/jdk3d1.5.0

For use on linux, if your application has a file

    bin/batchrun.sh

you should also change this line in that file:

   JAVADIR=/appl/j2sdk3d1.4.2

to:

   JAVADIR=/appl/jdk3d1.5.0

New features in Java 5.0  (aka 1.5.0) are described on this page:
   http://java.sun.com/j2se/1.5.0/docs/relnotes/features.html

--------------------------------------------------------------------
To copy a RePast project dir:

/users/rlr/RePast/Demos-2/bin/copyProject.pl \
    -S<sourceRootPath> -X<oldProjectName> \
    -R<newRootPath>  -P<newProjectName> 
where 
  -S<sourceRootPath>  path to just above project to copy
  -X<oldProjectName>   name of project to copy
     That is, the package name for the program.
     So it should be in <currentRootPath>/<oldProject>
  -R<newRootPath>  path to just above new copy
  -P<newProjectName>   new name for project/package
Note the back-slashes ( \ ) are to tell linux to 
  continue reading command on next line
So if you enter it all on one line, leave out the back-slashes.

For example, to copy the heatBugs2 project from 
/users/rlr/RePast/Demos-2/ to /users/rlr/RePastDemos-3/ enter

 /users/rlr/RePast/Demos-2/bin/copyProject.pl \
    -S/users/rlr/RePast/Demos-2  -XheatBugs2  \
    -R/users/rlr/RePast/Demos-3  -PheatBugs2
----------------------------------------------------------------------