Online Portals

Online Portals icon

We provide a number of web portals for our user community.

OSC OnDemand is a "one-stop-shop" for accessing OSC compute resources. You can submit and monitor jobs, manage files, open terminal sessions and even get a desktop. Full documentation is available.

MyOSC is our new management site. Current capabilities include allowing users to change their password, shell, and email address, as well as recover access to accounts in the event of a forgotten password.

Client Portal

The link to the client portal is https://my.osc.edu. Please log into it using your current OSC HPC username and password.

OSC client portal is a full replacement of OSC’s accounting and account management infrastructure (including my.osc.edu and app.osc.edu). It maintains the ability to change your password and contact information as well as submit grant proposals, but much is being added. A partial list includes:

  • Self-signup for accounts
  • PIs or their designates can manage user access to research projects
  • Ability to report funding and publications relevant to your use of OSC services
  • Ability to run custom reports on usage and annotate jobs
Service: 

Self-Signup for Accounts

Self-Signup for Accounts

Academic Account Signup:

1. The first step is to navigate to https://my.osc.edu on your internet browser.

Screenshot of the Client Portal displaying the above text

2. You will be greeted by the log in page for our client portal.

Screenshot of the Client Portal displaying the above text

3. Click on "Sign Up - Academic".

Screenshot of the Client Portal displaying the above text

4. The academic user registration page will be displayed. Please follow the instructions on the page and also fill it out as completely as possible.

Screenshot of the Client Portal displaying the above text

 

5. If your PI has invited you to their project or has given you an access code to the project. Please enter that information in the correct box. If the project code is provided, you will be added to the project after the Project Admin accepts your request. If both the project code and corresponding access code (which is created by Project Admin as a time-limited code) are provided, you will be added to the project immediately once the signup is completed successfully. 

Screenshot of the Client Portal displaying the above text

6. Once you have filled out all the information. You can hit the save button to submit the registration.

Screenshot of the Client Portal displaying the above text

7. Once the submission is processed the web page will display that you will receive an email from OSC with further instructions.

Screenshot of the Client Portal displaying the above text

8. Log into your email and find the email that was sent you from OSC. Click the link to verify your email.

Screenshot of the Client Portal displaying the above text

9. A web page will be displayed with the OSC terms of use. Please read them and click that "I Agree" if you agree to the terms of use for our systems.

Screenshot of the Client Portal displaying the above text

10. A webpage will be displayed to continue to the creation of your OSC Username and Password.

Screenshot of the Client Portal displaying the above text

11.  The username and password creation will be displayed. Please create your username and password according to the constraints listed on the page.

 The username and password creation will be displayed. Please create your username and password according to the constraints listed on the page.

12. Once you have successfully created your username and password you will be brought back to the login page. The login page will also have a pop up stating that your username and password have been successfully created. You will now be able to log in.

 The username and password creation will be displayed. Please create your username and password according to the constraints listed on the page.

Commercial Account Signup:

1. The first step is to navigate to https://my.osc.edu on your internet browser.

Screenshot of the Client Portal displaying the above text

2. You will be greeted by the log in page for our client portal.

Screenshot of the Client Portal displaying the above text

3. Click on "Sign Up - Commercial".

Screenshot of the Client Portal displaying the above text

4. The commercial user registration page will be displayed. Please follow the instructions on the page and also fill it out as completely as possible.

Screenshot of the Client Portal displaying the above text

5. If your PI has invited you to their project or has given you an access code to the project. Please enter that information in the correct box.  If the project code is provided, you will be added to the project after the Project Admin accepts your request. If both the project code and corresponding access code (which is created by Project Admin as a time-limited code) are provided, you will be added to the project immediately once the signup is completed successfully. 

Screenshot of the Client Portal displaying the above text

6. Once you have filled out all the information. You can hit the save button to submit the registration.

Screenshot of the Client Portal displaying the above text

7. Once the the submission is processed the web page will display that you will receive an email from OSC with further instructions.

Screenshot of the Client Portal displaying the above text

8. Log into your email and find the email that was sent you from OSC. Click the link to verify your email.

Screenshot of the Client Portal displaying the above text

9. A web page will be displayed with the OSC terms of use. Please read them and click that "I Agree" if you agree to the terms of use for our systems.

Screenshot of the Client Portal displaying the above text

10. A webpage will be displayed to continue to the creation of your OSC Username and Password.

Screenshot of the Client Portal displaying the above text

11.  The username and password creation will be displayed. Please create your username and password according to the constraints listed on the page.

Screenshot of the Client Portal displaying the above text

12. Once you have successfully created your username and password you will be brought back to the login page. The login page will also have a pop up stating that your username and password have been successfully created. You will now be able to log in.

Screenshot of the Client Portal displaying the above text

Supercomputer: 
Service: 

Dashboard

When you log into our Client Portal, you will see your Home screen (also known as your ‘Project Dashboard’), as shown below. From here, you can access the OnDemand/AweSim portals. Project usage for the last 30 days will be summarized in a few graphing formats. In addition, a table ‘Project Summaries’ will summarize the information shown above, with links for multiple projects and ‘Usage Details’.

OnDemand dashboard

Click on this button to take you to the login screen for our OnDemand portal. For more information on OSC OnDemand portal, see this page: https://www.osc.edu/resources/online_portals/ondemand

AweSim dashboard

Click on this button to take you to the login screen for our AweSim portal. For more information on AweSim, see this page: www.awesim.org

My reporting

Usage data is shown for the last 30 days; you can change the end date by editing the field directly and hitting enter on your keyboard or selecting the calendar option.

There is a table ‘Project Summaries’ at the bottom of the page summarizing all of the projects to which you have access. The table shows the Project ID, Status, Title, Principle Investigator, Usage in RUs, Project Balance in RUs, Available Project Storage in TBs, and a link ‘Usage Details’ for more details. When you click ‘Usage Details’, you are presented a report page for that project. You will see similar graphs from the main dashboard: RUs Consumed, Resources Used, Usage per System per Day. You will also see ‘Project Storage by Date’ (if any), and a table named ‘Current Home Directory Utilization’ that shows the home directory usage of all current users under this project. You can hover over graph segments for more specific details, where the date is what you have specified in the main dashboard. Click the ‘x’ button on the upper-right corner of this page to close the report.

Usage by Project graph

Usage information for the last 30 days from the date selected is presented in the upper-left-corner and summed into a pie chart. You can hover over the slices to see the project and amount of consumption; if you click on the slice, you will be presented to a table for RUs Consumed.

The ‘RUs Consumed’ table will be defaulted into the ‘Primary Report’. You can change to the ‘Pivot’ report. By default, you will be searching data from all projects in the pie chart, but this can be changed. The dates ascend, with dates in the left-hand column and usage in the right-hand column. Click the ‘x’ button on the upper-right corner of this page to close the report.

There are more details on how to do advanced reports discussed in ‘Interactive Reporting’ section, but here are some basics about interacting with the report. Clicking on a column header will bring up a quick filter menu where you can filter the records, sort by that column, hide the column, or group by each unique entry. In addition, you can do a quick text search, select which saved report you wish to view (if any), change the number of rows per page, and do advanced actions from changing the visible columns to aggregating data, creating charts, and saving your custom report formats.

Usage by Type and System graph

Usage information by type and system for the last 30 days from the date selected is presented in the upper-middle-corner and summed into a bar graph. You can hover over the bars to see the amount of consumption; if you click on the bar, you will be taken to a table for Resources Used.

By default, you will be searching data from all projects in the bar chart. Default columns are Date, System, Charge Type, and Charges for Period (RU); information is sorted by date, ascending. Click the ‘x’ button on the upper-right corner of this page to close the report.

There are more details on how to do advanced reports discussed in ‘Interactive Reporting’ section, but here are some basics about interacting with the report. Clicking on a column header will bring up a quick filter menu where you can filter the records, sort by that column, hide the column, or group by each unique entry. In addition, you can do a quick text search, select which saved report you wish to view (if any), change the number of rows per page, and do advanced actions from changing the visible columns to aggregating data, creating charts, and saving your custom report formats.

System Usage per Day graph

Usage information per day for the last 30 days from the date selected is presented in the upper-right-corner and summed into a line graph. You can hover over a vertex to see the amount of consumption for a certain date; if you click on vertex, you will be taken to a table for Usage per System per Day.

By default, you will be searching data from all dates in the line graph. Default columns are System and Charges for Period (RU); information is sorted into tables, ascending by date. Click the ‘x’ button on the upper-right corner of this page to close the report.

