Commit Graph

214 Commits

Author SHA1 Message Date
jmpenn
fdb2bb20b9
Update Realtime-Best-Practices.md
Add "Did I mention you should buy more memory?" to 3.5 instead of "Buy more memory! Do it!" Makes it clear that it's intentional.
2024-05-21 11:48:48 -05:00
jmpenn
0c8bc45a84
Update Realtime-Best-Practices.md
Fix link format
2024-05-20 13:16:43 -05:00
jmpenn
4744408762
Update Realtime-Best-Practices.md
Fix example heading format:
Added space between ##### and title
2024-05-20 11:06:59 -05:00
jmpenn
95f357a937
Update How-To-Guides.md
Fix Link:
Change  .../RealTime-Best-Practices.md" to Realtime-Best-Practices.md"
2024-05-20 10:57:58 -05:00
John M. Penn
5b994e687d Fixed link to figure. 2024-05-16 21:17:25 -05:00
John M. Penn
92f1234deb Fix review issues. 2024-05-16 21:08:46 -05:00
John M. Penn
12d483f094 Mark down formating fixes to Realtime-Best-Practices.md 2024-05-13 14:44:17 -05:00
John M. Penn
353b5afd84 Wrote a Real-time Best Practices HOW TO 2024-05-13 13:49:46 -05:00
Pherring04
6937d003b3
fixed outdated trick_message function calls in documentation (#1691) 2024-04-18 13:48:20 -05:00
Mrockwell2
289da24d24
Update Environment Variables to cover TRICK_SWIG_EXCLUDE (#1628)
* Update Environment-Variables.md

* Added clarification to the exclude variables and their purposes.
2023-12-19 15:22:43 -06:00
Hong Chen
da0110536e
Add conda instruction to "How to Setup a Virtual Python Environment" (#1588)
* Added conda instruction to "How to Setup a Virtual Python Enironment" guide

* Corrected the table of content for "How to Setup a Virtual Python Environment"

* Added one bullet for removing a conda environment.
2023-10-12 11:26:13 -05:00
Jacqueline Deans
cad2e324fb
Update configure script to check for swig >= 3 (#1554) 2023-08-28 13:55:17 -05:00
Scott Fennell
7337e3b3fe
Fix Other Resources links in Checkpointing-Best-Practices.md (#1552) 2023-08-15 12:57:37 -05:00
jmpenn
43b12bb959
Update Checkpointing-Best-Practices.md
Undo my changes so I can merge Scott's pull request
2023-08-15 11:11:42 -05:00
jmpenn
3f840d65f5
Update Checkpointing-Best-Practices.md
Fix links in "Other Resources"
2023-08-15 10:53:32 -05:00
jmpenn
c56cce3d9e
Add Checkpointing-Best-Practices.md to How-to guides. (#1549) 2023-08-14 10:07:42 -05:00
Jacqueline Deans
93b1810a29
Bump swig dependency to 3-4 (#1550) 2023-08-14 10:06:58 -05:00
John M. Penn
8ba7e59335 Add HOWTO for Python VIrtual Environment. 2023-08-07 10:16:29 -05:00
Hong Chen
bbe9768a30
Added separate_thread_set_enabled(bool) function to MessageSimObject class (#1523)
* Added separate_thread_set_enabled(bool) function to MessageSimObject class for user to use the feature of letting trick to write the messages out on a separate thread in a more intuitive way (hopefully ;-).

* Updated Status-Message-System.md for the newly added separate_thread_set_enabled(bool on_off) function in MessageSimObject class of default_trick_sys.sm

* Fixed the bullets

* Put missing update in due to merge.
2023-06-29 13:31:03 -05:00
Jacqueline Deans
d3cc021cca Move VariableServerSession logs into subdirectory; make separate toggle for session logs 2023-06-26 12:23:58 -05:00
Deans
99ee88a686 Add more Variable Server unit and integration tests, clean up and clarify naming 2023-06-26 12:23:58 -05:00
Hong Chen
b2d7721d20
1501 update python 2 to 3 in documents (#1516)
* Updated example code from Python 2 to 3 in How to Get Simulation Time from the Variable Server How-To Guide.

* Removed one line of commented code.

* Modified the examples in Trick Variable Server Tutorial from Python2 to 3 mainly due to socket send in bytes plus print statement update need for Python 3.

* Fixed 2 missed print statements.
2023-06-12 10:26:25 -05:00
Adam M Garsha
e102dd7ef2
Revised Monte Carlo Tutorial Page (#1511)
* Adding new monte carlo tutorial images

* Delete Trick-QP-Random.png

* Delete Trick-QP-Calculated.png

* Delete Trick-QP.png

* Delete Trick-QP-File.png

* Delete Trick-DRE.png

* Delete Trick-DP.png

* Added Trick-DP image

* Broad Tutorial Modifications

Lots of the content was changed. The navigation and headers are not correct yet.

* Fixed table of contents

* Fixed toc again
2023-06-07 11:10:59 -05:00
Jacqueline Deans
506bac5de7
Move ICG parsing standard specification to separate flag (#1517) 2023-06-05 14:40:32 -05:00
Jacqueline Deans
9c356131bc
Add option to specify a C++ standard to ICG for parsing (#1499) 2023-06-01 13:43:23 -05:00
Jacqueline Deans
2ef76cf42a Add old design documentation under developer_docs 2023-05-04 08:53:56 -05:00
Jacqueline Deans
4a3eaacb6e Add developer documentation for the CI setup. 2023-05-01 14:20:57 -05:00
Jacqueline Deans
6c685d8400
Revise Documentation, Correct a single constant (#1326) (#1489)
* Fix formatting, grammar, and syntax

Additionally, a sentence that referenced something that isn't used anywhere was removed.

* Promote headers, Format stuff

Many headers were far too deep. In some cases, the highest header was h4. To correct this, the offending headers were promoted once or twice as appropriate. Minor formatting changes were made, too.

* Fixed an incorrect conversion constant.

* Update library dependency explanation

The old explanation was confusing and seemingly self contradicting in places. This new explanation aims to fix that.

Co-authored-by: Matthew Elmer <m.elmer@mailbox.org>
2023-04-21 17:32:31 -05:00
Jacqueline Deans
c4f77b570e
Add developer docs for debugging python environment issues (#1488) 2023-04-18 11:28:14 -05:00
Jacqueline Deans
d76de7e1ee
Allow for read only S_sie.resource (#1420) 2023-04-17 17:23:48 -05:00
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