ExternalVendorCode/trick
1
0
Fork 0
mirror of https://github.com/nasa/trick.git synced 2024-12-18 20:57:55 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
9b3e6aac51
trick/docs/documentation/Documentation-Home.md

72 lines
4.0 KiB
Markdown
Raw Normal View History

update doc links
2019-11-20 18:53:56 +00:00
| [Home](/trick) → Documentation Home |
add wiki to repository for github pages
2019-11-20 17:04:58 +00:00
|------------------------------------|
# 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.
01. [Introduction](introduction/Introduction)
01. [Trick Install Guide](install_guide/Install-Guide)
01. [Building a Simulation](building_a_simulation/Building-a-Simulation)
01. [Model Source Code](building_a_simulation/Model-Source-Code)
01. [Environment Variables](building_a_simulation/Environment-Variables)
01. [Simulation Definition File (S_define)](building_a_simulation/Simulation-Definition-File)
01. [Making the Simulation](building_a_simulation/Making-the-Simulation)
01. [Trickified Project Libraries](building_a_simulation/Trickified-Project-Libraries)
01. [Running a Simulation](running_a_simulation/Running-a-Simulation)
01. [Input File](running_a_simulation/Input-File)
01. [Runtime GUIs](running_a_simulation/runtime_guis/Runtime-GUIs)
01. [Runtime Output](running_a_simulation/Runtime-Output)
01. [Data Products (DP)](data_products/Data-Products)
01. [DP Session File Format](data_products/DP-Session-File-Format)
01. [DP Product File Format](data_products/DP-Product-File-Format)
01. [Plot Printing](data_products/Plot-Printing)
01. [Data Products GUIs](data_products/Data-Products-GUIs)
01. [Simulation Capabilities](simulation_capabilities/Simulation-Capabilities)
01. [Executive Scheduler](simulation_capabilities/Executive-Scheduler)
01. [Input Processor](simulation_capabilities/Input-Processor)
01. [Just in Time C++ Input Processor](simulation_capabilities/JIT-Input-Processor)
01. [Event Manager](simulation_capabilities/Event-Manager)
01. [Realtime](simulation_capabilities/Realtime)
01. [Realtime Clock](simulation_capabilities/Realtime-Clock)
01. [Realtime Sleep Timer](simulation_capabilities/Realtime-Timer)
01. [Realtime Injector](simulation_capabilities/Realtime-Injector)
01. [Monte Carlo](simulation_capabilities/UserGuide-Monte-Carlo)
01. [Master Slave](simulation_capabilities/Master-Slave)
01. [Data Record](simulation_capabilities/Data-Record)
01. [Checkpoints](simulation_capabilities/Checkpoints)
01. [MemoryManager](simulation_capabilities/memory_manager/MemoryManager)
01. [Integrator](simulation_capabilities/Integrator)
move web documentation to docs
2019-11-20 21:43:34 +00:00
01. [Frame Logging](simulation_capabilities/Frame-Logging)
add wiki to repository for github pages
2019-11-20 17:04:58 +00:00
01. [Debug Pause](simulation_capabilities/Debug-Pause)
Update Documentation-Home.md
2020-02-11 15:05:54 +00:00
01. [Echo Jobs](simulation_capabilities/Echo-Jobs)
add wiki to repository for github pages
2019-11-20 17:04:58 +00:00
01. [Variable Server](simulation_capabilities/Variable-Server)
01. [Status Message System](simulation_capabilities/Status-Message-System)
01. [Command Line Arguments](simulation_capabilities/Command-Line-Arguments)
01. [Environment](simulation_capabilities/Environment)
Update Documentation-Home.md
2022-10-07 22:10:16 +00:00
01. [Standard Template Library Checkpointing](simulation_capabilities/STL-capabilities)
move web documentation to docs
2019-11-20 21:43:34 +00:00
01. [Threads](simulation_capabilities/Threads)
update web doc location
2019-11-21 19:30:09 +00:00
Add Horizonal Navigation bars (breadcrumbs) to all documentation pages (#1328) * Add breadcrumbs to all documentation pages, fix some links between pages
2022-08-05 22:05:10 +00:00
01. [Web Server](web/Webserver)
01. [Configure Trick with Civetweb](web/Configure-Civetweb)
01. [Add SSL encryption to your webserver](web/SSL)
01. [Web Server APIs](web/Webserver-apis)
01. [HTTP alloc API](web/http-alloc-api.md)
01. [WS Variable Server API](web/ws-variable-server-api.md)
01. [Extend the HTTP API](web/Extend-http-api.md)
01. [Extend the WS API](web/Extend-ws-api.md)
add wiki to repository for github pages
2019-11-20 17:04:58 +00:00
01. [Simulation Utilities](simulation_utilities/Simulation-Utilities)
01. [Trickcomm](simulation_utilities/Trickcomm)
01. [Math Utilities](simulation_utilities/Math-Utilities)
01. [Miscellaneous Trick Tools](miscellaneous_trick_tools/Miscellaneous-Trick-Tools)
01. [Python Variable Server Client](miscellaneous_trick_tools/Python-Variable-Server-Client)
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 19:39:20 +00:00
02. [TrickOps Sim Testing Framework](miscellaneous_trick_tools/TrickOps.md)
add wiki to repository for github pages
2019-11-20 17:04:58 +00:00
01. [Software Requirements Specification](software_requirements_specification/SRS)
Reference in New Issue Copy Permalink