<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
        "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
	<title>PLUM: Setup Menu</title>
	<link rel="stylesheet" type="text/css" href="../style.css">
</head>
<body>
<div class="section"><h1>Setup Menu</h1></div>

<div class="section">
<p><img src="img/SetupMenu.jpg"></p>
<p>
This menu lets you set the locations of tools that the PLUM runner needs to make runs, as well as specifying the command-line parameters sent to those utilities.
There are several entries on this form:
<ul>
  <li>
    <b>Combo generator command:</b> This is the command used to invoke the program that generates random combinations for the runs.
  </li>
  <li>
    <b>Calc command:</b> This is the command used to invoke the combination solver that calculates resource usage for each combination.
  </li>
  <li>
    <b>Single combination command:</b> This command is used when the program runs a single combination (instead of a full run of 30,000).
  </li>
  <li>
    <b>Increment graph command:</b> This command generates the graph of increment-length resource usage.
  </li>
  <li>
    <b>Simultaneous graph command:</b> This command generates the smultaneous resource usage graph.
  </li>
  <li>
    <b>Average runtime graph command:</b> This generates the graph of average rack runtime.
  </li>
  <li>
    <b>Selection success command:</b> This generates a chart of which racks were most commonly successfully selected.
  </li>
  <li>
    <b>Topology command:</b> This generates a chart of where the racks were placed in the station for this run.
  </li>
  <li>
    <b>Output path:</b> This is the path to the directory where the charts for each run will be placed. There should not be a trailing slash or backslash in this path.
  </li>
  <li>
    <b>Path to programs:</b> This path is prepended to each command to make it easier to change between multiple sets of modeler tools. There should not be a trailing slash or backslash in this path.
  </li>
  <li>
    <b>Delimiter:</b> This is to select whether your operating system uses slashes or backslashes as path delimiters. Windows uses backslashes, everything else uses slashes.
  </li>
</ul>
</p>
<p>
Additionally, each of these entries can have anchors which are replaced with values specific to each run. These are each preceded with a dollar sign ($). For example, to have one of the parameters to a utility be the address of the database server, add "$host" to that utility's command.

<ul>
  <li>
    <b>$host</b> This is the hostname for the database server currently connected to.
  </li>
  <li>
    <b>$db</b> This is replaced by the name fo the database containing the rack data.
  </li>
  <li>
    <b>$user</b> This is the username used to connect to the database server
  </li>
  <li>
    <b>$pass</b> This is the password for the DB server.
  </li>
  <li>
    <b>$outputdb</b> The name of the database the run output goes into. This can be set for each run from the run window. This database must reside on the same server as the rack data database, however. Also, it must already have been created; the program can't make it itself since this is a task that can only be done by the database administration program.
  </li>
  <li>
    <b>$output</b> This is replaced by whatever is in the "Output path" field.
  </li>
  <li>
    <b>$table</b> The name of the table in $outputdb that the current run puts its output into.
  </li>
  <li>
    <b>$order</b> The number of combinations per point of the current run. Usually 1000 for a full-up run.
  </li>
</ul>

Also, there are two other special anchors that only work in the single combo command:

<ul>
  <li>
    <b>$combo</b> This is the combination that should be run by the single combo runner.
  </li>
  <li>
    <b>$sams</b> This is 1 if the combo requires SAMS, otherwise 0.
  </li>
</ul>
</p>
</div>

<div class="section">
<img src="nasa.jpg">
</div>
</body>
</html>
