_{Updated 2022-11-04}

Getting Started with the Hive Gateway¶

Note

The Hive Gateway has been in production since October 2020.

The Hive Gateway allows users to manage jobs and submit projects through a web-based interface.
This guide will go over each section of the Gateway and the basics of how to get started using them
For quick access to additional Hive Gateway Guides, checkout these links:

Note

For most users, you do not need to create an account. You should using your existing Institution Credentials (including Georgia Tech).

Click on the [Create Account][https://gateway.hive.pace.gatech.edu/auth/create-account] link.
If you have credentials included in the Existing Institution list, choose Sign in with Existing Institution Credentials
If you do have credentials included in the Existing Institution List, fill out the form below *Create a PACE Gateway
In either case, a request will be sent to the PACE Gateway Administrators to be activate.

Here is the link to the Hive Gateway: gateway.hive.pace.gatech.edu
Begin by clicking Log in in the upper right hand corner of the web page
If you have access through one of the available Identity Providers (Georgia Tech is included), you should select it. Clicking Log on and then log-in at the Identify Provider page.
Otherwise, you may log-in with a local account. Note that you can use the Georiga Tech with the Existing Institution Credentials

Screenshot

The utility bar includes the title PACE Gateway, the Notifications section, the Workspace dropdown ( which allows you to switch to the groups page or the settings page), and the option to log out

Screenshot

To log out of the Hive Gateway, click on your name in the top right corner
This will display a drop down that allows you to log out and return to the Hive Gateway home page
If you want to visit the home page while still logged in, then you can click the PACE Gateway title in the top left corner

Screenshot

The Notifications section has a badge next to the bell icon displaying the number of notifications you recieved since the last time you checked them
You can click on the bell icon to view and manage your notifications
Notification are generally for account level activity, such as "you were added to a new group", and not experiment-specific activity

Screenshot

You will arrive at the Dashboard in the Workspace section by default when logging in
This section is where you manage your projects and experiments and submit jobs
Click on the workspace tab in the utility bar to display a dropdown containing the Groups and Settings tabs

Screenshot

The Groups tab will take you to the Groups section which displays that groups that you are currently a part of and some information about them
More information about groups is available on the Groups page of the docs

Screenshot

In the Settings section, you can adjust application settings, manage users based on your permissions, view experiment statistics, and more
This section will change based on your permissions, so you should feel free to explore and see what you can do

Screenshot

This section contains the different applications that you have access to that you can use for your projects and displays your recent experiments
To submit a job/run an experiment, you will click on the application tile that you want to use and fill out the necessary information for the job when redirected to that application's experiment page
Running an experiment is synonymous with running a job
You can mark an application as a favorite by clicking the star icon in the application tile, and it will appear above all the other available applications in a section titled Favorites from now on
In a column on the right side, you will also see the most recent experiments that you have run with information including the names of the experiments, the applications used, their current status (executing, failed, completed etc), and when their status was last updated. You can also click on a recent experiment to clone and run it again.

Screenshot

Experiments are the terminology for computations or simulations.
This section allows you to view past and in-progress experiments that were shared with you or ones that you created
You can view information such as the name of the experiement, the application that it used, the user in your group that ran it, its creation time, and its status
If you want more in-depth information about an experiment including the files it produced and errors, simply click on the experiment name to be taken to the experiment summary
The clone option lets you copy a past experiment in order to quickly run it again

Screenshot

This section allows you to view and create projects
You can view information about your projects including their name, owner, and creation time
A project is a container for experiments. Creating a project automatically creates a project directory, and all the experiments you run that you associate with the project will appear in that directory

Screenshot

If you'd like to create a new project, you can click the New Project button in the top right

Screenshot

If you want to share a project with your group or other users, you can click the Edit button under the actions column for a project and then click the Share button that shows up in the top right

Screenshot

This section allows you to manage file storage for your projects
By default, you will have a directory created for each of your projects that contain folders for the experiments in that project, each of which contain the files used for and generated by that experiment
To add a new directory to place files in, enter a directory name in the text box containing New directory name and click add directory
If you'd like to add files to storage, use the box titled Drop files here or browse
When these files are added, they will automatically be placed in the current directory you are in, so if you'd like to put them inside a particular directory, navigate into that directory first

Screenshot