Commit Graph

225 Commits

Author SHA1 Message Date
b794aba68d Update Input-File.md to describe the Factory Function method of alloc… (#1763)
* Update Input-File.md to describe the Factory Function method of allocating objects from the input file.

* Fix issues caught during review. #1763
2024-08-28 10:39:54 -05:00
d2ec14dc02 Wiki button (#1755)
* Added a wiki button

* Removed commented code

* Updated SCP image

---------

Co-authored-by: Pherring04 <plherrin@JSLRL0523040929.ndc.nasa.gov>
2024-08-27 15:03:33 -05:00
b87598c80c Updated to use default-jdk package instead of openjdk-11-jdk for ubuntu. (#1757)
* Updated to use default-jdk package instead of openjdk-11-jdk for ubuntu.

* Added a note for using a specific JDK version for ubuntu.

* Fixed typo
2024-08-20 10:36:16 -05:00
446f1fa757 1747 create a document page for simulation control panel (#1750)
* Created a basic outline for the documentation

* Filled in outline more

* Created the reference images

* Documentation update

* Finish rough draft of Sim Control Panel documentation

* Updated the Throttle documentation

* Documentation updates

* Standardized punctuation

* Update

* Updated Docs

* update control panel

* Unseasoned Simulation Connection

* Shenanigans

* Fixed the shenanigans

* Changed to passive voice, updated graphic

* Update SimControlPanel.md for consistency and clean-up
2024-08-06 10:19:02 -05:00
a9aa7088ad SWIG 4 Template Directive Changes (#1741)
* Updated convert_swig to account for template directive changes in SWIG 4

* Fixed merge issues

* Merge cleanup
2024-07-23 11:45:37 -05:00
f666708374 Repurposed -OO for all sim run outputs including S_sie.resource being saved in the specified directory. (#1714)
* Repurposed -OO so all sim run outputs including S_sie.resource are saved to the specified folder. The files are placed in the sub-dir either RUN_xxx or DP_Product of the specified folder.

* Updated for repurposed -OO.

* Added quoting code markdown for such as in order to show <name> as is.

* Added quoting code for missing items.

* Updated to raise an error when the --read-only-sim flag is used without the -O or -OO. Also made updates to the related document accordingly.

* Fixed the error message to be more clear.
2024-07-16 10:31:52 -05:00
b3c825d026 Fix typo in Realtime Best Practices (#1732)
Remove a duplicate _frame from a plain text version of a filename
2024-06-18 15:05:58 -05:00
c2c068a04a Made updates for macOS especially for Apple Silicon. (#1721) 2024-06-05 11:58:03 -05:00
e044d1f13a Fixed links 2024-05-29 10:41:04 -05:00
982a434957 Update Simulation-Definition-File.md
Added an actual link instead of a placeholder
2024-05-29 10:29:58 -05:00
27e4264c2a Removed double quotes for port number and added some inline code syntax highlighting with back-ticks. (#1717)
* Removed double quotes for port number and added some inline code syntax highlighting with back-ticks.

* Added one more inline code syntax highlighting.
2024-05-23 10:13:50 -05:00
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
0c8bc45a84 Update Realtime-Best-Practices.md
Fix link format
2024-05-20 13:16:43 -05:00
4744408762 Update Realtime-Best-Practices.md
Fix example heading format:
Added space between ##### and title
2024-05-20 11:06:59 -05:00
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
5b994e687d Fixed link to figure. 2024-05-16 21:17:25 -05:00
92f1234deb Fix review issues. 2024-05-16 21:08:46 -05:00
12d483f094 Mark down formating fixes to Realtime-Best-Practices.md 2024-05-13 14:44:17 -05:00
353b5afd84 Wrote a Real-time Best Practices HOW TO 2024-05-13 13:49:46 -05:00
6937d003b3 fixed outdated trick_message function calls in documentation (#1691) 2024-04-18 13:48:20 -05:00
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
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
cad2e324fb Update configure script to check for swig >= 3 (#1554) 2023-08-28 13:55:17 -05:00
7337e3b3fe Fix Other Resources links in Checkpointing-Best-Practices.md (#1552) 2023-08-15 12:57:37 -05:00
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
3f840d65f5 Update Checkpointing-Best-Practices.md
Fix links in "Other Resources"
2023-08-15 10:53:32 -05:00
c56cce3d9e Add Checkpointing-Best-Practices.md to How-to guides. (#1549) 2023-08-14 10:07:42 -05:00
93b1810a29 Bump swig dependency to 3-4 (#1550) 2023-08-14 10:06:58 -05:00
8ba7e59335 Add HOWTO for Python VIrtual Environment. 2023-08-07 10:16:29 -05:00
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
d3cc021cca Move VariableServerSession logs into subdirectory; make separate toggle for session logs 2023-06-26 12:23:58 -05:00
99ee88a686 Add more Variable Server unit and integration tests, clean up and clarify naming 2023-06-26 12:23:58 -05:00
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
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
506bac5de7 Move ICG parsing standard specification to separate flag (#1517) 2023-06-05 14:40:32 -05:00
9c356131bc Add option to specify a C++ standard to ICG for parsing (#1499) 2023-06-01 13:43:23 -05:00
2ef76cf42a Add old design documentation under developer_docs 2023-05-04 08:53:56 -05:00
4a3eaacb6e Add developer documentation for the CI setup. 2023-05-01 14:20:57 -05:00
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
c4f77b570e Add developer docs for debugging python environment issues (#1488) 2023-04-18 11:28:14 -05:00
d76de7e1ee Allow for read only S_sie.resource (#1420) 2023-04-17 17:23:48 -05:00
1b38c36d09 Update FAQ.md 2023-04-17 14:28:58 -05:00
bc1be92e84 Update FAQ.md 2023-04-17 14:28:17 -05:00
ffed03521c Update Install-Guide.md 2023-04-13 14:26:25 -05:00
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
19016b4817 job_class_order no longer accidentally disables some system job classes (#1465) 2023-03-07 08:43:39 -06:00
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
3b630c33dc markdown render fix. 2023-03-01 17:16:29 -06:00
4999b076f4 Typos. 2023-03-01 16:58:35 -06:00
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