Getting Started

This page introduces the features of GSAP to new users and provides guidance on how to use the rest of this wiki. For review of GSAP design and functionality, click here.

Requirements

Cmake (https://cmake.org)
Compiler capable of building C++11 (tested with gcc 4.8.1 and Clang)
Tested with MacOS 10.13, Red Hat Enterprise Linux, Windows 10

Compiling

Compiling GSAP Libraries

Use the CMakeLists file with CMake to generate a makefile or other code compilation tool.
Compile to create the GSAP Library

Compiling Your Application

Compile the GSAP Library with your Prognostics Application Driver (PAD) (see examples/async/main.cpp or examples/simple/main.cpp for an example), and any additional prognosers, communicators, models, observers, or predictors.

Note: The PAD must register any new prognosers, communicators, models, observers, or predictors with the relevant factory, and identify the primary configuration file. See Configuring below for further instructions.

If unfamiliar with running CMake, click here for help.

Running

Running a GSAP deployment requires an entry point. This entry point is a main function that registers any models, observers, predictors, prognosers, or communicators used with the relevant factory, and points the Prognostic Manager to the relevant primary configuration file. See examples/async/main.cpp or examples/simple/main.cpp.

The GSAP deployment keeps a log file (log.txt) of all operations in the same directory as the executable.

Configuring

A GSAP distribution is tuned using configuration maps. Configuration parameters can be set individually, or can be specified in a configuration file and imported. Configuration files are in the format key:value (see examples/async/cfg for examples). Below is an example of how to create the configuration map:

ConfigMap config("example.cfg"); // Create from file //TODO(CT): manual

// TODO(CT): Setting prognosers, etc in builder