There are more details on how to do advanced reports discussed in ‘Interactive Reporting’ section, but here are some basics about interacting with the report. Clicking on a column header will bring up a quick filter menu where you can filter the records, sort by that column, hide the column, or group by each unique entry. In addition, you can do a quick text search, select which saved report you wish to view (if any), change the number of rows per page, and do advanced actions from changing the visible columns to aggregating data, creating charts, and saving your custom report formats.

Supercomputer: 
Service: 

Change or Reset Password

Change your password

You can follow the steps below to change your password after you log into our Client Portal.

  1. Click ‘Change Password’ from the dropdown menu of your name in the upper-right corner: ​1
  2. Enter your old and new passwords. Click the ‘Change password’ button. Please follow the password requirements!2
  3. A successful password change returns you back to the Home page as shown below. Click the ‘x’ to close the message. ​3

Reset an expired or forgotten password

From the Login page of our Client Portal, you can reset an expired or forgotten password. If you have forgotten your username please contact OSC Help.

  1. From the Login page, click the ‘Forgot your password?’ link.21
  2. Enter your username and click the ‘Submit’ button.22
  3. You will receive an email with a link to set a new password. The link can only be used once and is valid for a limited time.3
  4. Enter your new password following the password requirements. Click the ‘Submit’ button.4
  5. A successful password reset returns you to the Login page. Click the ‘x’ to close the message.5
  6. An expired or already used reset password link display this:You will need to return to the Login page and request a new link.6
Supercomputer: 
Service: 

Project Menu

When you log into our Client Portal, you will see ‘Project’ Menu, where you will see different options based on your user role. To check your user role, please refer to ‘Manage your profile’ section.

For any eligible principle investigator, you can

  • Apply for a new academic/commercial project
  • Do self-service project administration, such as managing user accounts under a project, viewing and renewing your projects, and viewing your allocations and usage
  • Generate reports of your projects and allocations

For any regular user without the role of principle investigator, you can

  • Generate reports of your projects and allocations
  • View your allocations

For any member of allocation review committee, you can

  • View the information with all pending projects

Apply for a new academic project

 
  1. Click ‘New Academic Project’ within the ‘Projects' dropdown menu to get the application page as shown below:

Screenshot of the Client Portal displaying the above text

  1. Provide ‘Project Title’ and ‘Abstract’. Choose the ‘Project type’, ‘Allocation type’, and ‘Field of Science’ from the available options. The definitions are:
    1. Project type:
      1. Academic Project: to be used for academic purposes. See this link for more information: https://www.osc.edu/supercomputing/support/account
      2. Campus Champion Project: a project that will be headed by the OSC Champion of the given university
      3. Classroom Project: to be used for the purposes of education. See this link for more information: https://www.osc.edu/resources/getting_started/classroom_project_resource_guide
    2. Allocation type: see this link for more information: https://www.osc.edu/supercomputing/support/application_help
      1. Startup: for Ohio academics to begin work with OSC.
      2. Standard: for researchers with moderate high-performance computing use.
      3. Major: for researchers with significant high-performance computing use.
      4. Discovery: for researchers with intensive high-performance computing use.

Screenshot of the Client Portal displaying the above text

Click ‘Save and Continue’ button on the upper-right corner of this page to continue.

 

  1. The following discussions are based on the application of an academic startup project. The required information will be slightly different if you apply for other types.

 

Provide ‘Requested RU’ by either using the sliding bar or providing the absolute value in the box. The definition of RU is here:

Screenshot of the Client Portal displaying the above text

Provide funding and publications by clicking ‘View Project Funding’ and ‘View Project Publications’. See ‘Manage your profile’ section on how to manage your funding and publications.

Screenshot of the Client Portal displaying the above text

Click ‘Save and Continue’ button on the upper-right-corner of this page to continue.

 

  1. Upload supporting files to provide the ‘RU Justification Document’ and ‘Additional Information’. You will see the name of files besides ‘Choose File’ button after the files are updated successfully:

Screenshot of the Client Portal displaying the above text

Click ‘Save and Continue’ button on the upper-right-corner of this page.

Screenshot of the Client Portal displaying the above text

  1. You will arrive at the page to review the summary of your application ‘New Project - Review Project’. If all the information is correct, click ‘Submit for Approval’ button on the upper-right-corner of this page to submit the application.

Screenshot of the Client Portal displaying the above text

  1. After your application is submitted successfully, you will be re-directed to the page to manage users under this project. See ‘Manage users under a project’ section for how to proceed with it. Click ‘close’ to close this page.

Screenshot of the Client Portal displaying the above text

  1. You will be re-directed to the page to view all of your projects, where your new application should be listed in the page with status of ‘Requested’. You can also apply for a new academic project by clicking ‘Create New Academic Project’ button on the upper-right-corner of this page following the steps discussed in step 1-6.

Screenshot of the Client Portal displaying the above text

  1. You are also able to view all of your projects including the new applications by clicking ‘View Projects’ within the ‘Projects’ dropdown menu.

Screenshot of the Client Portal displaying the above text

Apply for a new commercial Project

  1. Click ‘New Commercial Project’ within the ‘Projects' dropdown menu to get the application page. You get the application page as shown below:

Screenshot of the Client Portal displaying the above text

Provide ‘Project Title’ and ‘Description’. Also, you could provide ‘Estimated Core Hours (Millions)’, ‘Storage Space Quota (TB)’, and ‘File Count Quota (Thousands)’ by either using the sliding bar or providing the absolute value in the box:

  1. Default Estimated Core Hours: 1 million 
  2. Storage Space Quota (TB): project space allocated to this project. Default value: 0 TB
  3. File Count Quota (Thousands): file count quota associated with the storage space listed in #b). Default value: 0

 

Click ‘Save and Continue’ button on the upper-right-corner of this page to continue.

 

  1. You will arrive at the page to review the summary of your application ‘New Project - Review Project’. If all the information is correct, click ‘Submit’ button on the upper-right corner of this page to submit the application. Click ‘Back’ button if any information needs to be corrected.

Screenshot of the Client Portal displaying the above text

  1. After your application is submitted successfully, you will be re-directed to the page to manage users under this project. See ‘Manage users under a project’ section for how to proceed with it. Click ‘close’ to close this page.

Screenshot of the Client Portal displaying the above text

  1. You will be re-directed to the page to view all of your projects, where your new application should be listed in the page with status of ‘Requested’. You can also apply for a new commercial project by clicking ‘Create New Commercial Project’ button on the upper-right-corner of this page following the steps discussed in step 1-3.

Screenshot of the Client Portal displaying the above text

View Projects

Click ‘View Projects’ within the ‘Projects' dropdown menu to check the information of your projects. By default, this page lists all your projects with 15 rows per page. Click ‘>’ on the lower-right-corner of this page to go to the next page; click ‘<’ on the lower-right-corner of this page to go to the previous page. To modify the number of rows listed per page, adjust the value beside ‘Rows’ above the table.

 

To adjust which information to be displayed in this page, click ‘Columns’ within the ‘Actions' dropdown menu to get the ‘Select Columns’ pop-up window.

Screenshot of the Client Portal displaying the above text

In the pop-up window, select the information (which will be highlighted after being selected) to be displayed using ‘>’; select the information to be NOT displayed using ‘<’. You can also adjust the order of columns using ‘↑’ and ‘↓’. Click ‘Apply’ button to apply the changes.

Screenshot of the Client Portal displaying the above text

We will brief discuss how to use ‘search’ tool and view/edit a project here. For more interactive reporting functionalities, see ‘Interactive Reporting’ section.

 

How to Use 'Search' tool

The ‘Search’ tool enables you to narrow down the displayed projects that contains specific text only.

Screenshot of the Client Portal displaying the above text

To search all columns, simply type the text in the search box and click on ‘Go’ or press ‘Enter’:

Screenshot of the Client Portal displaying the above text

To search one specific column, select the column from the dropdown to the left of the search box before providing the text in the box:

Screenshot of the Client Portal displaying the above text

To apply multiple search criteria, add another search criterion after one search criterion is applied. Always remember to click ‘Go’ or press ‘Enter’ to apply the search criterion. Once search criterion/criteria are applied, the table of your projects following the search criterion/criteria will be displayed, and the search criterion/criteria will be listed above the table:

Screenshot of the Client Portal displaying the above text

  • Check the box on the left to display/not display the results following this search criterion. The displayed results will be refreshed automatically
  • Click the ‘x’ on the right to remove this search criterion. The displayed results will be refreshed automatically

