====== How Do I Manage My HPC Project? ======

Anyone who is a member of an HPC Project may access the HPC Project Management page for that project from their [[https://hpc.researchcomputing.ncl.ac.uk/projects/|My HPC Projects]] area.

After you select one of your projects from the list that you either **own**, **manage** or are a **member** of, you will see the __summary__ page for the project:

{{:started:manage:manage_project.png?850|}}

The summary page gives you an overview of the state of your project, indicates if it is active (live, enabled, allows login to HPC and job submission), inactive (temporarily disabled) or archived (permanently disabled), and lists any errors or warnings that need to be resolved.

Other functionality is accessed under the tabs arranged across the page:

   * Project Details
   * Project Membership
   * Resource Utilisation
   * Finance & Invoices
   * Miscellaneous

----
===== What Project Roles Exist? =====

What you can //do// in the project management page will //vary// upon your //role// in the project:

**Primary project owner**

   * Can log in to the HPC (if has a HPC Driving Test)
   * Can submit Slurm jobs against the project account code
   * Edit project description/title/software
   * Archive project
   * Assign secondary project owner
   * Assign project managers
   * Assign project members
   * View resource utilisation reports
   * View project balance reports
   * Send project invites / reminder emails

**Secondary project owner**

   * Can log in to the HPC (if has a HPC Driving Test)
   * Can submit Slurm jobs against the project account code
   * Edit project description/title/software
   * Archive project
   * Assign project managers
   * Assign project members
   * View resource utilisation reports
   * View project balance reports
   * Send project invites / reminder emails

**Project Manager**

   * Can log in to the HPC (if has a HPC Driving Test)
   * Can submit Slurm jobs against the project account code
   * Assign project members
   * View resource utilisation reports
   * View project balance reports
   * Send project invites / reminder emails
 
 **Project Member**

   * Can log in to the HPC (if has a HPC Driving Test)
   * Can submit Slurm jobs against the project account code
   * View resource utilisation reports
   * View project balance reports

----

===== Changing Project Details ======

==== Descriptions ====

==== Funding State ====

==== Archiving Your Project ====

----

===== Managing Project Members =====

Under the **Project Members** tab you have the following options:

   * Viewing (or exporting) the current project members list
   * Adding new members
   * Removing current members
   * Changing member roles
   * Sending email invites & reminders
==== View Members ====

The main members list is __sortable__ by clicking on a column name, can be __filtered__ by typing partial name or username in the **Search:** box, and can be __exported__ to a text CSV file using the **CSV** button.

{{:started:manage:manage_project_members.png?800|}}

==== Add Members ====

Project owners and managers can add further members to a project using the **Add New User** search box and the **New User Rights** drop-down list as shown below. 

The **Add New User** box will filter the results automatically based while you are typing a partial name (e.g. surname) or the username of a person. If multiple results are found they can be selected using the **Select a user..** drop-down list:

{{:started:manage:manage_project_members_add.png?800|}}

You can search for all users who have a __valid Newcastle University IT account__. Once you have found the matching person, select the role you want that person to have from the **New User Rights** drop-down list. Then click the **Add User** button to save.
==== Remove Members ====

To remove a member of the project team, **Project Owners** and **Project Managers** can browse the list of users and click the **Remove User?** checkbox next to a user. Pressing the **Save** button will then remove that person from the project.

{{:started:manage:manage_project_members_remove.png?800|}}

Note:

   * **Primary Project Owners** can remove __any__ other members
   * **Secondary Project Owners** can remove **Project Managers** and **Members**
   * **Project Managers** can __only__ remove **Members**
==== Managing Member Roles ====

You can alter the role a project member has by selecting the role you want them to have from the **New Role** drop-down on their row and then pressing the **Save** button: 

{{:started:manage:manage_project_members_roles.png?800|}}

Note:

   * **Primary Project Owners** can grant __up to one__ **Secondary Project Owner** role and __any number__ of **Project Manager** and **Member** roles
   * **Secondary Project Owners** can grant __any number__ of **Project Manager** and **Member** roles
   * **Project Managers** can __only__ grant **Member** roles
==== Sending Notifications ====

If you have a large number of users in your project team and want to notify them that they have been added to your HPC Project, **or** that a number of them //still// require to take and pass the HPC Driving Test, then you can use the notification options at the bottom of the **Project Members** page:

{{:started:manage:manage_project_members_invites.png?800|}}

Note:

   * **Primary Project Owners**, **Secondary Project Owners** and **Project Managers** can all send invites and reminders
   * Normal **Members** are __unable__ to access the functionality
   * Sending to **Pending** members will send //"You need to take the HPC Driving Test in order to access..."// emails all members of the team who __do not__ yet have an HPC Driving License
   * Sending to **Confirmed** members will send //"You have been added to..."// emails to all members of the team who __do__ have an HPC Driving License

----


===== Viewing Balance & Invoice Information =====

==== Paying Invoices ====

==== Adjusting Project Balance ====

----

===== Compute Resource Reports =====

==== Yearly ====

==== Monthly ====

==== Job Partitions ====

==== Team Member Jobs ====

----

===== Errors & Warnings =====

   * **Errors** - problems which will cause your project to become inactive. **//You must fix errors otherwise your project will be automatically flagged as inactive//**. You must be a member of at least one active project to __log in__ to the HPC, and you may only submit jobs against __active__ HPC project account codes.
   * **Warnings** - problems which will __not__ cause your project to become inactive, but which you may need to investigate (for example - none of your projects members having an HPC Driving License!).
==== Errors ====

Errors are usually either data quality issues with the registration of your project, **or** outstanding finance issues. When you access your HPC Project management page for a particular project you __may__ see these. For example:

{{:started:manage:manage_project_errors.png?850|}}

In the example above a project is shown which has a description field which is considered **too short**.

If you have a **finance issue** with your project then this is likely due to exhaustion of an available balance **or** unpaid internal recharge invoices. If the project balance is exhausted then the project and its members will have access to paid resource partitions revoked unless an additional credit or higher funding balance is agreed. Please contact the Research Software Engineering team if this is the case.
==== Warnings ====

----

[[:started:index|Back to getting started]]