/*
 * Copyright (c) 1995, 1996, 1997 Center for Advanced Computing and Communications (CACC),
 * North Carolina State University at Raleigh.
 * All rights reserved.
 * Permission to use, copy, modify, and distribute this software and its
 * documentation for any purpose and without fee is hereby granted, provided
 * that the above copyright notice appear in all copies and that both that
 * copyright notice and this permission notice appear in supporting
 * documentation.  The CACC makes no representations about the
 * suitability of this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

Introduction:

MCRSIM is a package for creating and editing computer network graphs, 
applying multicast routing algorithms on these graphs, and simulating the flow 
of cells on the resulting trees to measure delays and losses. It simulates
actual ATM networks with fixed cell size, 53 bytes, and heterogenous link 
capacities.

MCRSIM is written in C++ and uses Motif and X library functions to implement
the graphical user interface. It operates on Unix machines supporting the
Xwindows environment.

For information on how to use MCRSIM, please refer to the user manual: 
user_manual.ps. The man page `mcrsim.man' also provides a brief description of 
the simulator.



Please report any bugs to h.f.salama@ieee.org.



Installation Steps:

Edit lines 9 to 14 and 21 to 26 of the makefile to include the correct paths 
of the X11 and Motif include files and object files for your machine.

Edit lines 35 and 36 of the file ``node2.h'' to set the value of
RAND_REF according to your machine.

Use the enclosed makefile to compile the program by simply 
typing: `make mcrsim'. Ignore any warnings you may get. The resulting binary 
file is called `mcrsim'.

A GNU C++ compiler, `g++', must be installed on the machine used to compile 
MCRSIM.

To run MCRSIM, simply type ``mcrsim''.


Example network files are also included: net20, net50, net100, and net200.

NOTE: Simulation can be also performed in batch mode without any need 
      for the graphical user interface. Two example batch simulation
      programs are included: router1.c and router2.c. To create
      the executables use `make router1' and `make router2' respectively.

NOTE 2: The original version of MCRSIM was released in August 1995. This a revised
        version, released in September 1997.