Screenshot of the Client Portal displaying the above text

How to view/edit a project

You are able to view and edit your project, depending on the user roles of your account. To check your user role, please refer to ‘‘Manage your profile’ section.

 

To view/edit a project, click the ‘pencil icon’ to the left of the project:

Screenshot of the Client Portal displaying the above text

You will arrive at the page to review the details of this project ‘Project Details’:

Screenshot of the Client Portal displaying the above text

Different blue buttons, depending on your user roles, will be listed under ‘Project Details’. Click a blue button, and you will see either a pop-up window or a new page, which allows you to view or edit the information.

 

If you hold role as project PI, your will see the following available options:

Screenshot of the Client Portal displaying the above text

  • Project Users: manage users under this project. See ‘Manage users under a project’ section for more details.
  • Project Allocations: information on your project allocations.
  • Project Resource Usage: information on your RU usages.
  • Project User Usage: you will be redirected to ‘HPC Job Activity’ page to search the information of users’ jobs. See ‘‘HPC Job Activity’ tool’ section for more details.
  • Renew Project: you can renew this project by clicking ‘Renew Project’ button. See ‘How to renew a project’ for more details.

 

If you hold role as project user, your will see the following available options:

  • Project Allocations: information on your project allocations
  • Project Resource Usage: information on your RU usages.

How to renew a project

  1. You can renew a project by clicking on ‘View Projects’ within the ‘Project’ dropdown menu:

Screenshot of the Client Portal displaying the above text

  1. Select the project you would like to renew by clicking on the ‘pencil icon’ on the left hand side to open that project’s details page:

Screenshot of the Client Portal displaying the above text

  1. Click the button that is labeled ‘Renew Project’.

Screenshot of the Client Portal displaying the above text

  1. Select the allocation type you would like. (Ex: Standard, Major, or Discovery) and then click ‘Continue’.

Screenshot of the Client Portal displaying the above text

  1. Attach a proposal document to the application by clicking ‘Choose File’.

Screenshot of the Client Portal displaying the above text

  1. Add your abstract to the abstract section of the application.

Screenshot of the Client Portal displaying the above text

  1. Select the values you would like to request in the application for the renewal. (Ex: Estimated RU usage, Storage Space Quota, File Count Quota). Once you are ready to proceed to the next page, click ‘Save and Continue’.

Screenshot of the Client Portal displaying the above text

  1. Please add any additional documents. By clicking ‘Choose File’ in the RU justification document section and the addition information section. Once completed click ‘Save and Continue’.

Screenshot of the Client Portal displaying the above text

  1. You will see the new application by clicking on ‘Project’ -> ‘Project Allocations’ with the status of ‘REQUESTED’. See ‘View your allocations’ for more information on how to view your allocations.

Manage users under a project

As a project PI, you are able to do self-service project administration, such as adding or removing user accounts from a project, or changing user roles on the project.

  1. Click ‘View Projects’ within the ‘Projects' dropdown menu to get the information of your projects:

Screenshot of the Client Portal displaying the above text

  1. Click the ‘pencil icon’ to the left of the project under which you would like to manage user accounts:

Screenshot of the Client Portal displaying the above text

  1. You will arrive at the page to review the details of this project ‘Project Details’. Click the blue button ‘Project Users’ to get a pop-up window named ‘Manage Project Users’ to manage users under this project.

Screenshot of the Client Portal displaying the above text

The size of this pop-up window is fixed. There are three expandable lists in this window. Click ‘>’ on the left of each list to expand the list, and click ‘↓’ to collapse the list:

  • Project Users: it allows you to manage current users under this project (remove the user or change the user’s PI approval status), and add other existing OSC users to this project.
  • Invited Users: it allows you to add a user who does not own OSC account
  • User Roles on Project: it allows you to manage the user roles on this project.

How to remove a current user under this project

  1. Click ‘>’ on the left of ‘Project Users’ to expand this list.

Screenshot of the Client Portal displaying the above text

  1. You will get a table listing the current users under this project, as shown below. By default, this page lists all users with 10 rows per page. Click ‘>’ on the upper-right-corner of this page to go to the next page; click ‘<’ on the upper-right-corner of this page to go to the previous page. To modify the number of rows listed per page, adjust the value beside ‘Rows’. The page will be refreshed automatically:

Screenshot of the Client Portal displaying the above text

  1. To remove a user from this project, click the ‘pencil icon’ beside the user who needs to be removed to get a pop-up window:

Screenshot of the Client Portal displaying the above text

You will see the following information in the window:

  • User: in the format of ‘username – First Last at Institution
  • OSC Approved
  • PI Approved

 

  1. To remove this user, click ‘Remove’ button at the bottom of this window:

Screenshot of the Client Portal displaying the above text

  1. A pop-up appears asking for confirmation:

Screenshot of the Client Portal displaying the above text

Click ‘Cancel’ to cancel the removing action, or click ‘OK’ to confirm the removing action. Once you click ‘OK’, you will be re-directed to the table in which the removed user won’t be listed, with ‘Action Processed’ to confirm that this action has been processed:

Screenshot of the Client Portal displaying the above text

Click the ‘x’ to close the message ‘Action Processed’:

Screenshot of the Client Portal displaying the above text

How to change PI approval status of a user

  1. Click ‘>’ on the left of ‘Project Users’ to expand this list.

Screenshot of the Client Portal displaying the above text

  1. You will get a table listing the current users under this project, as shown below. By default, this page lists all users with 10 rows per page. Click ‘>’ on the upper-right-corner of this page to go to the next page; click ‘<’ on the upper-right-corner of this page to go to the previous page. To modify the number of rows listed per page, adjust the value besides ‘Rows’. The page will be refreshed automatically:

Screenshot of the Client Portal displaying the above text

  1. To change the PI approval status of this user, click the ‘pencil icon’ beside the user to get a pop-up window:

Screenshot of the Client Portal displaying the above text

You will see the following information in the window:

  • User: in the format of ‘username – First Last at Institution
  • OSC Approved
  • PI Approved

Screenshot of the Client Portal displaying the above text

  1. Check or uncheck the box beside ‘PI Approved’ to change the PI approval status. Click ‘save’ button, you will be re-directed to the table in which the user is listed with the changed status, with ‘Action Processed’ to confirm that this action has been processed.

 

  1. In addition, click ‘>’ beside ‘Audit’ to check the log of this account:

Screenshot of the Client Portal displaying the above text

  1. To close this pop-up window, click ‘Cancel’ at the bottom of this window or the ‘x’ on the upper-right-corner of this window

Screenshot of the Client Portal displaying the above text

How to add an existing OSC user to this Project

  1. Click ‘>’ on the left of ‘Project Users’ to get a table listing the current users under this project:

Screenshot of the Client Portal displaying the above text

  1. To add an existing OSC user to this project, click ‘Add User’ button on the upper-right-corner of this window:

Screenshot of the Client Portal displaying the above text

  1. A pop-up window will appear, as below:

Screenshot of the Client Portal displaying the above text

To search the user, click ‘blank box’ beside ‘User’. You can search the user by OSC username, or the person's first and last name (make sure to have a space between first and last name). The wildcard "%" is also supported. The returned result will be in the format of ‘username – First Last at Institution’. Select the user who you would like to add to this project. You can also provide approval status by checking the box beside ‘PI Approved’

Screenshot of the Client Portal displaying the above text

  1. Once all is correct, click ‘Save’ button at the bottom of this window to add this user. You will be re-directed to the table in which the newly added user will be listed, with ‘Action Processed’ to confirm that this action has been processed:

Screenshot of the Client Portal displaying the above text

The status of ‘OSC Approved’ for this newly added user will be ‘No’, which will be updated after OSC admin approves it.

 

  1. Click the ‘x’ to close the message ‘Action Processed’

Screenshot of the Client Portal displaying the above text

How to add a user who is new to OSC to this project

  1. You are also able to add a user who does not have OSC account to the project by inviting new users. Click ‘>’ on the left of ‘Invited Users’ to expand this list:

Screenshot of the Client Portal displaying the above text

  1. You will get a table listing the users who has been invited to this project. By default, this page lists all users with 10 rows per page. Click ‘>’ on the lower-right-corner of this page to go to the next page; click ‘<’ on the lower-right-corner of this page to go to the previous page. To modify the number of rows listed per page, adjust the value beside ‘Rows’. The page will be refreshed automatically:

Screenshot of the Client Portal displaying the above text

  1. To invite a new user, click ‘Invite New User’ button on the right above this table:

