xtc Installation Notes

This page provides step-by-step instructions for intalling xtc's source release. A separate page provides the reference for xtc's development setup.

Step by Step

Remember to fix any errors before moving on to the next step.

1. Be sure that you are running the bash shell. It is the default interactive shell on both Mac OS and Linux.
2. Install all necessary Unix command line tools (including make), the Java Development Kit (JDK), and DejaGnu:
   • On Linux, these tools need to be installed individually and you probably want to use a package manager. For example, when using the Ubuntu distribution of Linux, you can install all necessary tools by executing the following two commands:

     sudo apt-get update
     sudo apt-get install build-essential openjdk-6-jdk dejagnu
     

     The first command updates APT's package index, and the second command installs the build-essential, openjdk-6-jdk, and dejagnu packages as well as their dependencies. Since these commands change your system's configuration, you will need to provide your superuser password.
   • On Mac OS X, necessary Unix command line tools and the JDK are automatically installed with Apple's XCode IDE. However, after installing XCode, you still need to install DejaGnu. First, download its source distribution. Second, in the root directory of the source distribution, execute the following three commands (which are the customary incantations for installing all GNU software):

     ./configure
     make
     sudo make install
     

     The first command determines your system's tools and configuration. The second command builds the binaries. The third command moves the binaries in the right location. Since the last command changes your system's configuration, you will need to provide your administrator password.
3. Download xtc:
   • Download xtc's source distribution and place the directory in a convenient location.
   • Download xtc's test suite. Place the test suite's data and fonda directories inside the xtc directory contained in the source distribution.
   • Download xtc's dependencies and place the JAR files contained in that ZIP file in xtc's bin directory.
4. Edit xtc's configuration script in setup.sh:
   • JAVA_DEV_ROOT must point to xtc's directory.
   • CLASSPATH must point to the classes directory and the junit.jar and javabdd.jar JAR files.
   • JAVA_HOME must point to your Java installation.
     • On Mac OS X, it is /Library/Java/Home.
     • On Linux, it depends on Java's install location. For example, on Ubuntu running OpenJDK 6, it is /usr/lib/jvm/java-6-openjdk.
5. Source xtc's configuration script:

   source setup.sh
   

   or

   . setup.sh
   

   This makes the environment variable definitions visible in the current shell. You need to perform this step every time you start a new shell, e.g., by opening a terminal window.
6. Build xtc:

   make configure
   make
   make doc
   

   The first command configures xtc for your system's C compiler. The second command builds xtc's classes. The third command builds xtc's documentation (to be found in the doc subdirectory).
7. Test xtc:

   make check
   

   If the command completes with “*** Happy happy joy joy! ***,” your are in great shape.
8. Start developing your own code:
   • Add a new package, say the.package.name, by creating the src/the/package/name directory.
   • Copy the make file template into that directory and rename it to Makefile.
   • Update the Makefile for your new package by changing the definitions for PACKAGE, PACKAGE_LOC, and SOURCE.
   • Add your new package to the Makefile in xtc's root directory, i.e., by adding the package name to the list of packages PACKAGES.
   You are good to go.