## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##
# README --- instructions for the Cell
#                       ------------------------------
#                             Copyright (c) 2007
#                                Reehan SHAIKH
#                        McGill University (Montreal)
#                       ------------------------------
## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

Installing PyDEVS:

1 Download the PyDEVS package from the MSDL webpage.
  http://moncs.cs.mcgill.ca/MSDL/research/projects/DEVS/
  This is a file called pydevs.zip.

2 Unpack it where ever you like. This should give you a
  folder called pydevs. Within this folder are the PyDEVS
  files needed for simulation as well as an examples folder
  to help you get started.

Directory structure:

1 You must have already unpacked cell.zip in order to be
  reading this!

2 This README is in a folder called cell.
  The file cellExperiment.py implements the simulation.
  The file cellModel.py implements the model.
  The file output.sim is a specific simulation trace
  needed for the GUI.
  The file trace is the standard PyDEVS simulation trace.

3 Within the cell folder is a folder called gui.
  The file cellGUI.py implements the visual simulator.

4 Within the gui folder is a folder called images.
  This folder contains all the images displayed by the
  visual simulator.

Running the Cell model:

1 Open the file cellModel.py and line 13 indicates the path
  where the pydevs package lives. For example, I unpacked
  the pydevs package in a folder called src in my home
  directory. Change this to indicate where your pydevs
  pydevs package resides.

2 Do the same for cellExperiment.py (also on line 13).

3 From the terminal, issue the command
  python cellExperiment.py
  This will create a file called output.sim. It will also
  give the standard output on the terminal. To save this
  output trace into a file, run the command
  python cellExperiment.py > fileName

Using the visual simulator:

1 After running the model and creating a .sim file,
  go into the gui folder and run the command
  python cellGUI.py
  Open the .sim file via the File menu.
  Under the Simulation menu, Start the simulation.

Enjoy.

## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ## ##

Questions, comments, criticisms:
reehan.shaikh@cs.mcgill.ca