Screenshot of the Client Portal displaying the above text

  1. A pop-up window will appear, as below:

Screenshot of the Client Portal displaying the above text

All fields are required. We will check the information based on email address in our database to see whether the user is an existing OSC client or not. If this user is an existing OSC client, the message ‘This email already exists’ appears, as shown below:

 Screenshot of the Client Portal displaying the above text

In that case, you can close this window and follow the procedure ‘How to add an existing OSC user to this project’ to add this user.

 

Please select one of the user roles:

  • Project, Regular User:
  • Project, Limited Access: has limited access to the project information
  • Project, Admin Access: access to project management, usage reports, bills, receives emails, takes project actions
  • Project, No Admin Notifications: has no email notifications

 

  1. Click ‘Invite New User’ to send the invitation if all information is correct, or click ‘Cancel’ to cancel the invitation:

Screenshot of the Client Portal displaying the above text

  1. Once you click ‘‘Invite New User’, you will be re-directed to the table listing all users who has been invited by you, with ‘Action Processed’ to confirm that this action has been processed:

Screenshot of the Client Portal displaying the above text

Click the ‘x’ to close the message ‘Action Processed’:

Screenshot of the Client Portal displaying the above text

How to manage user roles on project

  1. By default, all users expect PI under this project hold the role of ‘Project, Regular User’. You can manage role of users under this project by clicking ‘>’ on the left of ‘User Roles on Project’ to expand this list:

Screenshot of the Client Portal displaying the above text

You will get a table listing the users who has special roles

  • Project, Limited Access: has limited access to the project information
  • Project, Admin Access: access to project management, usage reports, bills, receives emails, takes project actions
  • Project, No Admin Notifications: has no email notifications

 

By default, this page lists all users with 10 rows per page. Click ‘>’ on the lower-right-corner of this page to go to the next page; click ‘<’ on the lower-right-corner of this page to go to the previous page. To modify the number of rows listed per page, adjust the value beside ‘Rows’. The page will be refreshed automatically.

 

  1. To add a special user role, click ‘Add User’ button on the right above this table

Screenshot of the Client Portal displaying the above text

  1. A pop-up window will appear, as below:

Screenshot of the Client Portal displaying the above text

  1. All fields are required. To search the user, click ‘blank box’ beside ‘User’

Screenshot of the Client Portal displaying the above text

You can search the user by OSC username, or the person's first and last name (make sure to have a space between first and last name). The wildcard "%" is also supported. The returned result will be in the format of ‘username – First Last at Institution’. Select the user who you would like to add special user role to this project and specify the role:

  • Project, Limited Access
  • Project, Admin Access
  • Project, No Admin Notifications

 

  1. Click ‘Add User’ to add the new user role, or click ‘Cancel’ to cancel the invitation.

Screenshot of the Client Portal displaying the above text

  1. Once you click ‘‘Add User’, you will be re-directed to the table listing all users who has been added to special user role, with ‘Action Processed’ to confirm that this action has been processed:

Screenshot of the Client Portal displaying the above text

View your allocations

  1. Click ‘Project Allocations’ within the ‘Projects' dropdown menu to list all the allocations:

Screenshot of the Client Portal displaying the above text

By default, this page lists all your allocations with 10 rows per page. Click ‘>’ on the lower-right-corner of this page to go to the next page; click ‘<’ on the lower-right-corner of this page to go to the previous page. To modify the number of rows listed per page, adjust the value beside ‘Rows’.

 

  1. To adjust which information to be displayed in this page, click ‘Columns’ within the ‘Actions' dropdown menu to get the pop-up window as below:

Screenshot of the Client Portal displaying the above text

Select the information to be displayed using ‘>’; select the information to be NOT displayed using ‘<’. You can also adjust the order of columns using ‘↑’ and ‘↓’. Click ‘Apply’ button to apply the changes.

Screenshot of the Client Portal displaying the above text

How to use 'Search' tool

The ‘Search’ tool enables you to narrow down the displayed projects that contains specific text only.

 

  1. To search all columns, simply type the text in the search box and click on ‘Go’ or press ‘Enter’:

Screenshot of the Client Portal displaying the above text

  1. To search one specific column, select the column from the dropdown to the left of the search box before providing the text in the box:

Screenshot of the Client Portal displaying the above text

 

Screenshot of the Client Portal displaying the above text

  1. To apply multiple search criteria, add another search criterion after one search criterion is applied. Always remember to hit ‘Enter’ to apply the search criterion. Once search criterion/criteria are applied, the table of your projects following the search criterion/criteria will be displayed, and the search criterion/criteria will be listed above the table
  • Check the box on the left to display/not display the results following this search criterion. The displayed results will be refreshed automatically
  • Click the ‘x’ on the right to remove this search criterion. The displayed results will be refreshed automatically

 

  1. There are more details on how to do advanced reports discussed in Interactive Reporting’ section.

 

How to renew a project

You can renew a project by clicking ‘Renew Project’ button. See the ‘How to renew a project’ for more information.

 

Current projects

  1. Click ‘Current project’ within the Projects' dropdown menu to all of current active projects:

Screenshot of the Client Portal displaying the above text

  1. The ‘Current Active Projects’ page is shown below. By default, this page lists all of current OSC active allocations with 100 rows per page. Click ‘>’ on the upper-right-corner of this page to go to the next page; click ‘<’ on the upper-right-corner of this page to go to the previous page. To modify the number of rows listed per page, adjust the value beside ‘Rows’.

Screenshot of the Client Portal displaying the above text

How to use 'Search' tool

The ‘Search’ tool enables you to narrow down the displayed projects that contains specific text only.

 

  1. To search all columns, simply type the text in the search box and click on ‘Go’ or press ‘Enter’. To search one specific column, select the column from the dropdown to the left of the search box before providing the text in the box. To apply multiple search criteria, add another search criterion after one search criterion is applied. Always remember to hit ‘Enter’ to apply the search criterion.

 

  1. Once search criterion/criteria are applied, the table of your projects following the search criterion/criteria will be displayed, and the search criterion/criteria will be listed above the table:
  • Check the box on the left to display/not display the results following this search criterion. The displayed results will be refreshed automatically
  • Click the ‘x’ on the right to remove this search criterion. The displayed results will be refreshed automatically

 

  1. Click the PI name to redirect to PI’s web site (if available). Click the title to links to see more information of the project.

Screenshot of the Client Portal displaying the above text

  1. Click ‘Return to Portal’ to go back to your homepage:

Screenshot of the Client Portal displaying the above text

  1. There are more details on how to do advanced reports discussed in Interactive Reporting’ section.

 

 

Supercomputer: 
Service: 

Individual Menu

Manage your profile

On the Profile page you can maintain your contact information and CV. Principal Investigators can maintain publications and funding awards for use with project allocations.

  1. Click ‘Edit Profile’ from the dropdown menu of your name:

Screenshot of the Client Portal displaying the above text

  1. This brings up the ‘Contact Profile’ page:

Screenshot of the Client Portal displaying the above text

  1. It is very important that your email address is kept up-to-date. You can change the email address here in client portal. If changing email address, please note that the new email address won't be updated in the OSC system instantaneously. User will receive a verification email to their new email address. Only after verification process is complete, new email address will be updated in the OSC system.

 

  1. If you need to change Institutions, please contact OSC Help so we can update that information.
    Email oschelp@osc.edu
    Phone 614-292-1800 or 800-686-6472
     
  2. The ‘Web Page’ is optional and will be shown with the Principal Investigator of all active Projects.
     
  3. The Projects button will bring up a page listing all the projects you are associated with.
     
  4. The Publications button will bring up a page on which you can manage bibliographic information about publications you may wish to reference in account requests or renewals.

Screenshot of the Client Portal displaying the above text

  1. The Funding button will bring up a page on which you can record funding from other sources you may wish to reference in account requests or renewals. 

 

 

'HPC Job Activity' tool

Interactive reporting of HPC job activity

The HPC Job Activity menu item opens a powerful reporting tool. By default, the report shows all activity over the last 30 days for projects you are authorized to view usage of. There are simple filters available at the top to put in a specific job ID, narrow the report to a specific project, or select a specific date range.

Screenshot of the Client Portal displaying the above text

Click ‘Refresh Report’ to get the job activity report as shown below:

Screenshot of the Client Portal displaying the above text

There are more details on how to do advanced reports discussed in Interactive Reporting’ section, but here are some basics about interacting with the report. Clicking on a column header will bring up a quick filter menu where you can filter the records, sort by that column, hide the column, or group by each unique entry.

 

