2019-11-20 18:53:56 +00:00
| [Home ](/trick ) → Documentation Home |
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 )
Integrate MonteCarloGenerate capability from EG CML and associated TrickOps enhancements (#1415)
* Provide MonteCarloGenerate capability
Intermediate commit, this squash represents all of Isaac Reaves' work
during his Fall 2022 Pathways internship tour
[skip ci]
* TrickOps: Add phase, [min-max] range, and overhaul YAML verification
* Add new "phase:" mechanism to TrickOps Runs and Builds to support
project-specific constraints on build and run ordering
- phase defaults to zero if not specified and must be between -1000
and 1000 if given.
- jobs can now optionally be requested by their phase or phase range
- See trickops/README.md for details
* Add [min-max] notation capability to run: entries and compare: entries
- [min-max] ranges provide definition of a set of runs using a common
numbering scheme in the YAML file, greatly reducing YAML file size
for monte-carlo and other zero-padded run numbering use cases
- See trickops/README.md for details
* YAML parsing changes
- Overhaul the logic which verifies YAML files for the expected
TrickOps format. This is now done in TrickWorkflowYamlVerifier and
provides much more robust error checking than previous approach
- .yaml_requirements.yml now provides the required types, ranges, and
default values as applicable to expected entries in YAML files
- valgrind: is now an sub-option to run: entries, not its own section
Users should now list their runs normallly and define their flags in
in that run's valgrind: subsection
- parallel_safety is now a per-sim parameter and not global. Users
should move their global config to the sim layer
- self.config_errors is now a list of errors. Users should now
check for empty list when using instead of True/False
* Robustify the get_koviz_report_jobs unit test to work whether koviz
exists on PATH or not
* Adjust trickops.py to use the new phase and range features
- Make it more configurable on the command-line via argparse
- Move SIM_mc_generation tests into test_sims.yml
[skip ci]
* Code review and cleanup from PR #1389
Documentation:
* Adjust documentation to fit suggested symlinked approach. Also
cleaned up duplicate images and old documentation.
* Moved the verification section out of markdown and into a PDF since it
heavily leverages formatting not available in markdown.
* Clarify a couple points on the Darwin Trick install guide
* Update wiki to clarify that data recording strings is not supported
MCG Code:
* Replace MonteCarloVariableRandomNormal::is_near_equal with new
Trick::dbl_is_near from trick team
MCG Testing:
* Reduce the set of SIM_mc_generation comparisons. After discussion
the trick team, we are choosing to remove all comparisons to
verif_data/ which contain random-generated numbers since
these tests cannot pass across all supported trick platforms.
* Fix the wrong rule on exlcuding -Werror for Darwin builds
of SIM_mc_generation
* Remove data recording of strings in SIM_mc_generation
Trickops:
* Replace build_command with build_args per discussion w/ Trick team
Since we only support arguments to trick-CP, replace the build_command
yaml entry with build_args
* Disable var server connection by default in SingleRun if TrickWorkflow.quiet
is True
* Guard against multiple Job starts
* Remove SimulationJob inheritance layer since old monte-carlo wasn't
and never will be supported by TrickOps
* Ignore IOError raise from variable_server that looks like "The remote
endpoint has closed the connection". This appears to occur when
SingleRun jobs attempt to connect to the var server for a sim that
terminates very early
[skip ci]
* Adjust phasing of old/new MCG initialize functions
* Clarify failure message in generate_dispersions if new/old MC are both
used.
* Adjust the phasing order of MCG intialize method to be before
legacy MC initialized. Without this, monte-carlo dry run completes with
success before the check in generate_dispersions() can run
* Add -Wno-stringop-truncation to S_override.mk for SIM_mc_generation
since gcc 8+ warns about SWIG generated content in top.cpp
* Introduce MonteCarloGenerationHelper python class
This new class provides an easy-to-use interface for MCG sim-module
users:
1. Run generation
2. Getting an sbatch array job suitable for SLURM
3. Getting a list of SingleRun() instances for generated runs, to be
executed locally if desired
---------
Co-authored-by: Dan Jordan <daniel.d.jordan@nasa.gov>
2023-03-06 15:25:50 +00:00
02. [Monte Carlo Generation ](miscellaneous_trick_tools/MonteCarloGeneration )
2019-11-20 17:04:58 +00:00
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 )
2019-11-20 21:43:34 +00:00
01. [Frame Logging ](simulation_capabilities/Frame-Logging )
2019-11-20 17:04:58 +00:00
01. [Debug Pause ](simulation_capabilities/Debug-Pause )
2020-02-11 15:05:54 +00:00
01. [Echo Jobs ](simulation_capabilities/Echo-Jobs )
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 )
2022-10-07 22:10:16 +00:00
01. [Standard Template Library Checkpointing ](simulation_capabilities/STL-capabilities )
2019-11-20 21:43:34 +00:00
01. [Threads ](simulation_capabilities/Threads )
2019-11-21 19:30:09 +00:00
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 )
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 )
2021-05-03 19:39:20 +00:00
02. [TrickOps Sim Testing Framework ](miscellaneous_trick_tools/TrickOps.md )
2019-11-20 17:04:58 +00:00
01. [Software Requirements Specification ](software_requirements_specification/SRS )
