ExternalVendorCode/trick
1
0
Fork 0
mirror of https://github.com/nasa/trick.git synced 2024-12-19 05:07:54 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
4ba2812ad1
trick/docs/documentation/Documentation-Home.md
ddj116 1d9ea79107
Introducing TrickOps - An Extensible Sim Testing Framework (#1130) 
* Introducing TrickOps - An Extensible Sim Testing Framework

Features:

* Multiple simultaneous sim builds, runs, file vs. file comparisons,
  arbitrary post-run analyses, valgrind of runs
* Real-time progress bars for sim builds and runs
* Exit code management lets users easily define success & failure
* Failed comparisons can optionally generate koviz error reports

See share/trick/trickops/README.md for details

* Add GitHub Actions Workflow for TrickOps for Ubuntu:20.04 & CentOS latest

* Adds python unit and doc tests to github actions for push / pull requests
  for Ubuntu:20.04 and CentOS 8:latest. MacOS still forthcoming.
* Also updates documentation with TrickOps information
* Remove duplicate / overwriting SIM_ definitions in ExampleWorkflow.py

* Address Code Review / Discussion

* Reduce set of sims tested in ExampleWorkflow.py to stable set
* Add ExampleWorkflow.py to GitHub Actions
* Clarify documentation and add image of TrickOps in action
* Error/Ignore valgrind entries in YAML file if platform == darwin

* Fix run.compare() logic error and add unit test to cover it

Co-authored-by: Dan Jordan <daniel.d.jordan@nasa.gov>
2021-05-03 14:39:20 -05:00

3.9 KiB
Raw Blame History

Home → Documentation Home

User Guide

The user guide contains information pertinent to Trick users. These pages will help you create Trick simulations and understand how certain aspects of Trick function.

  1. Introduction

  2. Trick Install Guide

  3. Building a Simulation

    1. Model Source Code
    2. Environment Variables
    3. Simulation Definition File (S_define)
    4. Making the Simulation
    5. Trickified Project Libraries

  4. Running a Simulation

    1. Input File
    2. Runtime GUIs
    3. Runtime Output

  5. Data Products (DP)

    1. DP Session File Format
    2. DP Product File Format
    3. Plot Printing
    4. Data Products GUIs

  6. Simulation Capabilities

    1. Executive Scheduler
    2. Input Processor
    3. Just in Time C++ Input Processor
    4. Event Manager
    5. Realtime
    6. Realtime Clock
    7. Realtime Sleep Timer
    8. Realtime Injector
    9. Monte Carlo
    10. Master Slave
    11. Data Record
    12. Checkpoints
    13. MemoryManager
    14. Integrator
    15. Frame Logging
    16. Debug Pause
    17. Echo Jobs
    18. Variable Server
    19. Status Message System
    20. Command Line Arguments
    21. Environment
    22. Standard Template Library Checkpointing
    23. Threads

  7. Web Server

    1. Adding a Web Server to Your Sim
    2. Web Server APIs
      1. HTTP-API_alloc_info
      2. WS-API_VariableServer
    3. Adding New Web Server APIs
      1. Extending_the_HTTP-API
      2. Extending_the_WS-API

  8. Simulation Utilities

    1. Trickcomm
    2. Math Utilities

  9. Miscellaneous Trick Tools

    1. Python Variable Server Client
    2. TrickOps Sim Testing Framework

  10. Software Requirements Specification