In addition, you can do a quick text search, select which saved report you wish to view (if you have any saved reports), change the number of rows per page, and do advanced actions from changing the visible columns to aggregating data, creating charts, and saving your custom report formats.

 

View job scripts

To view the script associated with a job, you can click on the ‘Job ID’ for that job. This will open a pop-up dialog with the first 5kb of the job script, with a button to enable you to download the entire script.

Screenshot of the Client Portal displaying the above text

Importantly, you will notice that the script is not identical to what you submitted on the command line; this is because our infrastructure scripts will add some additional information of value to the scheduler and record that information in the final job script.

 

If a job is interactive, the job script will not be recorded because there isn’t one! We do not have a mechanism to record what happens in an interactive batch job and store that in the accounting system. You may want to use descriptive job names in your batch submissions if you want to be able to review utilization and determine what a job was for when no script is recorded.

 

Creating a job note

There is a column available in the report that provides a per-row button labeled “View/Add Note”. This button will open a dialog window that will allow you to view any notes that have been added to a job or create a note. At 200 characters, notes are fairly short, but they do allow you to add a little bit of metadata to a job once it is in the accounting system.

Screenshot of the Client Portal displaying the above text

There are three “create” buttons available, which take slightly different actions. Clicking “Create” will just save the note in the job record. Clicking “Create & Notify OSC Admin” will allow you to save the note and notify OSC staff that there is a job note they should review. Please note, this is not the recommended or preferred method for reporting job problems. Please continue to email OSC Help. Finally, “Create & Send to project admin” will add the note to the job record and notify the PI and project admins that there is a job note that needs to be reviewed.

 

 

Supercomputer: 
Service: 

Interactive Reporting

In client portal, we provide interactive reporting region with Oracle Application Express (APEX) that allows end users to query data and customize reports. According to ORACLE, this interactive reporting region allows users to

  • Customize the layout of the data by choosing the columns they are interested in, applying filters, highlighting, and sorting
  • Define breaks, aggregations, different charts, and their own computations
  • Create multiple variations of the report and save them as named reports, output to comma-delimited files, and print them to PDF documents

 

The interactive reporting region are available on different pages in client portal, such as “Individual -> HPC Job Activity”. In this documentation, we will discuss how to query data and customize reports on the HPC Job Activity screen. The discussions here are also applicable to other pages.

The HPC Job Activity page

Click ‘HPC Job Activity’ within the ‘Individual' dropdown menu.

Screenshot of the Client Portal displaying the above text

Click ‘Refresh Report’ to get the job activity report as shown below. By default, the report shows a table of all activity over the last 30 days for projects you are authorized to view usage of, with 10 rows per page. Click ‘>’ at the top right of the table to go to the next page; click ‘<’ at the top right of the table to go to the previous page. To modify the number of rows listed per page, adjust the value beside ‘Rows’:

Screenshot of the Client Portal displaying the above text

There are simple filters available at the top to put in a specific job ID, narrow the report to a specific project, or select a specific date range. Click “Refresh Report” to update the table with new filters.

Screenshot of the Client Portal displaying the above text

For more advanced functions of using filter, see the discussion of ‘Filter’.

Column sorting and filtering

Many actions can be performed by clicking on a column heading. These include:

  • Sorting data (both ascending and descending)
  • Hiding the column
  • Creating a control break
  • Viewing of the column text and the ability to select a value to create a quick filter

 

Let’s use the column ‘CPU Time Used’ as an example for detailed discussions. Click ‘CPU Time Used’:

Screenshot of the Client Portal displaying the above text

  • Click ‘Screenshot of the Client Portal displaying the above text’, and the jobs will be listed based on the value of CPU time in ascending order
  • Click ‘Screenshot of the Client Portal displaying the above text’, and the jobs will be listed based on the value of CPU time in descending order
  • Click ‘Screenshot of the Client Portal displaying the above text’, and the column ‘CPU Time Used’ will be removed from the table
  • Click ‘Screenshot of the Client Portal displaying the above text’, and the table will be split into multiple groups, where each group shares the same value of CPU time

 

It also lists all the available values of CPU time. You can select a value to create a quick filter, and the table will be updated to list the jobs of which the CPU time is the specified value:

Screenshot of the Client Portal displaying the above text

You can also use ‘search’ to narrow down the information to be viewed.

Adjust the displayed information in the table

You can adjust the columns to be displayed in this table to see more/less information. Click ‘Columns’ within the ‘Actions' dropdown menu:

Screenshot of the Client Portal displaying the above text

You will get the pop-up window shown below. The columns on the right are displayed. The columns on the left are hidden. Select the information to be displayed using ‘>’; select the information to be NOT displayed using ‘<’. You can also reorder the displayed columns using ‘↑’ and ‘↓’. Click ‘Apply’ button to apply the changes.

Screenshot of the Client Portal displaying the above text

Most columns are self-explanatory. Computed columns are prefixed with **. Definitions of some columns are provided below:

  • Project: which project this job is charged to
  • Usage Date: the date when this job is charged
  • Memory Used: in bytes
  • CPU Time Used: in seconds
  • Wall Time Used: in seconds

'Search' tool

The ‘Search’ tool enables you to narrow down the displayed report that contains specific text only. To search all columns, simply type the text in the search box and click on ‘Go’ or press ‘Enter’.

Screenshot of the Client Portal displaying the above text

The page will be refreshed automatically to display the results following the search criterion, with the search criterion being listed above the table:

Screenshot of the Client Portal displaying the above text

To apply multiple search criteria, add another search criterion after one search criterion is applied. Always remember to hit ‘Enter’ to apply the search criterion:

Screenshot of the Client Portal displaying the above text

Check the box on the left to display/not display the results following this search criterion. The displayed results will be refreshed automatically:

Screenshot of the Client Portal displaying the above text

Click the ‘x’ on the right to remove this search criterion. The displayed results will be refreshed automatically:

Screenshot of the Client Portal displaying the above text

To search one specific column, select the column from the dropdown ‘˅’ to the left of the search box before providing the text in the box:

Screenshot of the Client Portal displaying the above text

For instance, if you would like to get a report of HPC jobs submitted by user ‘ucn1118’ only, select ‘Username’ from ‘˅’. ‘Search: Username’ will be displayed in the ‘search’ box:

Screenshot of the Client Portal displaying the above text

Type ‘ucn1118’ and hit ‘Enter’ in the box, jobs submitted by ‘ucn1118’ only will be displayed in the table, as shown below:

Screenshot of the Client Portal displaying the above text

'Actions' menu

The ‘Actions’ menu contains many tasks that are useful in querying data and customizing reports. Click ‘˅’ to get a list of available functions.

Screenshot of the Client Portal displaying the above text

For more information, see: [1] and [2]

Adjust the displayed information in the table

Click ‘Columns’ within the ‘Actions' dropdown menu, you can adjust the columns to be displayed in this table to see more/less information.

Screenshot of the Client Portal displaying the above text

See here for more info: ‘Adjust the displayed information in the table’.

Query data and format report

Within the ‘Actions' dropdown menu, it provides the following tools to query data and format report:

  • Filter
  • Data
  • Format

Screenshot of the Client Portal displaying the above text

Filter

Click ‘Filter’ within the ‘Actions' dropdown menu as below:

Screenshot of the Client Portal displaying the above text

You can create the filter based on either ‘Column’ or ‘Row’.

If you filter by column, select a column using ‘▼’, a standard Oracle operator using ‘▼’, and enter an expression to compare against. Expressions are case sensitive. Use % as a wild card, if needed. You can also select the expression using ‘▼’.

Screenshot of the Client Portal displaying the above text

If you filter by ‘Row’, you can create complex WHERE clauses using column aliases and any Oracle functions or operators. Click ‘Apply’ to apply the filter:

Screenshot of the Client Portal displaying the above text

Screenshot of the Client Portal displaying the above text

Data

Click ‘Data’ within the ‘Actions' dropdown menu. You can sort data, perform mathematical computation on column, add computed column to your report, and perform a flashback query within ‘Data’ menu. 

Screenshot of the Client Portal displaying the above text

  • Sort

It is used to change the columns to sort on and determines whether to sort in ascending or descending order. You can also specify how to handle NULLs. The resulting sorting displays to the right of column headings in the report.

Screenshot of the Client Portal displaying the above text

  • Aggregate

Aggregates are mathematical computations performed against one column. Click ‘Aggregate’ to get the pop-up window shown below:

