QUICK INSTALL GUIDE
JavaSim extensions by the Infonet Group of the University of Namur
 - see http://www.infonet.fundp.ac.be - 

A. Introduction
================
This is a quick install guide. It explains how to install and compile:
	- our patched version of JavaSim 1.2.1 
	- our patched version of JavaSim 1.0
	- our BGP model for JavaSim 1.0
	- our MPLS model for JavaSim 1.0/1.2.1
	
A.1 Remark:
-----------
The BGP model is NOT compatible with JavaSim 1.2.1. Please don't ask us when it will be available, the port is not
planned currently. But if you are interrest, you can port it, of course :-)

This guide explains only the use of our patched version. We assume here that
you download the source only version.

If you have any problem with the compiled version, download the source only version
and attempt to compile it before sending any e-mail reporting errors. Thank you !

A.2 Copyright:
--------------
All code is under the GNU General Public License version 2 or FreeBSD/X like open license. For more information 
about open licenses, see the GNU website project at the following address: http://www.gnu.org

B. Acknowledgement
====================
This work is partially funded by the IST Atrium project (http://www.alcatel.be/atrium).


C. Installation
================


C.1 USING JAVASIM 1.0 (BGP, MPLS compatible)
---------------------------------------------

C.1.1 Installation of the infonet-javasim package
- - - - - - - - - - - - - - - - - - - - - - - - -
Here you can find information on how to compile our JavaSim snapshot.

To compile our Javasim 1.0 snapshot:
  0) Download the infonet-javasim package (http://alpha.infonet.fundp.ac.be/javasim)
  1) Download and install the JDK 1.3.x (for JDK 1.4, we must define new functions)
  2) untar and modify 'compile' script to update some path (especially JAVA_HOME)
  3) execute this script

 ... and infonet-javasim should compile.

Don't forget to update your CLASSPATH variable. Again the 'compile' script show which
directory must be included inside the classpath.

Note that the classpath must include:
 your-infonet-javasim-dir/classes:your-infonet-javasim-dir/jars/tcl.zip:your-infonet-javasim-dir/jars/jython.jar:your-infonet-javasim-dir/regexp.jar


C.1.2 Installation of the infonet-util package (useful for both MPLS and BGP)
- - - - - - - - - - - - - - - - - - - - - - - -
  0) Download infonet-util package
  1) untar and compile infonet-util by using 'make'
  2) update your classpath. It must include the directory 'infonet-util'
      with new classes.
	  
C.1.3 Installation of BGP (needs infonet-util)
- - - - - - - - - - - - - 
To add BGP:
  0) Download infonet-bgp package
  1) untar infonet-bgp
  2) compile it with traditional 'make'

 ... and infonet-bgp should compile

Add the infonet-bgp to your classpath. JavaSIM is now BGP-capable.

C.1.4 Installation of MPLS (needs infonet-util)
- - - - - - - - - - - - - -
To add MPLS:
  0) Download infonet-mpls package
  1) untar infonet-mpls
  2) compile it using 'make'
  
  ... and infonet-mpls should compile
  
Add the infonet-mpls directory to your classpath. JavaSIM is now MPLS-capable !





C.2 USING JAVASIM 1.2.1 (MPLS only)
-----------------------------------

C.2.1 Installation of infonet-javasim-1.2.1 package
- - - - - - - - - - - - - - - - - - - - - - - - - -
Method to build javasim-1.2.1:

  0) Download the 'infonet-javasim-1.2.1' package (http://alpha.infonet.fundp.ac.be/javasim)
  1) Download and install the JDK 1.4
  2) untar 'infonet-javasim-1.2.1' and modify the file 'jsim1.2.1.sh'
  		check JAVA_HOME and JAVASIM variable
  3) alter your environment by doing 'source jsim1.2.1.sh'.
  4) type 'make' and javasim-1.2.1 should compile
  
  The 'jsim1.2.1.sh' file informs you on which modifications must be done for javasim.

Note that the classpath must include:
 your-infonet-javasim-dir/classes:your-infonet-javasim-dir/jars/tcl.zip:your-infonet-javasim-dir/jars/jython.jar:your-infonet-javasim-dir/regexp.jar


C.2.2 Installation of the infonet-util package (required for MPLS support)
- - - - - - - - - - - - - - - - - - - - - - - -
  0) Download the infonet-util package
  1) untar this package
  2) compile it with 'make'
  
  Then, infonet-util package should compile correctly. Now we have to update your classpath variable
  to include the 'infonet-util' directory.
  
C.2.3 Installation of MPLS (needs infonet-util)
- - - - - - - - - - - - - - 
   0) Download infonet-mpls package
   1) untar infonet-mpls
   2) compile it using 'make'
   
   ... and infonet-mpls should compile. Don't forget to add the infonet-mpls directory to your classpath
   and your simulator support MPLS.



D. Contact information
=======================
If you have more questions, do not hesitate to contact us at javasim@infonet.fundp.ac.be.


E. Version of this document
===========================
20030519-02-lsw; last-update: 19-MAY-2003