Installation

A bundle of the MUSCLE can be downloaded from the Downloads section or directly from this link. The bundled package contains the source code of the MUSCLE, documentation and precompiled Java archives (jar).

Dependencies

The core functionality of the MUSCLE is written in Java. To be able to integrate native code with the MUSCLE, there is also a native part which is written in C++. Bootstrapping and platform independent configuration is done with a highly flexible setup mechanism written in Ruby. In order to use the MUSCLE, you will need a recent Java runtime to run the MUSCLE. You can obtain it at either  http://www.java.com/en/download/index.jsp (Sun-Java) or  http://openjdk.java.net/ (Open-JDK). A recent Ruby installation can be found here:  http://www.ruby-lang.org/en/downloads/. In principle it should be possible to run the MUSCLE with JRuby instead of the standard Ruby. The Java part of the MUSCLE also uses these third-party libraries:

• JADE  http://jade.tilab.com/ (base agent framework) LGPL Version 2.1
• JUNG  http://jung.sourceforge.net/ (visualization in GUI) BSD
• json_simple  http://code.google.com/p/json-simple/ Apache License, Version 2.0
• jscience  http://jscience.org/ (SI-Unit support) Custom
• xstream  http://xstream.codehaus.org/ (serialization and debugging) BSD

The Java libraries can be installed to the provided thirdparty directory (see below). For ruby 1.8.x the json library is also required. Install with e. g. sudo gem install json. The MUSCLE does currently not work with Ruby 1.9.1 or newer.

General Instructions

If the dependencies are in place, you are ready to use the MUSCLE. No compilation required! Extract the download, e. g.

$ unzip MUSCLE_2009-10-08_10-39-10.zip

Change your working directory to the the MUSCLE directory (e. g.)

$ cd MUSCLE_2009-10-08_10-39-10

See if the MUSCLE is working correctly

$ ./src/ruby/muscle.rb --version

In case you plan to use the MUSCLE with native code, you will have to compile the native library part of the MUSCLE using a C++ compiler (such as g++). The build script belonging to the MUSCLE also has a target to build the native libraries. This requires a C++ compiler and CMake ( http://www.cmake.org/) to be available. You can also use your favourite IDE/build system instead.

What’s in the bundle?

The MUSCLE download bundle contains the following items:

• build - This directory contains the compiled Java bytecode and C++ libraries.
• build.rb - The build script. It can compile the java sources, build jar archives build the native shared libraries.
• CMakeLists.txt - The configuration file for cmake. Only needed if the native libraries are to be built. This file is used by the build.rb, you do not have to call cmake manually.
• doc - The Documentation for MUSCLE
• OTF - The configuration and helper scripts for OTF trace logger.
• src - This directory contains the MUSCLE source code.
• thirdparty - The MUSCLE will automatically load third-party libraries which are in this directory.