Skip to content
Snippets Groups Projects

Contributing to Gryphon

Last edited by Allen, Bruce (CIV)

Everyone is encouraged to contribute to Gryphon!

Reporting Bugs

Please report any Gryphon bugs by email or by submitting an issue. To submit an issue go to https://gitlab.nps.edu/monterey-phoenix/user-interfaces/gryphon/-/issues and click the blue "New issue" button. When reporting bugs please include this information:

  • The Gryphon version
  • The .mp code that generates this error
  • The diagnostics text that Gryphon prints in the command window
  • Screenshots, if applicable

Requesting 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.

Manual testing

You can test the Gryphon GUI by interacting with the various controls in the menus, the code editor, and the main window.

Automated testing

In environments where source code is distributed, automated testing is 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>] at a command prompt. For example:

cd ~/mp_gryphon/gryphon/python
./test.py

Optional parameters are:

  • -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 under the same directory in files and directories prefixed with _test:

  • CSV log
  • Trace and global view graphs
  • Runtime status

Extending Research

Research projects can result in new capabilities that can then be integrated into Gryphon. Researchers working on projects that automate access to data structures derived from trace generation are encouraged to start with .gry files. .gry files contain the entire state of a given project including its .mp code, all traces generated when the trace generator was run, and all settings. The .gry format is described at Gryphon .gry JSON File Format.

Submitting Pull Requests

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.
  • Submit a pull request.

Gryphon version control and code management is performed using Git. For references on using Git please see https://git-scm.com/doc. To enable key-managed SSH authentication with the NPS GitLab Server please install your RSA Public key, see https://gitlab.nps.edu/-/profile/keys.