ARCHIVED: SEAGrid portal user guide
The Airavata team developed the hosted SEAGrid portal UI for interested science and scholarly communities. The following explains how to:
- Use Airavata as a middleware platform for a complete science gateway experience
- Register an account
- Create and modify projects
- Create, execute, and monitor experiments
- Submit issues, feedback, and requests for new applications
For more about Airavata, visit the Airavata site.
On this page:
- Test/demo environment details
- Logging into Gateway
- Create and search projects
- Create and launch experiments
- Browse experiments
- Modify, cancel, and clone experiments
- User assistance
Test/demo environment details
For information about the test/demo environment:
- See the PHP Reference Gateway link in https://seagrid.org/.
- Download application input files from Sample Application Input Files.
Logging into Gateway
Creating an account
To create an account:
- In the top right corner of the SEAGrid portal, select .
- On the Create New Account page, fill out all required fields denoted with an asterisk (*).
Important:
- Username cannot have spaces
- Username and password must be longer than 5 characters
- Password is case sensitive and requires at least one number, one symbol (for example,
! @ # $ %
), one uppercase letter, and one lowercase letter
- Click . You will see a confirmation message.
Confirming and verifying your account
Once the account is created, you will receive confirmation email. Click the link in the message and follow the instructions.
- Until the gateway administrator verifies your account, you will not be able to submit jobs on computer resources.
- The gateway administrator might contact you through email to get more information on research interests in order to assist you.
Logging into your account
Once the account is created, to log into the gateway, go to https://seagrid.org/login.
Alternatively, from the Create New Account page, click .
Creating and searching projects
Creating projects
To create projects:
- From the main menu, select
Before submission, you can clear fields by clicking
.
, and then . Enter the project name (mandatory) and project description (optional).
- Click . You will be taken to the "Project Summary" page.
Search projects
To search projects:
- From the main menu, select , and then .
- Under "Search by", select either or .
- Under "for", enter a value to search. Click
All the projects will be listed based on the entered key-value pair.
Notes:- To search for all projects, use an asterisk (
*
) as a wild character. The wild character is compatible with both and options. - To navigate through existing projects, at the top of the list on the right, click .
.
- To search for all projects, use an asterisk (
- To view the "Project Summary" page for a given project, at the end of the row for that project, click . The page will list all the experiments created under that project.
Create and launch experiments
Create experiment
To create an experiment:
- From the main menu, select , and then .
- On the "Create a new experiment" page, complete the required fields marked by an asterisk (*). If you need to clear the fields, click .
- Click .
- Under "Application configuration", complete the following fields:
- Application input: Enter the data manually or upload a single or multiple files.
Note:The gateway doesn't check the validity of uploaded files. Make sure you upload the correct files.
- Compute Resource: Select a resource from the drop-down menu.
- Node Count: Enter a value equal to or greater than 1.
- Total Core Count: Enter a value equal to or greater than 1.
- Wall Time Limit: Enter a value equal to or greater than 0.
Notes:
For the "Node Count", "Total Core Count", and "Wall Time Limit" fields, if you don't enter a value, the default value will be taken as the input.
The values for "Node Count" and "Total Core Count" can sometimes be decided based on the application and/or resource. Be sure to check the values for accuracy.
- Application input: Enter the data manually or upload a single or multiple files.
- To start over at any time, click
To save the experiment, click
or . You will be taken to "Experiment Summary" page; you can refresh the page and monitor experiment status changes.
.
Launch experiments
You can launch an experiment using one of the following options:
- To save and launch an experiment immediately from the "Create a new experiment" page (see the Create experiment section), select .
- To save and launch an experiment later, from the "Create a new experiment" page, save the experiment by clicking . Launch the experiment from the "Experiment Summary" page.
Browse experiments
To search for experiments you created:
- From the main menu, select Note:Alternatively, select Search projects section., then , and then (by clicking on the status of the experiment); refer to the
, and then . All the experiments you created will be listed, with the latest on top.
- Select a search key and enter a value:
- On the "Search for Experiments" page, from the "Search by" drop-down menu, select one of the following keys:
- Under "for", enter a value to search; it can be a partial value, complete value, or a wild card (
*
). You can also search for a status.
- On the "Search for Experiments" page, from the "Search by" drop-down menu, select one of the following keys:
- Click . The page will list all the experiments that match your key value and search term.
- Locate the desired experiment and click . The "Experiment Summary" page will appear.
From the "Experiment Summary" page, you can launch, cancel, clone, or edit an experiment.
Modify, cancel, and clone experiments
Modify experiments
You can modify or update experiments that have the status of "CREATED" or "VALIDATED". To do so, next to the experiment name, click the Edit icon (looks like a pencil); alternatively, from the "Experiment Summary" page, click
.You can modify all available fields except for experiment status, application, and experiment ID.
Cancel experiments
To cancel an experiment from the "Experiment Summary" page:
- Ensure that the experiment has one of the following statuses:
- LAUNCHED
- EXECUTING
- SCHEDULED
- Click
If the job is not already processing in the remote resource, the job's status will change to "COMPLETE"; upon completion, the experiment status will change to "CANCELED". Because you requested a cancellation, generated output will not be sent to the gateway.
If the job was successfully canceled upon changing the job state to "CANCELED", the experiment status will also change to CANCELED.
; the experiment's status will change to "CANCELING".
Clone experiments
You can clone an experiment irrespective of the experiment's status. To do so, from the "Experiment Summary" page, click
. The "Edit Experiment" page for the new experiment will appear. If desired, you can change the cloned experiment information before saving.Note the following:
- The new experiment's name will follow the pattern
Clone of + Old experiment name
. - The new experiment's information will match the information of the experiment it was cloned from.
- The new experiment will have a new experiment ID; the status will always be "CREATED".
User assistance
Report issues
To report Gateway issues, from the page navigation, select
, and then .Request features
To send feedback or request new applications, from the page navigation, select
, and then .Related documents
This is document aaop in the Knowledge Base.
Last modified on 2019-11-22 10:27:10.