How To Install CSDMS Tools

= This page is intended for the use of the developers of the CSDMS tools =
This doesn't mean that others aren't welcome to use or contribute to the information on this page. Only that the information here may change often and that the tools are still in early development.
=== Installing the CSDMS Tools ===
This page describes how to install the CSDMS tools. If you haven't downloaded the collection, you can use the link below to get started. After doing so, please read the rest of the document to learn how to configure, build, and install the complete CSDMS tools kit.
* Download the CSDMS tools
=== System and Software Requirements ===
Supported Operating Systems:
* CCA-supported OS (most any Unix, including Mac OS X, should do)
Required software:
* CCA tools
* OpenMI Java sdk
=== Configure ===
Unpack the distribution,
<geshi lang=bash>
> tar xvfz csdms-tools-0.1.0.tar.gz
</geshi>
This will unpack the distribution and create a directory csdms-tools-0.1.0 in your current directory. Move into this directory and configure the distribution. It is generally a good idea to create another directory in which to configure/build (for this example, I'll use _build),
<geshi lang=bash>
> cd cca-tools-0.1.0 && mkdir _build && cd _build
> ../configure --prefix=/usr/local/csdms
</geshi>
Use the prefix option to specify where you want the CSDMS tools to be installed. Note that the above assumes that the CCA tools are installed under /usr/local/cca, and that the OpenMI sdk is installed under /usr/local/openmi (if this is not the case for you, please see below). The default is /usr/local, but you'll probably want to put it elsewhere. Make sure that you have permission to write to this directory. Note that it is a bad idea to configure and make as root (or use sudo). It is best to create the install directory and then change its ownership so that you are able to write to it. For instance, in the above example,
<geshi lang=bash>
> sudo mkdir /usr/local/csdms-tools
> sudo chown huttone:huttone /usr/local/csdms-tools
</geshi>
==== If CCA tools and/or OpenMI is not in the standard location ====
The above configure step assumes that you have the CCA tools and OpenMI sdk installed under /usr/local/cca and /usr/local/openmi, respectively. If this is not the case, you will have to tell configure where you have them installed. This is done on the command line as,
<geshi lang=bash>
> ../configure --with-cca=/path/to/my/cca-tools --with-openmi=/path/to/my/openmi
</geshi>
=== Build the CSDMS Tools ===
You can now build the CSDMS tools with make,
<geshi lang=bash>
> make
</geshi>
This builds a CCA project in the build directory, creates CSDMS interfaces and classes, and builds them.
=== Install the CSDMS Tools ===
To install the CSDMS tools (again, make sure you have write permission to you install directory),
<geshi lang=bash>
> make install
</geshi>
This does some more compiling and installs the necessary files to the prefix directory you specified in the configure step. To test the install, try running the csdms-tools-test-all.sh script. This is in the bin subdirectory of your install,
<geshi lang=bash>
> /path/to/cca-tools/bin/csdms-tools-test-all.sh
</geshi>