SDSC Matrix 3.3 Installation Instructions

The following are the instructions to install SDSC Matrix 3.3 server. If you need any help, please e-mail talk2matrix@sdsc.edu  

1. Matrix Software Package

The Matrix 3.3 release tree looks something like this:

    MATRIX_HOME/

    |

    |--- bin/

    |    |--- WSDLgenerator.java (Generates matrix.wsdl - represents SRB Web Services)

    |

    |--- conf/

    |    |--- matrix.properties  (properties file for matrix server)

    |

    |--- docs/                   (contains documentation, including DGL-Coder's Guide to begin with)

    |    |---DGL-Query/          (Grammar for Action String grammar of Data Grid Language)

    |    |---SRB-XQuery/         (Grammar and mapping of XQuery to Data Grid Collections)

    |

    |--- examples/               (examples for the Matrix DGL programs

    |    |---Using-JavaAPI/     (API to create DGL using Java)

    |    |---Using-XML Editor/  (Create and send DGL request/query using an XML editor)

    |

    |--- lib/                    (libraries used/required by the Matrix)

    |

    |--- schema/                 (files used by DGL for schema binding)

    |

    |--- src/                    (Matrix server and client source code)

    |

    |build.xml                   (Ant tool build file)

    |matrix.wsdl                 (matrix.wsdl - could also be considered as SRB's WSDL)

NOTE: Once you run ant tasks as mentioned below, more files are compiled and new directories are created

A. System Requirements

The following software is required to run Matrix 3.2

• Tomcat 4.1.24+ (From Apache) <Or> You can also use any other Servlet Container like JBoss.
• Hardware Requirement: To take advantage of the parallel flows that are run by MatrixThreads, we recommend   a multi-processor environment. The software library itself will at run time consume more than 18 MB. Remember this is NOT a bunch of programs, but a system - Gridflow Management System

B. Installing the Matrix Server

1. First, make sure you have the required software listed above (Tomcat or JBoss with Java).
2. Next, extract the Matrix source code (matrix.zip) to a directory (e.g. c:\matrix).
3. Set up an environment variable called MATRIX_HOME  to wherever Matrix source code was unzipped before (e.g. c:\marix , which contains the file "build.xml"). This variable is required to run the server
• If you don't know how to set up environment variable, refer this link or STEP G below.
4. Update the matrix.properties file in the MATRIX_HOME/conf directory for the following properties:
• jargon.filecache  (Matrix server caches and/or stages files here. Check if the directory exists and writable) 
• matrix.logFile     (All Matrix operations are logged to this file)
• writeToLogFile  (Flag to turn on/off the logging to a file)
• writeLogToConsole (Flag to turn on/off logging to a console)
• matrix.logLevel    (Logging level )
• applicationMode  (production or debug mode)
5. Download this war from this link into the webapps directory of your Tomcat. Save it as "matrix.war".
6. Start your servlet container. If you are using Tomcat, go to the directory CATALINA_HOME/bin and run startup.bat for Windows or startup.sh for UNIX/Linux users.  This will start the Tomcat Server. If you have another servlet container, read the instructions to start it.
7. Once the servlet container (Tomcat) is running, Matrix will be installed at the URL: http://[machine-ip]:[tomcat-port]/matrix/receiver.  So if you are running Tomcat locally, the URL will most likely be: http://localhost:8080/matrix/receiver
8. To verify that the Matrix installation was successful, go to http://localhost:8080/matrix/receiver and hopefully you will see the message "You have successfully installed SDSC Matrix". If that does not happen, you probably woke up on the wrong side of the bed, so try to repeat the steps - probably you missed something.  If you feel you are getting frustrated, please refer section F below.

C. Running Some Matrix Client Examples

We are currently working on several methods by which users can develop DGL programs.  These include a Java API and graphical user interface.  To learn how to code in DGL, please read the DGL Coder’s Guide present in the docs directory

 

• Go to MATRIX_HOME/examples
• Run setMatrixClasspath.bat before your run the examples (to setup classpath).

D. Miscellaneous

• If your have set up Apache-Ant, you can run the following ant tasks on the source (from the directory containing the "build.xml" file.
• Run 'ant client'.  This builds a file called matrixclient.jar in MATRIX_HOME/bin.  
• Type 'ant client-docs' if you want the API documentation for programming.  The documents are created in MATRIX_HOME\docs\client\api. The java api documentation is also available from our webpage
• You can always run 'ant clean' in MATRIX_HOME to clean up any build files including matrix.war, matrixclient.jar..
• Running 'ant server-docs' in MATRIX_HOME will generate the server and client API documentation in the docs directory

F. Press F1 for Help

If you have any problem using the software, please e-mail us (your friends) at talk2matrix@sdsc.edu.

SDSC Matrix Home Page