Update Contributing to Gryphon authored by Allen, Bruce (CIV)'s avatar Allen, Bruce (CIV)
Everyone is encouraged to contribute to Gryphon!
* If you would like to suggest improvements and new capabilities for Gryphon please go to https://gitlab.nps.edu/monterey-phoenix/user-interfaces/gryphon/-/issues and click the blue "New issue" button.
* If you would like to contribute code, please read on:
# Contributing code to Gryphon
Please submit code using pull requests. Here is the basic workflow:
# Bug reports
For bug reports, please see [Reporting Bugs](Reporting-Bugs).
# 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
Test the Gryphon GUI by trying out the various controls in the menus, the code editor, and the main window.
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
./test.py
These are the options:
* `-p <path to models>` - A directory containing .mp models to test with, default `../../preloaded-examples/models`.
* `-i <index>` - Use this option to test just the .mp model at this index.
* `-s <scope>` - Use this to specify the scope, default scope is one.
The test generates the following output:
* A comma separated value (CSV) output file that can be imported into a spreadsheet. Columns include:
* Filename
* Schema name
* Scope
* Run time, in seconds
* Number of traces generated
* 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.
# Code
Please submit code by submitting pull requests. Here is the basic workflow:
* Clone the Gryphon repository.
* Create a branch for your work.
* Add your code.
......
......