Screenshot of the Client Portal displaying the above text

Here, ‘Aggregation’ enables you to select a previously defined aggregation to edit; ‘Function’ is the function to be performed (for example, SUM, MIN); ‘Column’ is used to select the column to apply the mathematical function to. Only numeric columns display.

 

Click the ‘Apply’ button, the aggregates will be displayed at the end of the report within the column they are defined.

Screenshot of the Client Portal displaying the above text

  • Compute

It enables you to add computed columns to your report. These can be mathematical computations or standard Oracle functions applied to existing columns. Click ‘Compute’ to get the pop-up window shown below:

Screenshot of the Client Portal displaying the above text

Here, ‘Computation’ enables you to select a previously defined computation to edit; ‘Column Heading’ is the name of this new column displayed in the table; ‘Format Mask’ is an Oracle format mask to be applied against the column; ‘Computation Expression’ is the computation to be performed where columns are referenced using their associated alias. Clicking on the column name or alias includes them in the Computation. Next to Columns is a keypad. This keypad functions as a shortcut to commonly used keys and inserts those keys in the Computation. On the far right are Functions.

 

Once the computation is defined, click ‘Apply’ button. The computed column will be displayed as the last column of the table.

Screenshot of the Client Portal displaying the above text

  • Flashback

A flashback query enables you to view the data as it existed at a previous point in time. The maximum amount of time that you can flashback is 7047 minutes.

Screenshot of the Client Portal displaying the above text

Format

Click ‘Format’ within the ‘Actions' dropdown menu:

Screenshot of the Client Portal displaying the above text

Using ‘Format’ menu, you can split the report into multiple groups, highlight the rows that meet the filter, and modify the number of rows listed per page.

  • Control Break

It is used to create a break group on one or several columns. Click ‘Control Break’ to get the pop-up window shown below:

Screenshot of the Client Portal displaying the above text

Enable or disable the column for control break. Click ‘Apply’ button. This pulls the columns out of the Interactive Report and displays them as a master record.

Screenshot of the Client Portal displaying the above text

  • Highlight

It allows you to define a filter. The rows that meet the filter are highlighted using the characteristics associated with the filter. You can highlight the entire row or just the affected cell and can select a new color both for the background and the text. Click ‘Highlight’ to get the pop-up window as below:

Screenshot of the Client Portal displaying the above text

Here, the options include:

  • Name: provide a name for this ‘highlight’. Once it is defined, it will be displayed on the top of the table with returned results
  • Sequence: identifies the sequence in which the rules are evaluated.
  • Enabled: identifies if a rule is enabled or disabled.
  • Highlight Type: identifies whether the row or cell should be highlighted. If Cell is selected, the column referenced in the Highlight Condition is highlighted.
  • Background Color: is the new color for the background of the highlighted area.
  • Text Color: is the new color for the text in the highlighted area.
  • Highlight Condition defines the filter condition.

 

Click the ‘Apply’ button. This pulls the columns out of the Interactive Report and displays the results with defined highlights.

 

  • Rows Per Page

You can select the value to modify the number of rows listed per page.

Screenshot of the Client Portal displaying the above text

Data visualization

Different tools are available in client portal for the data visualization, including:

  • Chart
  • Group By
  • Pivot

Screenshot of the Client Portal displaying the above text

Chart

Click ‘Chart’ to get the pop-up window as below:

Screenshot of the Client Portal displaying the above text

Here, the options include:

  • Chart Type: identifies the chart type to include. Select from horizontal bar, vertical bar, pie, or line.
  • Label: enables you to select the column to be used as the label.
  • Axis Title for Label: is the title that displays on the axis associated with the column selected for Label. This is not available for pie chart.
  • Value: enables you to select the column to be used as the value. If your function is a COUNT, a Value does not need to be selected.
  • Axis Title for Value: is the title that displays on the axis associated with the column selected for Value. This is not available for pie chart.
  • Function: is an optional function to be performed on the column selected for Value.
  • Sort: allows you to sort your result set.

 

Click the ‘Apply’ button. You will get the page in which the chart is generated. You can include one chart per Interactive Report. Once defined, you can switch between the chart and report views using the icons beside ‘Go’:

Screenshot of the Client Portal displaying the above text

Group By

Click ‘Group By’ to get the pop-up window as below:

Screenshot of the Client Portal displaying the above text

Here, the options include:

  • Add Group By Column: the columns on which to group
  • Add Function: the columns to aggregate along with the function to be performed

 

Click the ‘Apply’ button. You will get the page in which the Group By view is generated. You can include one Group By view per Interactive Report. Once defined, you can switch between the Group By and report views using the icons beside ‘Go’:

Screenshot of the Client Portal displaying the above text

Pivot

Click ‘Pivot’ to get the pop-up window as below:

Screenshot of the Client Portal displaying the above text

Here, the options include:

  • Add Pivot Column: the columns on which to pivot
  • Add Row Column: the columns to display as rows
  • Add Function: the columns to aggregate along with the function to be performed

 

Click the ‘Apply’ button. You will get the page in which the Pivot view is generated. Please note that Pivot does not work for very large datasets e.g. ~5000 entries. You can include one Pivot view per Interactive Report. Once defined, you can switch between the Pivot and report views using the icons beside ‘Go’:

Save/Reset report

Within ‘Report’ menu, you can save the customized report for future use, or remove any customizations that you have made and reset the report to the default settings.

Screenshot of the Client Portal displaying the above text

Save Report

‘Save Report’ saves the customized report for future use (it will be there after logging out and back in again). Click Save Report’ to get the pop-up window shown below:

Screenshot of the Client Portal displaying the above text

You provide a name and an optional description. For now, all customized reports are private, which means only the end user that created the report can view, save, rename or delete the report. If you save customized reports, a Reports selector displays in the Search bar:

Screenshot of the Client Portal displaying the above text

You will be able to choose the reports between ‘Default -> Primary Report’ (which is the report that initially displays) and ‘Private -> Your defined reports’

Screenshot of the Client Portal displaying the above text

Reset

‘Reset’ brings the report back to the settings when logged in, removing any customizations that you have made. Click ‘Reset’ to get the pop-up window as below:

Screenshot of the Client Portal displaying the above text

Click the ‘Apply’ to confirm. You can also uncheck the checkbox next to any customization to temporarily disable it or click the ‘x’ icon to remove the customization.

Screenshot of the Client Portal displaying the above text

Download

‘Download’ enables the current result set to be downloaded. Click ‘Download’ to get the pop-up window:

Screenshot of the Client Portal displaying the above text

The download formats differ depending upon your installation and report definition but may include CSV, HTML, PDF, or Email. Click the icon of the format you wish to download in.

Help

‘Help’ provides you more detailed user guide on ‘Action’ menu.

Screenshot of the Client Portal displaying the above text

Example: create a chart report of daily HPC jobs by a user

In this example, I’d like to provide step-by-step instructions for creating a chart report of HPC jobs, in which:

  • All jobs submitted by user ‘xwang’
  • The data range is from April 29, 2018 to May 7, 2018
  • The report shows the total CPU time per day

 

The following functions will be demonstrated:

  • Use simple filter on ‘HPC Job Activity’ page
  • Use ‘search’ tool
  • Adjust rows to be displayed per page
  • Adjust columns to be displayed in the table
  • Format the data using ‘Control Break’
  • Generate a chart report
  • Save report
  • Download report

 

  1. Click ‘Individual -> HPC Job Activity’

Screenshot of the Client Portal displaying the above text

  1. You will get the ‘HPC Job Activity’ page. Change ‘Minimum Date’ and ‘Maximum Date’ to ‘29-Apr-18’ and ’07-May-18’, respectively. Click “Refresh Report’ to updated the information displayed in the table

Screenshot of the Client Portal displaying the above text

  1. To listed the jobs submitted by user ‘xwang’ only, click ‘Search’ box and choose ‘Username’:

Screenshot of the Client Portal displaying the above text

  1. Type ‘xwang’ in the ‘search’ box and press ‘Enter’.

Screenshot of the Client Portal displaying the above text

  1. You will get the table that lists all jobs submitted by user ‘xwang’ between April 29, 2018 and May 7, 2018, with the filter listed above the table. Change the number of rows displayed per page to ‘All’ to list all jobs, as shown below:

Screenshot of the Client Portal displaying the above text

  1. Since we are interested in the daily CPU usage by ‘xwang’, we can remove some columns of the table by clicking the heading of some columns to hide the column. For instance, click ‘Hide Column’ icon in ‘Job ID’, the page will be refreshed automatically. The column ‘Job ID’ will NOT be displayed after refreshing:

