mirror of
https://github.com/nasa/trick.git
synced 2024-12-29 17:38:54 +00:00
56 lines
3.4 KiB
Plaintext
56 lines
3.4 KiB
Plaintext
/**
|
||
@page LEVEL1 Overview and Purpose of Functions
|
||
|
||
The %Trick processors and utilities covered in this document are listed in Table 1. All functions
|
||
listed in Table 1, can be started at the UNIX command prompt by entering the function’s name and
|
||
associated arguments followed by a return. For help with CP, ICG and MIS, use the -h option. Man
|
||
pages are available for CP, ICG and MIS too. Specific startup and termination characteristics for
|
||
each function are discussed in the later subsections. Most of these functions can also be
|
||
executed through the Graphical User Interfaces.
|
||
|
||
<center>
|
||
<table>
|
||
<tr><th>Name</th><th>Description</th></tr>
|
||
<tr><td>CP</td><td>Configuration Processor - builds simulation executable</td></tr>
|
||
<tr><td>fxplot</td><td>Data Products plots, tables, and displays generation</td></tr>
|
||
<tr><td>trick_dp</td><td>Data Products user interface</td></tr>
|
||
<tr><td>trick_ui</td><td>%Trick developer’s interface</td></tr>
|
||
<tr><td>ICG</td><td>Interface Code Generator - parses header files and builds %Trick data structure interfaces</td></tr>
|
||
<tr><td>install_user</td><td>Installs user for current %Trick environment</td></tr>
|
||
<tr><td>kill_sim</td><td>Kills runaways simulations</td></tr>
|
||
<tr><td>make</td><td>Standard UNIX make command</td></tr>
|
||
<tr><td>make_build</td><td>Makefile builder</td></tr>
|
||
<tr><td>MIS</td><td>Module Interface Specification processor - parses modules and builds %Trick function call interfaces</td></tr>
|
||
<tr><td>S_main_${TRICK_HOST_CPU}.exe</td><td>Specific %Trick Simulation</td></tr>
|
||
<tr><td>trick_version</td><td>Displays the currently installed %Trick Release Version</td></tr>
|
||
</table>
|
||
<b>Table 1. %Trick Processor and Utility Functions</b>
|
||
</center>
|
||
|
||
Figure 1 is a high-level picture of how a model developer interacts with %Trick to produce a
|
||
simulation executable. The developer creates math model source code, default data for the models,
|
||
and a simulation definition file. The developer may optionally use external libraries he/she has
|
||
already created. Once these tasks are complete, the developer runs the Configuration Processor (CP)
|
||
on the simulation definition file (S_define). The Configuration Processor (CP) then does its magic.
|
||
Using the S_define as a blue print, CP gathers the default math model data, auto generates IO code
|
||
from source headers, parses math model source code to find object dependencies, job specifications
|
||
etc., and then creates a master makefile. With this master makefile in hand, CP calls UNIX make,
|
||
which creates the simulation executable. CP (and other utilities) also creates a database that
|
||
contains data structure information and model job info. The “catalog” utility provides a means
|
||
to view the database.
|
||
|
||
@image html users_guide/figure_1.png "Figure 1 Trick Simulation Development Processor Interactions"
|
||
@image rtf users_guide/figure_1.png "Figure 1 Trick Simulation Development Processor Interactions"
|
||
|
||
Figure 2 is a high-level picture of how a simulation user operates the simulation. The simulation
|
||
developer/user is responsible for creating an “input” file for the simulation and data recording
|
||
specification files (if needed). Once these are created, the simulation is ready to execute. The
|
||
simulation will output data if the user has designated variables for logging. Data may be analyzed
|
||
by creating a Data Products specification file.
|
||
|
||
@image html users_guide/figure_2.png "Figure 2 Trick Simulation Operation"
|
||
@image rtf users_guide/figure_2.png "Figure 2 Trick Simulation Operation"
|
||
|
||
*/
|
||
|