@@ -3,16 +3,17 @@ Everyone is encouraged to contribute to Gryphon!
...
@@ -3,16 +3,17 @@ Everyone is encouraged to contribute to Gryphon!
# Bug reports
# Bug reports
For bug reports, please see [Reporting Bugs](Reporting-Bugs).
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:
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.
* Title.
* Text describing the change proposal.
* Text describing the change proposal.
* Mock screenshots, if applicable, to clarify the change.
* 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.
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:
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
cd ~/mp_gryphon/gryphon/python
...
@@ -26,7 +27,8 @@ These are the options:
...
@@ -26,7 +27,8 @@ These are the options:
The test generates the following output:
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
* Filename
* Schema name
* Schema name
...
@@ -36,6 +38,11 @@ The test generates the following output:
...
@@ -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 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.
* For generated diagrams, the number of diagrams generated for each of the seven diagram types.