Screenshot of the Client Portal displaying the above text

  1. Perform similar operations on other columns. You can also adjust the columns to be displayed by clicking ‘Columns’ within the ‘Actions' dropdown and make ‘Username’, ‘Usage Date’, and ‘CPU Time Used’ to be displayed in the report. The final table is as below:

Screenshot of the Client Portal displaying the above text

  1. To create a break group based on ‘Usage Date’, click ‘Actions -> Format -> Control Break’ as shown below:

Screenshot of the Client Portal displaying the above text

  1. You will get the ‘Control Break’ pop-up window. Choose ‘Usage Date’ under ‘Column’ with Status ‘Enabled’, as shown below:

Screenshot of the Client Portal displaying the above text

  1. Click ‘Apply’. This pulls the column ‘Usage Date’ out of the report and the jobs submitted by ‘xwang’ are grouped based on ‘Usage Date’, as shown below:

Screenshot of the Client Portal displaying the above text

  1. To generate a chart report that shows the total CPU time per day, click ‘Actions -> Chart’ as shown below:

Screenshot of the Client Portal displaying the above text

  1. You will get the ‘Chart’ pop-up window. Using the following information on the chart options, as shown in the image below:
  • Chart Type: vertical bar
  • Label: Usage Date
  • Axis Title for Label: Date
  • Value: CPU Time Used
  • Axis Title for Value: Total CPU Time
  • Function: Sum
  • Sort: Default

Screenshot of the Client Portal displaying the above text

  1. Click the ‘Apply’ button. You will get the chart report showing the daily total CPU usage by ‘xwang’ between April 29, 2018 and May 7, 2018 (here, the CPU usage is zero if the date is missing in this chart):

Screenshot of the Client Portal displaying the above text

  1. From this chart, it is easy to see that ‘xwang’ used many CPU hours on May 4th, and very few CPU hours on other days. To switch back to report view, you can click the icon ‘View Report’ to the left of the row selection:

Screenshot of the Client Portal displaying the above text

  1. You can save this report for future use by clicking ‘Actions -> Report -> Save Report’ as shown below:

Screenshot of the Client Portal displaying the above text

  1. You will get the ‘Save Report’ pop-up window. Provide ‘xwang Daily Usage’ as the name and ‘Daily CPU Usage between April 29 and May 07’ as Description, as below:

Screenshot of the Client Portal displaying the above text

  1. Click ‘Apply’ button to save the report. Now, beside ‘Go’, you will be able to choose the reports between ‘Default -> Primary Report’ (which is the report that initially displays) and ‘Private -> xwang Daily Usage’, as shown below:

Screenshot of the Client Portal displaying the above text

  1. For now, all customized reports are private, which means only the end user that created the report can view, save, rename or delete the report.

 

  1. You can download this report by clicking ‘Actions -> Download’ as shown below:

Screenshot of the Client Portal displaying the above text

  1. You will get the ‘Download’ pop-up window as below:

Screenshot of the Client Portal displaying the above text

  1. Click the icon of CSV, HTML, or PDF to download this report, or click the icon of Email to email this report to the desired recipient. Please note the downloaded report is in the format of table only, while other formats like ‘Chart’ won’t be available for downloading.

 

 

Supercomputer: 
Service: 

OnDemand

OnDemand is our "one stop shop" for access to our High Performance Computing resources. With OnDemand, you can upload and download files, create, edit, submit, and monitor jobs, run GUI applications, and connect via SSH, all via a web broswer, with no client software to install and configure.

We've created a brief video explaining OnDemand's capabilities so users can better gauge if it is the right fit for them.  Getting connected to OnDemand is also explained in this video.  We've also created tutorial videos for OnDemand's Job client and file management client.

 

 

System Requirements

Currently, the site is confirmed to work with newer versions of Chrome (22+), Firefox (16+), and Internet Explorer (11+). We are still working to expand availability to additional clients, and are planning on including compatibility for mobile devices (phones and tablets) in the future. 

Connecting

To connect to OnDemand, visit https://ondemand.osc.edu. The first page of OnDemand site displays instructions on how to login to OSC OnDemand which are shown in the image below:

How to Login to OSC OnDemand

Click the button labeled "Login via CILogon" at the bottom to continue to step 1 shown below:

  • Step 1 requires you choose an identity provider to login with. This can be any institute you're affiliated with or even services like Google.
    If you check 'Remember this selection' you will need to delete cookies from the cilogon domain to make a new choice. You can do this through your browser's settings or at https://cilogon.org/me
  • Step 2 has you log in using your credentials for the provider you picked.
  • Step 3 has you log in with your OSC credentials in order to link your identity provider to your OSC account.

NOTE:  These three steps are only needed the first time you login to OSC OnDemand. 

Once completed you will be presented with this page:

Default OnDemand FrontPage

Or this page if your browser window is more compact:

OnDemand Compact Front Page

The three lined icon to the right of the compact page expands when clicked to show the full toolbar that the non-compact page has. At this point, you can begin accessing the tools in OnDemand.

File Transfer

Move data on and off of OSC storage services. To use the file transfer client, select "Files" in the main menu. For more information, please visit the file transfer and management page.

Job Management

Create, edit, submit, and monitor jobs. To access the job management tools, use the "Jobs" menu. For more information about the tools please visit the job management page.

Job Management Menu

Shell Access

OnDemand provides the ability SSH to Oakley or Ruby (if your account has access to) from inside your web browser. To get to a terminal, select the "Clusters" menu and choose either Oakley or Ruby.

Shell Access

Please note that this action will open a "pop-up" window. If your browser is configured to block pop-ups, you will not see the terminal. 

Configuring Pop-up Settings

If your brower is configured to block pop-ups, use the following guide to allow all pop-ups from OnDemand.  You will first need to attempt to open a shell to bring up the following windows.  If you have previously configured the pop-up settings for OnDemand you may need to open your settings page to make the appropriate settings.

Internet Explorer

To configure Internet Explorer to always allow popups from OnDemand, select "Always allow" under the "Options for this site" menu at the bottom of the screen.

Chrome

To configure Chrome to always allow popups from OnDemand, click the "Pop-up blocked" icon to the right of the address bar.  Select "Always allow pop-ups from ondemand.osc.edu" and click Done.

Firefox

To configure Firefox to always allow popups from OnDemand, select the Options button at the top of the screen and click "Allow pop-ups for ondemand.osc.edu."

Safari

To configure Safari to allow popups, go to Safari -> Preferences -> Security and uncheck "Block pop-up windows."

System Status

This page shows the current status of entire system (nodes in use, cores in use, and number of running, queued, and blocked jobs). 

System Status

If you click the image, you'll get detailed report including the total system load, the CPU usage, the total cluster memory use, and the total network traffic on the cluster. The "CPU Report" showing less than 100% use means that there are some cores not currently being used by job, but that doesn't necessarily mean that they are available to be scheduled; there may be a system reservation that is preventing the scheduler from utilizing all of those cores.

Get a Virtual Desktop

Request a desktop to run GUI applications, without the hassle or performance problems associated with X11 forwarding. To access one, please select either "Interactive HPC" or "Virtual Desktop Interface" from the "Desktops" menu.

Virtual Desktop Interface

Select one VDI app you will arrive on the page shown below. Please modify the resolution information if needed and click "Launch". You may need to wait for a few minutes for the interface to launch.

 

Here, it also provides you the access to Files ("Acess Files") and Shell (">_Launch Shell"), and allows you to go back to OnDemand main page ("Go to Dashboard").

Image of OnDemand Page requesting access to Oakley VDI

Once the interface is ready to be used, your session manager will have a job which looks like the image below:

Image of OnDemand page showing the a successfully created VDI session

To access the interface, you can choose from "noVNC Instructions", or "Native Client Instructions". If you use "noVNC", you can choose from "Launch noVNC in New Tab" to get your desktop shown below and work accordingly, or "View Only (Share-able Link)" to get your desktop or share your desktop with colleagues in "View Only" mode. If you use "Native Client Instructions", see this page for more information on how to use OSC Connect.  

Oakley Desktop

 

The Virtual Desktop Interfaces should not be used for computationally or memory intensive processes because it is a shared resource and there are other users on the same node. Such processes will be terminated. Please peform such work on compute node as discussed below.

Interactive HPC

Request a desktop on compute node through the batch system, without the hassle or performance problems associated with X11 forwarding. To access one, please select "Oakley Desktop" or others under "Interactive" from the "Desktops" menu.  

