Update Installing MP Gryphon authored by Allen, Bruce (CIV)'s avatar Allen, Bruce (CIV)
...@@ -6,7 +6,7 @@ The MP Gryphon toolset consists of the following: ...@@ -6,7 +6,7 @@ The MP Gryphon toolset consists of the following:
* **Preloaded examples** - Contains examples and snippets of MP code. * **Preloaded examples** - Contains examples and snippets of MP code.
# Compatibility # Compatibility
Gryphon is compatible with Mac, Windows, and Ubuntu Linux. For Mac and Windows, trace generation currently must be performed on a remote server. For Linux, trace generation is performed locally and does not need and Internet connection. Gryphon is compatible with **Windows**, **Mac**, and **Ubuntu Linux**. For Mac and Windows, trace generation currently must be performed on a remote server. For Linux, trace generation is performed locally and does not need and Internet connection.
# Installing Gryphon # Installing Gryphon
The installation approach is different based on the operating system you are using. **Windows** and **Mac** installations currently additionally require access to a Gryphon server to generate traces and to perform syntax checking. The installation approach is different based on the operating system you are using. **Windows** and **Mac** installations currently additionally require access to a Gryphon server to generate traces and to perform syntax checking.
...@@ -21,32 +21,34 @@ The installation approach is different based on the operating system you are usi ...@@ -21,32 +21,34 @@ The installation approach is different based on the operating system you are usi
1. Unzip the preloaded examples .zip file. 1. Unzip the preloaded examples .zip file.
1. To Run Gryphon, double-click on the MP Gryphon executable file. 1. To Run Gryphon, double-click on the MP Gryphon executable file.
1. When Gryphon starts, set the preloaded examples path to the path where you unzipped the preloaded examples. You may change the preloaded examples path using the `Settings | Preloaded Examples Path...` menu option. 1. When Gryphon starts, set the preloaded examples path to the path where you unzipped the preloaded examples. You may change the preloaded examples path using the `Settings | Preloaded Examples Path...` menu option.
1. Connect to an MP Gryphon server, see below.
## Mac ## Mac
Mac installation includes installing software that MP Gryphon relies on and is performed by typing commands into a command terminal. The Mac installation consists of installing software that MP Gryphon relies on and installing Gryphon repositories. The Mac installation is performed by typing commands into a command terminal.
1. Open a command terminal: Click on Launchpad and type `terminal` to single out the command terminal. Click on the Terminal icon. 1. Open a terminal: Click on Launchpad and type `terminal` to single out the command terminal icon. Click on the Terminal icon to open a command terminal.
1. Install the software that MP Gryphon relies on by typing the following: 1. Install prerequisite resources by typing or pasting the following commands in the terminal:
pip3 install –upgrade pip pip3 install –upgrade pip
pip3 install pyside6 pip3 install pyside6
pip3 install pyqtdarktheme pip3 install pyqtdarktheme
1. Install the tool to get Gryphon tools 1. Install the `git` tool to download the Gryphon and preloaded-examples repositories:
git git --version
and install git If you do not already have git, follow the prompts to install it. If a version shows up, then you already have git installed.
1. Install MP Gryphon and the preloaded examples 1. Install MP Gryphon and the preloaded examples by typing or pasting the following into the terminal:
mkdir mp_gryphon mkdir mp_gryphon
cd mp_gryphon cd mp_gryphon
git clone https://gitlab.nps.edu/monterey-phoenix/user-interfaces/gryphon.git
git clone https://gitlab.nps.edu/monterey-phoenix/mp-model-collection/preloaded-examples.git
1. Find the MP Gryphon GUI: This file is installed under your home directory folder at `mp_gryphon/gryphon/python/MP_Gryphon.command`. To find this file: open the Finder, click on the finder's `Go` menu and select `Go to Folder...`. Then type in `MP_Gryphon.command`. As a shortcut, you can copy this file and paste it onto your desktop to launch it from there.
1. Run MP Gryphon by double-clicking on the `MP_Gryphon.command` icon.
Perform the installation 1. Connect to an MP Gryphon server, see below.
## Ubuntu Linux ## Ubuntu Linux
Download the MP Gryphon installer from https://gitlab.nps.edu/monterey-phoenix/user-interfaces/gryphon/-/blob/master/install_mp.bash. Make the installer executable and then run it by typing this in a command window ![terminal_emulator](uploads/2e92ad4cfa2db13bd7f47976ca2c184d/terminal_emulator.png): Download the MP Gryphon installer from https://gitlab.nps.edu/monterey-phoenix/user-interfaces/gryphon/-/blob/master/install_mp.bash. Make the installer executable and then run it by typing this in a command window ![terminal_emulator](uploads/2e92ad4cfa2db13bd7f47976ca2c184d/terminal_emulator.png):
...@@ -60,7 +62,7 @@ Once installed, run Gryphon from a command window by changing to the directory c ...@@ -60,7 +62,7 @@ Once installed, run Gryphon from a command window by changing to the directory c
cd ~/mp_gryphon/gryphon/python cd ~/mp_gryphon/gryphon/python
./mp.py ./mp.py
# Connecting to the MP Gryphon Server # Connecting to an MP Gryphon Server
Windows and Mac users must connect to a MP Gryphon server. Several options are available: Windows and Mac users must connect to a MP Gryphon server. Several options are available:
| MP Gryphon server | Gryphon server hostname | Port | | MP Gryphon server | Gryphon server hostname | Port |
...@@ -69,9 +71,9 @@ Windows and Mac users must connect to a MP Gryphon server. Several options are ...@@ -69,9 +71,9 @@ Windows and Mac users must connect to a MP Gryphon server. Several options are
| AWS (Outside NPS) | 52.61.41.234 | 6000 | | AWS (Outside NPS) | 52.61.41.234 | 6000 |
| Same machine | localhost | 6000 | | Same machine | localhost | 6000 |
* If you are connected to the NPS Intranet please use the NPS server. This is the default. * If you are connected to the NPS Intranet please use the **NPS** server. This is the default.
* If you are outside the NPS Intranet, use the Amazon Web Service (AWS) server. * If you are outside the NPS Intranet, use the Amazon Web Service (**AWS**) server.
* If you have the Gryphon server running locally through a Docker container, use "Same machine". * If you have the Gryphon server installed and running locally through a Docker container, use **Same machine**.
Select a server as follows: Select a server as follows:
...@@ -82,6 +84,3 @@ Select a server as follows: ...@@ -82,6 +84,3 @@ Select a server as follows:
This screenshot shows the configuration used for the AWS server: This screenshot shows the configuration used for the AWS server:
![AWS_Gryphon_Server_Endpoint](uploads/773673fe8e2d39d6d72e62ea5b9d0060/AWS_Gryphon_Server_Endpoint.png) ![AWS_Gryphon_Server_Endpoint](uploads/773673fe8e2d39d6d72e62ea5b9d0060/AWS_Gryphon_Server_Endpoint.png)
# Pointing to the Preloaded Examples
Set the preloaded examples path to the `preloaded-examples` folder that you previously unzipped using the `Settings | Preloaded Examples Path...` menu option.
\ No newline at end of file