RTZen Quickstart Guide

1. Install the following modules before installing RTZen:
   
   • The latest version of Java (version 1.4 or higher required).
   • The latest version of Ant (version 1.6 or higher required).
     • Put Ant's bin directory in your path.
     • Set ANT_HOME environment variable as the ANT installation directory
   • Download the AspectJ installer here. (this is an executable jar)
     • Copy the aspectjrt.jar and aspectjtools.jar to your ANT_HOME/lib directory
     • Put Aspectj's bin directory in your PATH
     • Put aspectjrt.jar and aspectjtools.jar in your CLASSPATH
   • At least one of the latest RTSJ VMs or ahead-of-time compilers
     [Optional: Only need it for real-time systems]
     • TimeSys Java Reference Implementation (RI)
       • Set RI_BASE environment variable as the TimeSys RI installation directory
     • OVM interpreter or j2c ahead-of-time compiler
     • jRate ahead-of-time compiler
   
   
   
2. Download and Extract RTZen
   
   • RTZen offical release is comming soon. You may download the snapshots here.
   • On Windows, it is recommended that you not extract RTZen to the Desktop. You're best off extracting it to the root of the drive (i.e. c:\ or d:\) in order to keep path names as short as possible, and without spaces.
   • On Unix-based systems, you can make a directory called "RTZen" in your home directory and extract it there.
   
   
   
3. Build RTZen
   • If necessary, edit zen-build.properties and choose the apropriate RTSJ VM. (Make sure that the related installation path settings are correct.)
   • Run ./composeVersion.sh
   • Run ant
   
   
   
4. Run a simple demo
   • Go to the packages\demo\hello directory of the RTZen root.
   • To run the demo on normal jvm
     • Type "ant".
     • Type "ant server".
     • Open up another shell to the same directory and type "ant client".
   • To run the demo on TimeSys Java Reference Implementation (RI)
     • Type "ant".
     • source the timesys-env script file in the bin directory of the RTZen root.
     • Run "sh timesys_server.sh" to start the server.
     • Open up another shell to the same directory and run "sh timesys_client.sh" to start the client.
   • To run the demo on OVM interpreter
     • Type "ant".
     • Make sure that the "OVM_root" and "RTZen_root" variables are set correctly in each of the script files mentioned below.
     • Go to ovm_server_int directory, run "compile.sh", which will generate an img file for server using OVM interpreter.
     • Go to ovm_client_int directory, run "compile.sh", which will generate an img file for client using OVM interpreter.
     • In the "ovm_server_int" directory, run "run.sh"
     • Open another shell, in the "ovm_client_int" directory, run "run.sh"
   • To run the demo on OVM j2c ahead-of-time compiler
     • The running of the demo on OVM interpreter is required before to compile the demo to native code. This is because some outputs of the demo running in interpreter way are needed to compile demo to native code.
     • Copy the "methods" and "classes" files from the "ovm_server_int" and "ovm_client_int" directories to "ovm_server_nat" and "ovm_client_nat" directories, respectively.
     • Make sure that the "OVM_root" and "RTZen_root" variables are set correctly in each of the script files mentioned below.
     • In the "ovm_server_nat" directory, run "compile.sh", which will generate an img file for server using j2c compiler.
     • In the "ovm_client_nat" directory, run "compile.sh", which will generate an img file for client using j2c compiler.
     • In the "ovm_server_nat" directory, run "run.sh"
     • Open another shell, in the "ovm_client_nat" directory, run "run.sh"
   • To run the demo on jRate ahead-of-time compiler
     • Make sure to set $RTZen_root/lib directory in the LD_LIBRARY_PATH variale.
     • Source jRate/script/jRate-env.sh
     • Type "ant".
     • Run "./server" to start the server.
     • Open up another shell to the same directory and run "./client" to start the client.

Congratulations!! You successfully installed RTZen and run your first demo!

If you had trouble with any of the steps above, please post a question to the RTZen users group and we will respond promptly.

UCI | DOC
Updated: March 27, 2006