Difference between revisions of "CMT Command Line Tools"

From CSDMS
m (Describe the CMT resource file)
m (Add some more documentation about RC file commands.)
Line 37: Line 37:
 
# <tt>parameters</tt>. Set a model parameter
 
# <tt>parameters</tt>. Set a model parameter
 
There are other too, but these are the main ones.
 
There are other too, but these are the main ones.
 +
 +
=== instantiate ===
 +
 +
Instantiate a component of type <tt>class_name</tt> and call it <tt>instance_name</tt>. Later on in the file we will use the instance name when referring to this component.
 +
<syntaxhighlight lang=bash>
 +
instantiate <class_name> <instance_name>
 +
</syntaxhighlight>
 +
Examples of instance names are <tt>edu.csdms.models.Child</tt> and <tt>edu.csdms.models.Sedflux3D</tt>. Instance names can be pretty much any old string. So, an example instantiate command would be,
 +
<syntaxhighlight lang=bash>
 +
instantiate edu.csdms.models.Child Child
 +
</syntaxhighlight>
 +
 +
=== connect ===
 +
 +
Connect the component instances <tt>user_name</tt> and <tt>provider_name</tt>. The two components will be connected through their named ports. All most always the user and provider port names will be the same but the need not be.
 +
<syntaxhighlight lang=bash>
 +
connect <user_name> <user_port> <provider_name> <provider_port>
 +
</syntaxhighlight>
 +
As an example, the Child component provides information about its subaerial delta through a provider port called SubaerialDelta. The Sedflux3D component is able to (optionally) use data provided by such a port. Thus, these two components can be connected through this port with the following command,
 +
<syntaxhighlight lang=bash>
 +
connect Sedflux3D SubaerialDelta Child SubaerialDelta
 +
</syntaxhighlight>
 +
In this case, the Child component provides the Sedflux3D component with information about sediment erosion and deposition rates on land.
 +
 +
=== parameters ===
 +
 +
For the component <instance_name>, set the configuration parameter <param_key> to be <param_value>.
 +
<syntaxhighlight lang=bash>
 +
parameters <instance_name> Configure <param_key> <param_value>
 +
</syntaxhighlight>

Revision as of 17:58, 2 May 2013

The CMT Command Line Tools

Warning 32.png Before beginning, you will need to have:
  • Set up an account on the CSDMS cluster, and be able to connect to it through an ssh client.

Load the CMT environment

Once logged into the CSDMS High Performance Computing Cluster, beach.colorado.edu, you will need to set up your environment to use the CMT command line tools. This is most easily done using modules.

$ module purge
$ module load cmtcl

This clears any previously loaded modules and then adds the cmt command to your path. If you have done this successfully, the following should print out a brief help message that describes some of the options for the cmt command,

$ cmt --help

Running a simple example

To run an example we first must prepare a CMT resource file. The resource file will tell CMT what components to use and how to connect them. The most basic way to run CMT on the command line is,

$ cmt my_resource_file.rc

where my_resource_file.rc is described in the next section. Usually this file is prepared by the CMT graphical user interface, however, it is a fairly simple format and can be created by-hand without too much effort. It is much easier to start with a template though so I will provide links to some sample resource files.

The CMT Resource File

The CMT resource file tells the CMT what to do through three main commands:

  1. instantiate. Create an instance of a component.
  2. connect. Connect two components.
  3. parameters. Set a model parameter

There are other too, but these are the main ones.

instantiate

Instantiate a component of type class_name and call it instance_name. Later on in the file we will use the instance name when referring to this component.

instantiate <class_name> <instance_name>

Examples of instance names are edu.csdms.models.Child and edu.csdms.models.Sedflux3D. Instance names can be pretty much any old string. So, an example instantiate command would be,

instantiate edu.csdms.models.Child Child

connect

Connect the component instances user_name and provider_name. The two components will be connected through their named ports. All most always the user and provider port names will be the same but the need not be.

connect <user_name> <user_port> <provider_name> <provider_port>

As an example, the Child component provides information about its subaerial delta through a provider port called SubaerialDelta. The Sedflux3D component is able to (optionally) use data provided by such a port. Thus, these two components can be connected through this port with the following command,

connect Sedflux3D SubaerialDelta Child SubaerialDelta

In this case, the Child component provides the Sedflux3D component with information about sediment erosion and deposition rates on land.

parameters

For the component <instance_name>, set the configuration parameter <param_key> to be <param_value>.

parameters <instance_name> Configure <param_key> <param_value>