trick/docs/tutorial/ATutIntroduction.md

101 lines
3.7 KiB
Markdown
Raw Permalink Normal View History

2019-11-20 18:53:56 +00:00
| [Home](/trick) → [Tutorial Home](Tutorial) → Introduction |
|---------------------------------------------------------|
<!-- Section -->
<a id=introduction></a>
2021-05-20 03:16:45 +00:00
# 🏁 Introduction
**Contents**
* [What Trick Is](#what-trick-is)<br>
* [The Goal of Trick](#the-goal-of-trick)<br>
* [The Objective of This Tutorial](#the-objective-of-this-tutorial)<br>
* [Installing Trick](#installing-trick)<br>
***
<a id=what-trick-is></a>
## What Trick Is
Trick is a NASA Open Source simulation framework for running time-based physics
models. It builds executable simulations with a common architecture, using user
supplied simulation definition files and user supplied "model code". A Trick
based simulation provides many capabilities such as realtime
synchronization, job scheduling, simulation state save and restore (checkpoint),
data-recording, interactive variable manipulation (variable server), numeric
state integration and an input processor. It also includes tools for plotting
recorded data, and many other supporting utilities and libraries.
Trick is written in C/C++ and Java and supports both Linux and MacOSX computer
operating systems.
The name "Trick" is handed down from motocross. It is not an acronym. It is
slang for "really cool"... or something of that nature.
---
<a id=the-goal-of-trick></a>
## The Goal of Trick
The goal of Trick is to help simulation developers to focus on the algorithms
and equations of their problem domain rather than repeatedly solving the same,
time-consuming simulation architecture problems and reimplementing the same
required capabilities. Trick seeks to reliably accomplish this by automating
the implementation of commonly needed simulation capabilities, and by automating
the process of building the executable.
---
<a id=the-objective-of-this-tutorial></a>
## The Objective of This Tutorial
This tutorial covers the basic concepts for developing and operating Trick
simulations. It assumes absolutely no previous knowledge of Trick, and
should be self-contained, with no need for outside references other than maybe a
C book, and/or a UNIX book. By the end of the tutorial you should know how to
build a Trick simulation of your own from the ground up. The approach of this
tutorial is hands-on.
The intent here is not to teach about simulation math models, nor to teach about
C programming, nor UNIX, but rather to teach about the Trick architecture and
its capabilities.
---
<a id=installing-trick></a>
## Installing Trick
If Trick is not already installed on your machine, then you will need to do that
2019-11-20 18:53:56 +00:00
first, by following the directions at: [Install Guide](/trick/documentation/install_guide/Install-Guide).
2022-12-02 20:55:40 +00:00
The rest of the tutorial is written as if the Trick **bin** directory is
available on your execution path. This isn't strictly necessary, but allows
you to call `trick-CP` instead of `/full/path/to/trick/bin/trick-CP`. Follow
the steps below if you would like to add the **bin** directory to your PATH.
For the sake of example, let us assume that
you installed Trick in your home directory, and you used the default name for
2022-12-02 20:55:40 +00:00
the repository, which is **trick**. If you named it something different, then
use that name instead in the scripts below.
2022-12-02 20:55:40 +00:00
If you are using **bash or ksh**, then add the following lines to the file
that is automatically sourced by your terminal. Based on your platform this
could be **.profile, .bash_profile, .bashrc, .zshrc** or others. Google "How
to edit PATH variable" on google to find a wealth of information on this
subject.
```bash
2022-12-02 20:55:40 +00:00
export PATH=${PATH}:${HOME}/trick/bin
```
If you are using **csh** or **tcsh**, then add the following lines to your **.cshrc** file.
```csh
2022-12-02 20:55:40 +00:00
setenv PATH ${PATH}:${HOME}/trick/bin
```
Close and then re-open your terminal window.
---
2019-11-20 18:53:56 +00:00
[Next Page](ATutASimpleSim)