Commit Graph

184 Commits

Author SHA1 Message Date
jmpenn
1b38c36d09
Update FAQ.md 2023-04-17 14:28:58 -05:00
jmpenn
bc1be92e84
Update FAQ.md 2023-04-17 14:28:17 -05:00
Jacqueline Deans
ffed03521c
Update Install-Guide.md 2023-04-13 14:26:25 -05:00
ddj116
0a1a092afa
Fix typos and clarify content in TrickOps markdown file (#1475)
Co-authored-by: Dan Jordan <daniel.d.jordan@nasa.gov>
2023-03-22 14:33:14 -05:00
Jacqueline Deans
19016b4817
job_class_order no longer accidentally disables some system job classes (#1465) 2023-03-07 08:43:39 -06:00
ddj116
9099792947
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 09:25:50 -06:00
John M. Penn
3b630c33dc markdown render fix. 2023-03-01 17:16:29 -06:00
John M. Penn
4999b076f4 Typos. 2023-03-01 16:58:35 -06:00
jmpenn
6e272c4b9e
Add a HOWTO: How-To-Containerize-Trick-with-Docker. (#1462)
* Add a HOWTO: How-To-Containerize-Trick-with-Docker.

* describe operating the cannon graohics client.

* Fix review issues.
2023-03-01 15:44:46 -06:00
Jacqueline Deans
5f6a5de070
Expand SIM_test_varserver (#1459)
* Add tests for alternate ways to open VS port

* Don't connect to varserv when quiet=true in trickops

* Add print to try to help debug hanging trickops test

* Handle multicast connect failures gracefully

* Multicast is disabled by default on mac

* Forgot an important return value

* Take away retries

* Fix issue with restart test

* Revert trickops debugging changes

* Remove debugging accidentally left in [no ci]

* whoops

* Allow retries

* Update trickops.py

* sim test adjustments

* Add docs [no ci]

* wording [no ci]

* Cleanup

* Remove large messages, test that one in unit tests
2023-02-24 14:44:55 -06:00
Jacqueline Deans
a8c9572186
Correct check for unsupported types in data recording (#1458) 2023-02-16 16:27:47 -06:00
Jacqueline Deans
26baac2088
Fix broken link in docs 2023-01-23 15:46:55 -06:00
Jacqueline Deans
8821bac18a
Handle empty PYTHON_MODULE in header comment (#1432) 2023-01-23 08:50:13 -06:00
Jacqueline Deans
e11ff83051 Add documentation on running Trick with sanitizers 2023-01-20 17:33:35 -06:00
Jacqueline Deans
5ff52a01c5
Add option to terminate sim on python event error (#1434) 2023-01-20 15:46:10 -06:00
Jacqueline Deans
75b05a865f
Correct function names in Variable-Server.md 2022-12-06 13:37:32 -06:00
Cody Martin
3870dc73b6
Improve tutorial documentation (#1408) 2022-12-02 14:55:40 -06:00
Jacqueline Deans
0933228dd5 Fix links in documentation 2022-11-30 13:18:56 -06:00
jmpenn
d1288e3bcf
Update How-To-Make-A-Release.md
Change the word "postfix" to "suffix" in three places to make the meaning clearer.
2022-11-29 16:32:35 -06:00
Jacqueline Deans
1b394e9386
Add test sim for interaction between data recording and checkpointing (#1398)
* Add test sim and documentation for interaction between data recording and checkpointing
* Dump failing logs from first phase jobs
2022-11-21 11:57:19 -06:00
Scott Fennell
a32befb71a
Update Developer-Docs-Home.md 2022-11-17 15:52:02 -06:00
Scott Fennell
a5412994bf move release guide to dev docs 2022-11-17 15:51:26 -06:00
Jacqueline Deans
d9e7ac250d
Refactored sim tests to run through TrickOps (#1390) 2022-11-17 15:43:29 -06:00
jmpenn
2a03ff5cf4
Replace sprintf with snprintf in all of Trick source. #1384 (#1392)
* Replace sprintf with snprintf in all of Trick source. #1384

* Don't add -Werror for MacOS because of deprecated sprintf warnings which we cant get rid of because SWIG. #1384

* Fixed an unbalanced parenthesis in S_overrides.mk. #1384
2022-11-15 15:00:05 -06:00
Scott Fennell
265513684a
Update Install-Guide.md 2022-11-15 09:54:17 -06:00
Jacqueline Deans
9d305fec09
Add a way to disable sim objects (#1364)
* Add set_sim_object_jobs_onoff, get_sim_object_on_off, and change set_sim_object_onoff to preserve the on/off status of jobs
2022-11-15 09:16:08 -06:00
Scott Fennell
716d35a63e
fix link in SSL to Webserver APIs 2022-11-10 12:10:14 -06:00
Scott Fennell
e65a0b0783
Add python 2 instructions to install guide 2022-11-04 09:20:09 -05:00
Deans
3b5d03fa14 Add section for developer docs 2022-11-01 10:36:15 -05:00
William Zijie Zhang
f8acca0f34
fix typo monte carlo tutorial (#1377) [no ci]
closes #1377
2022-10-31 05:35:35 -05:00
Jacqueline Deans
cbe2b7fe32
Update Checkpoints.md 2022-10-26 13:53:53 -05:00
Jacqueline Deans
1da5092ac8
Update Documentation-Home.md 2022-10-07 17:10:16 -05:00
Jacqueline Deans
bb34c37de7
Fix broken link in docs 2022-10-07 17:03:47 -05:00
Jacqueline Deans
ff04d211ee
Fix broken link in docs 2022-10-07 17:03:04 -05:00
Jacqueline Deans
2519c914a5
Pair checkpointing fix (#1356)
* Fix pair checkpointing bug, add tests
* Documentation update
2022-10-07 17:00:09 -05:00
Jacqueline Deans
3d2e8e52ca
Set checkpointing fix (#1357)
* Fix set checkpointing, add tests
* Documentation update
2022-10-07 14:24:21 -05:00
Jacqueline Deans
f19ba7df78
Test and Document STL Checkpointing (#1355)
* Updates SIM_stl to include checkpoint writing and checkpoint restore, as well as adding more data structures to test
* Thoroughly tests supported STL types with MM_stl_checkpoint and MM_stl_restore
* Adds an option to enable or disable STL restore in accessible interfaces and changes default to true
* Updates documentation on STL checkpointing to clearly state limitations and known bugs
2022-10-07 08:37:09 -05:00
Scott Fennell
1769bb7061
Update Install-Guide.md 2022-09-26 15:15:03 -05:00
Scott Fennell
99bdf509b3
Update Install-Guide.md 2022-09-26 15:11:21 -05:00
Scott Fennell
4ac9777ab8
Move Troubleshooting link 2022-09-26 15:10:12 -05:00
Scott Fennell
550991669d
Add uninstall old trick to troubleshooting in install guide 2022-09-26 15:09:32 -05:00
Scott Fennell
d8df914ebf
Add Environment section to Troubleshooting in Install Guide 2022-09-26 14:58:57 -05:00
John M. Penn
5906efe0f9 Document that Trick does not in fact yet support C++ STL types #1339 2022-09-02 16:33:53 -05:00
Jacqueline Deans
bcaaeedd89
Fix syntax on job_class_order docs 2022-08-26 11:51:25 -05:00
jmpenn
4c1271b43b
Update How-to-dump-core-file-on-MacOS.md
Add lines between title and header in an attempt to fix the weird rendering problem in which '>' gets injected .
2022-08-22 15:43:32 -05:00
John M. Penn
79916fcd04 Document Tweaks #1334 2022-08-22 15:29:15 -05:00
John M. Penn
9495f3cd27 Document How to Dump a Core-file on MacOS #1334 2022-08-22 15:24:01 -05:00
Jacqueline Deans
9c8799610f
Variable Server - var_send_once and integration test (#1330)
* Adds the send_once command and message type, which allows a user to request a variable to be sent immediately and only once (intended to replace the var_add, var_send, var_clear idiom that is commonly used for this purpose)
* Minor refactoring of variable server internals to reduce repeated code
* Adds SIM_test_varserv to integration test to test basic variable server functionality
* Changes graphics client for SIM_billiards to use var_send_once as an example of intended use
* Add documentation for var_send_once in docs and tutorial
* Set exit_code_enabled in trick unit tests to be true by default
* Patch for failing bookworm build
2022-08-18 10:47:07 -05:00
Jacqueline Deans
6d56c281e0
Fix broken link in Webserver.md 2022-08-15 14:16:29 -05:00
Scott Fennell
af4a40057d
Update Install-Guide.md
closes #1300 references #1302
2022-08-11 11:27:36 -05:00