Difference between revisions of "CMT Command Line Tools"

From CSDMS
m (Describe the CMT resource file)
(Redirect to pymt page)
Tag: Replaced
 
(6 intermediate revisions by one other user not shown)
Line 1: Line 1:
  
= The CMT Command Line Tools =
+
[[Image:Alert-yellow.png | center | 50px | Out-of-date page ]]
 
+
This page is out of date.
{{Alert Box|message=Before beginning, you will need to have:
+
Please see the
* Set up an account on the [[HPCC_account_requirements | CSDMS cluster]], and be able to connect to it through an ssh client.
+
[[PyMT]]
}}
+
page for information on the Python Modeling Toolkit,
 
+
the successor to CMT.
== 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.
 
 
 
<syntaxhighlight lang=bash>
 
$ module purge
 
$ module load cmtcl
 
</syntaxhighlight>
 
 
 
This clears any previously loaded modules and then adds the <tt>cmt</tt> 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,
 
 
 
<syntaxhighlight lang=bash>
 
$ cmt --help
 
</syntaxhighlight>
 
 
 
== 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,
 
 
 
<syntaxhighlight lang=bash>
 
$ cmt my_resource_file.rc
 
</syntaxhighlight>
 
 
 
where <tt>my_resource_file.rc</tt> 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:
 
# <tt>instantiate</tt>. Create an instance of a component.
 
# <tt>connect</tt>. Connect two components.
 
# <tt>parameters</tt>. Set a model parameter
 
There are other too, but these are the main ones.
 

Latest revision as of 15:19, 14 March 2020

Out-of-date page

This page is out of date. Please see the PyMT page for information on the Python Modeling Toolkit, the successor to CMT.