Update Contributing to Gryphon authored by Allen, Bruce (CIV)'s avatar Allen, Bruce (CIV)
......@@ -3,16 +3,17 @@ Everyone is encouraged to contribute to Gryphon!
# Bug reports
For bug reports, please see [Reporting Bugs](Reporting-Bugs).
# Clarifications, Improvements, and Features
# Clarifications, improvements, and features
If you would like to suggest improvements and new capabilities for Gryphon please submit an issue. Go to https://gitlab.nps.edu/monterey-phoenix/user-interfaces/gryphon/-/issues and click the blue "New issue" button. Please provide:
* Title.
* Text describing the change proposal.
* Mock screenshots, if applicable, to clarify the change.
# Testing
# Manual testing
Test the Gryphon GUI by trying out the various controls in the menus, the code editor, and the main window.
# Automated testing
Automated testing is also available for testing .mp files, the trace generator, and core Gryphon components. For automated testing, run `test.py [-p <path to models>] [-i <index>] [-s <scope>]`. For example:
cd ~/mp_gryphon/gryphon/python
......@@ -26,7 +27,8 @@ These are the options:
The test generates the following output:
* A comma separated value (CSV) output file that can be imported into a spreadsheet. Columns include:
## CSV log
The CSV log is a comma separated value output file that can be imported into a spreadsheet. It contains totals of various attributes, useful for quantifying trace generation and for detecting changes due to modifications or regression. Columns include:
* Filename
* Schema name
......@@ -36,6 +38,11 @@ The test generates the following output:
* For traces, the number of marked traces, number of nodes, number of edges, and the sum of the probabilities.
* For generated diagrams, the number of diagrams generated for each of the seven diagram types.
Here is an example spreadsheet view:
![test_log](uploads/30da856aab4e14259cf0578eff282061/test_log.png)
##
# Code
Please submit code by submitting pull requests. Here is the basic workflow:
* Clone the Gryphon repository.
......
......