If you choose "Oakley Desktop", you will arrive on the page shown below. Please enter the information as desired and click "Launch". You may need to wait for a few minutes for the interface to launch. If you'd like to recieve an email notifiying you of when the interface has launched, please select "I would like to recieve an email when the session starts".

Image of OnDemand Page showing a request to get an Interactive HPC Desktop session

Once the interface is ready to be used, your session manager will have a job which looks like the image below:

Image of OnDemand Page showing a successfully created interactive HPC Desktop session

Similarly, you can choose from "noVNC Instructions", or "Native Client Instructions" to get the interface. If you use "noVNC", you can choose from "Launch noVNC in New Tab" to get your desktop and work accordingly, or "View Only (Share-able Link)" to get your desktop or share your desktop with colleagues in "View Only" mode. If you use "Native Client Instructions", see this page for more information on how to use OSC Connect. 

Here, you can run computationally or memory intensive processes since you do not share the node(s) with other clients

Access Application on Compute Node

Request an applcation on compute node through the batch system, without the hassle or performance problems associated with X11 forwarding. To access one, please select any app from the "Desktop Apps" menu. See "Desktop App Catalog" for more information. 

App Developers

If you'd like to develop your own app through OnDemand, see this link for detailed instructions. 

Supercomputer: 
Service: 

Desktop App Catalog

OSC OnDemand provides access to applications on compute nodes through the batch system, without the hassle or performance problems associated with X11 forwarding. To access one, please select an application under "Interactive HPC" from the "Desktop Apps" menu. For more information on each product, please go to its page provided below.

Supercomputer: 
Service: 

OnDemand Desktop App: MATLAB

MATLAB allows matrix manipulations, plotting of functions and data, implementation of algorithms, creation of user interfaces, and interfacing with programs written in other languages, including C, C++, C#, Java, Fortran and Python.

Accessing through OnDemand

All the desktop apps can be found within the 'Interactive Apps' dropdown in our OnDemand web portal as shown in the image below:

access

 

After selecting MATLAB, you will arrive at this page:

interface

Here you can select the resources you would like your MATLAB session to have using the menu on the righthand side of the page. Additionally you can adjust the window size of the MATLAB session using the same menu. After you click "Launch", a new session will be queued. Once the session is active you page will look like the image below:

matlab

You can choose from "noVNC Connection", or "Native Instructions" to get the interface. If you use "noVNC", you can choose from "Launch noVNC in New Tab" to get your desktop and work accordingly, or "View Only (Share-able Link)" to get your desktop or share your desktop with colleagues in "View Only" mode. If you use "Native Instructions", see this page for more information on how to use OSC Connect.

Using MATLAB

Once you have entered your session, you should see a new tab. Allow MATLAB a moment to start up before your screen eventually looks like the image below:

workspace

This is a typical MATLAB interface that should be familiar to most users.

The desktop includes these panels:

  •     Current Folder — Access your files.
  •     Command Window — Enter commands at the command line, indicated by the prompt (>>).
  •     Workspace — Explore data that you create or import from files.

More info on Matlab and its use can be found here

Further Reading

MathWorks support page

 

Supercomputer: 
Service: 

OnDemand Desktop App: RStudio Server

RStudio is an integrated development environment (IDE) for R. It includes a console, syntax-highlighting editor that supports direct code execution, as well as tools for plotting, history, debugging and workspace management.

Accessing through OnDemand

All the desktop apps can be found within the 'Desktop Apps' dropdown in our OnDemand web portal as shown in the image below:

Image of OnDemand Desktop Apps Dropdown

After selecting RStudio Server, you will arrive at this page:

Image of how to setup RStudio

Here you can select the resources you would like your RStudio session to have using the menu on the lefthand side of the page. You can also access your files or launch the shell using the options in the center. After you click "Launch", a new session will be queued. Once the session is active you page will look like the image below:

Image of launchable RStudio Session

Click on "Connect to RStudio Server" to begin using RStudio.

Using RStudio

Once you have entered your session, you should see the RStudio page below:

Image of an active RStudio session

This is a typical RStudio interface that should be familiar to most users.

  • Left panel: The console where you can type commands and see the output.
  • Top right panel:
    • Environment tab: Shows all the active objects
    • History tab: Shows a list of commands used so far.
  • Bottom right panel:
    • Files tab: Shows all the files and and folders in your home directory
    • Plots tab: Shows all your graphs
    • Packages tab: Lists a series of packages or add-ons needed to run certain processes
    • Help tab: Can be used to find additional info
    • Viewer tab: Used to view local web content

More info on RStudio and its use can be found on the RStudio official support page.

 

Supercomputer: 
Service: 

File Transfer and Management

OnDemand provides a web-based File Explorer that can be used to upload and download files to your OSC home directory or project directory, and copy, delete, rename, and edit files.

Here is a tutorial video that gives a overview of OnDemand's file management client's capabilities and how to utilize them.

Here you can see a screen shot of what the main interface looks like.

File Main Page

 

Navigating

Selecting which File System

File Navigation

By default, the file browser will be looking at your home directory. If you have access to a project space for GPFS directory, you can switch to those by backtracking through the path near the top of the window and selecting the file system you wish to browse. In addition, you can use the "Go To" option in the top menu to type the path you wish to navigate to. Both the directory path and "Go To" button are highlighted in red in the image above.

Switching Folders

On the left side of the screen is a tree view of the directory structure. You can navigate this tree the same way you might on a normal desktop GUI to select the folder you wish to use.

Uploading and Downloading Files

File Upload

There are several methods to upload files. The first is to simply navigate to the desired destination, and then drag the file from your local desktop or window navigator to the OnDemand window. You can also click the "Upload" button to open a dialog that will allow you to navigate your local computer and select which files you want to upload. This process is highlighted in the image above.

To download files, you must select the file or files you wish to download, and then use the "Download" button. If you select multiple files ("control+click" or "shift+click") or a folder, the server will zip the files up and download a single zip archive to your desktop machine.

File Operations

Most file operations can be accomplished by selecting the file in the main window pane and selecting the desired operation from the main menu.

File Operations

Viewing and/or Editing a File

The application also includes several built-in file editors. To access these editors and viewers, select the file you wish to view or edit, and select "Edit" from the main menu. This will open up a text editor in a new tab.

 

Supercomputer: 
Service: 

Job Management

OnDemand provides two related job managment tools: one allows you to create and submit jobs via your web browser, and the other allows you to monitor queued and running jobs.

Here is a tutorial video that gives an overview of OnDemand's Job client's capabilities and how to utilize them.

Jobs Menu

My Jobs

Selecting "My Jobs" in the Jobs menu will open an application that allows you to create new jobs and submit them to the cluster, and inspect the results of jobs submitted via this tool.

myjobs

New Job

Please following the steps in order to create a job:

  1. Create a new job by copying from an existing job template directory (by clicking "+New Job" button under "Listing Jobs") or a previously run job directory (by clicking "+Copy Job" button under "Listing Jobs").
    • If you click the "+New Job" button, you will see the page as below. Select the job template to copy, then click "Create New Job". The template directory will be copied and a new job row will be added to the top of the jobs table on the page titled "Listing Jobs"new job
  2. Select the job, then modify and/or add any files to this job by clicking "Edit Files" editfile
  3. Select the job and click "Job Options" to change the cluster, job name, or job script, if necessary editjob
  4. At this point, you can submit the job using the green "submit" button from the "My Jobs" page; or return to this job later to modify it further. You can also monitor the job status here. Currently you must reload the page to see job status changes.

Job Management

On the main screen for "My Jobs" you can click on a job to examine it.

Submit Job

If the job has not been submitted, the "submit job" button will be active, and will submit the selected job to the queue.

Stop Job

The "stop" button will allow you to kill a running job.

Delete Job

The "delete" button will allow you to delete a job

Active Jobs

The "Active Jobs" application will show you all of jobs currently in the queue (running or queued), regardless of how the jobs were submitted. You can click the button on top to switch from:

  • All jobs from your OSC account
  • All jobs from your project/group
  • All jobs from OSC users

You can also use "Search" tool to filter jobs based on sytems (oakley or ruby), status (running, queued, or hold), OSC user accout, etc.

activejobs

Job Inspection

If you click the arrow to the left of each job you can get more information about this job. It also provides the information of each node on which this job is running on, over the duration of the entire job. Clicking on each image expands it to show more information.

job status

Supercomputer: 
Service: