Changes

Page history
Update home authored by Allen, Bruce (CIV)'s avatar Allen, Bruce (CIV)
Show whitespace changes
Inline Side-by-side
home.md
View page @ 4edbf282
Gryphon provides a stand-alone Python GUI interface for viewing graphs created using the Monterey Phoenix V4 trace-generator.
# Installing MP Gryphon
Please see [Installing MP Gryphon](Installing MP Gryphon).
# Example screenshot
Here is an example screenshot of the Gryphon GUI showing trace 2 of preloaded example `Example03_ATMWithdrawal_BehaviorOfEnvironment.mp`, with regions of the screen identified using circled numbers:
![example main window](screenshots/main_window.png)
Regions:
1. Main menu
1. Toolbar
1. Code editor
1. Main graph
1. Navigation column
1. Action log
1. Action status
## Main Menu
Here is a brief summary of main menus:
* File:
* Open and save .mp files
* Open preloaded examples, search for .mp code by filename or by text within files
* Take session .gry snapshots, restore snapshots
* Import and export .gry sessions for backup, sharing, and transport
* Export graph views for publication
* Edit:
* Undo/redo, cut, copy, paste
* Find and replace
* Search for .mp code in other files
* Spellcheck management
* Actions:
* Show model statistics of the last run of the trace generator
* Settings:
* Control visibility of Type 1 probability
* Theme management:
* Preset themes
* Custom themes
* Export/import of colors or colors plus graph layout settings
* Code editor:
* Spellcheck management
* Line mode for managing word wrap
* Control whether to use auto-indent
* Control use of split screen editing
* Graph pane:
* Undo/redo move
* Zoom control
* Management of border and hidden components
* Navigation pane
* Scroll mode
* Reset GUI preferences to default values
* Allow ignoring model statistics warnings
* Gryphon configuration (for special circumstances; please leave these alone)
* Help:
* About Gryphon
* Keyboard shortcuts
* Online documentation
* Reporting issues
## Toolbar
* Open and save shortcuts
* Trace generator management: Run, scope selection
* Event visibility management:
* Showing hidden events
* Collapsing/expanding Root and Composite events
* Managing opacity of hidden and collapsed events
* Zoom controls
* Selection of dark/light mode
## Code Editor
* Left-clicking in the code editor pane opens the same edit menu as the one in the main menu.
* Clicking and dragging over text selects text.
* Double-clicking words selects words. The spellchecker allows selecting alternate spelling or accepting the spelling of selected text.
* Typing the first three letters of a word opens an auto-complete menu. Tab completes a suggested word.
* Keyboard shortcuts are available for edit functions, find and replace, and auto-complete.
## Main Graph
The main graph displays the selected graph view. A displayed graph consists of:
* A trace (unless the global view at index 0 is being displayed).
* Zero or more view objects. View objects are activity diagrams, bar charts, Gantt charts, graphs, reports, and tables.
* View objects at index 0 are global view objects. View objects ad index values above 0 are trace-specific.
Appearance is configurable:
* The color and positioning of items and what view objects have borders are established when the trace generator is run.
* Once rendered, positioning, theme colors, and use of borders may be changed using settings.
Layout is configurable:
* Select and move items. See keyboard shortcuts for the graph pane.
* Move edges by selecting on them and then dragging their grips.
* Undo/redo movement.
* Use context menus on nodes, edges, and view object regions to manage positioning, visibility, and bordering.
## Navigation Column
The navigation column lists all graphs created by the trace generator. This includes:
* The global graph at index 0 if any global view objects are generated
* Traces and associated trace-specific view objects after index 0.
The traces displayed and the order they are displayed depend on sort and filter settings.
Sort:
* Sort by Mark flag, size, probability, and index.
* Sort by numeric attributes in trace SAY blocks.
Filter:
* Filter out unmarked traces.
* Filter out traces that do not match user-defined relationships between events or events that do not meet user-defined recurrence values.
Browse:
* Scroll through traces
* Select traces to display in the main graph
* Each trace shown in the navigation browser includes the trace index, the Type-1 probability if enabled, and the mark flag if marked.
## Log Pane
* The log pane records user actions and results from commands.
## Status Bar
* The status bar displays status of current the user interaction.
# Introductory Example
In this example we open the ASPIRE competency assessment schema from preloaded examples, build traces, and examine content.
1. Start Gryphon
1. Load the Existence of Competency schema (.mp file) from preloaded examples by clicking on the Open button ![open](uploads/437f889fb210721f15868fb75a819c36/open.png) and selecting "Open Example | Application Examples ASPIRE_Competency_Assessment_Context.mp". When the example loads the .mp text shows up in the code pane.
1. Leaving the Scope at 1 ![scope1](uploads/7dc51f4e8ba41eb1b1b823250e7bbaf5/scope1.png) to bound the scope of trace generation to one, click Run ![run2](uploads/8d790e2f0894a8222f1d96b5014a31a9/run2.png). When the run completes:
* The navigation pane shows the available traces.
* The main graph pane shows the view for trace 1.
1. Change preferences, for example select dark mode and increase the size of the main graph area.
1. Change settings, for example select the Navy preset color theme.
1. Work with items in the main graph view:
1. Select multiple items, move them, and use undo to move them back.
1. Right-click the "Employees" root node and select "Collapse".
1. Hover over the "start time" element in the "take AI Test" bar of the Gantt chart to see its actual value.
1. Hide the Gantt chart component using its context menu.
1. Export graph 1 as a .pdf, hint: use "Settings | Themes | Custom theme... Exported Views".
1. Using the navigation pane, select the global graph view.
1. Select and drag an edge from one of the activity diagrams to give it multiple bends. Then use its context menu to reset its route. Then use undo/redo using Ctrl+Z and Ctrl+Y.
1. Use the table's context menu to export the table to CSV.
1. Work with text in the graph pane:
1. Spellchecker:
1. Find a word that is flagged as misspelled, double-click on it, right-click to open the edit menu, then add it to the whitelist.
1. Select and copy all words using Ctrl+A and then Ctrl+C, open the spellchecker whitelist from the menu, click on the whitelist editor, and paste everything in using Ctrl+V.
1. Press Return or click outside the whitelist editor to see the updated whitelist.
1. Editing:
1. Use the Edit menu and code editor keyboard shortcuts table to find access to Find and Replace, auto-complete, and other editing functions.
# Welcome to Monterey Phoenix (MP) Gryphon
![MP logo](images/phoenix_logo_color-01nps_cropped.jpg){width=300}
![NPS logo](images/nps_logo_hz.jpg){width=200}
Gryphon provides a GUI interface for viewing graphs created using the Monterey Phoenix V4 trace-generator. Gryphon is currently available for Windows, Mac M1, and Ubuntu Linux systems:
* **Windows** and **Mac** distributions automatically connect to a Gryphon Server for accessing the MP trace generator.
* The **Ubuntu Linux** distribution has the MP trace generator built in and runs stand-alone.
# Documentation
* [Installing Gryphon](Installing MP Gryphon)
* [Introduction to the Gryphon User Interface](Introduction to Gryphon)
* [An Introductory Example](Introductory Example)
* [Working with Gryphon](Working with Gryphon)
* [Contributing to Gryphon](Contributing to Gryphon)
* [Release Notes](Release Notes/Gryphon v1.3.0)
* [License](License)
# Resources
* MP home page: https://wiki.nps.edu/display/MP/Monterey+Phoenix+Home
......
......