From 4022f8328f24ec033dc1e43674f9a4d0cc58dfcf Mon Sep 17 00:00:00 2001 From: Mateo Langston Smith Date: Mon, 5 Aug 2024 12:28:48 -0500 Subject: [PATCH 01/15] broken image links fixed using config flag --- docs/_config.yml | 8 ++++++++ docs/coldfront/add_remove_users.md | 33 +++++++----------------------- 2 files changed, 15 insertions(+), 26 deletions(-) diff --git a/docs/_config.yml b/docs/_config.yml index 50976efa..2b7fa09c 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -5,3 +5,11 @@ execute: execute_notebooks: "off" html: favicon: "./images/favicon.ico" +parse: + myst_enable_extensions: + - colon_fence + - dollarmath + - linkify + - substitution + - tasklist + - html_image diff --git a/docs/coldfront/add_remove_users.md b/docs/coldfront/add_remove_users.md index c33329d9..498ed043 100644 --- a/docs/coldfront/add_remove_users.md +++ b/docs/coldfront/add_remove_users.md @@ -17,12 +17,7 @@ Instructors and PI's are automatically assigned the ***Manager*** role within a ### To a Project/Class -1. Once a project or class is created, under Manage Project, click on - - ```{image} ../images/CF/add_remove_users/add_users.png - :alt: add users - :height: 35px - ``` +1. Once a project or class is created, under Manage Project, click on add users 3. Type in usernames of the user(s) you would like to add separated by a space or on separate lines. @@ -36,21 +31,16 @@ Instructors and PI's are automatically assigned the ***Manager*** role within a :height: 150px ``` -4. Click on +4. Click on search button - ```{image} ../images/CF/add_remove_users/search_button.png - :alt: search button - :weight: 700px - ``` - - ```{note} + ````{note} If a user has already been added to the project or class, then you will see a message like this ```{image} ../images/CF/add_remove_users/user_already_added.png :alt: user already added message :height: 35px :align: center ``` - ``` + ```` 5. Select the user(s) that you want to add from the list @@ -66,12 +56,7 @@ Instructors and PI's are automatically assigned the ***Manager*** role within a :height: 60px ``` -6. Click on - - ```{image} ../images/CF/add_remove_users/add_selected_users.png - :alt: add selected users - :height: 35px - ``` +6. Click on add selected users 7. You can verify that a user has been added under Users on the Project/Class page. @@ -91,9 +76,7 @@ When [requesting an allocation](https://southernmethodistuniversity.github.io/hp select users -3. Click on - - remove selected users. +3. Click on remove selected users. 4. You can verify that a user has been removed under users header on the Project/Class page. @@ -109,8 +92,6 @@ When [requesting an allocation](https://southernmethodistuniversity.github.io/hp change user role -3. Click on - - update user +3. Click on update user ### Allocation Permissions \ No newline at end of file From ba651d3577006fbf17b120b2442f9d885b22e6e1 Mon Sep 17 00:00:00 2001 From: Mateo Langston Smith Date: Mon, 5 Aug 2024 14:30:29 -0500 Subject: [PATCH 02/15] mostly finished request allocation docs, except changing an alloc --- docs/coldfront/request_change_allocation.md | 56 ++++++++++++++++++--- 1 file changed, 50 insertions(+), 6 deletions(-) diff --git a/docs/coldfront/request_change_allocation.md b/docs/coldfront/request_change_allocation.md index 6b868436..6d7cee00 100644 --- a/docs/coldfront/request_change_allocation.md +++ b/docs/coldfront/request_change_allocation.md @@ -39,23 +39,27 @@ There are 3 fields to specify when requesting a ***Compute*** allocation: ***CPU 5. Enter the number of ***CPU hours*** you will need. - ```{note} + ```{admonition} General Guidelines + :class: tip When requesting ***CPU hours***, you MUST request ***memory hours*** as well. The general guideline is that you need 4 ***memory hours*** for 1 ***CPU hour***. If you need assistance in determining how many hours to request, please contact [oitresearch@smu.edu](mailto:oitresearch@smu.edu). ``` 6. Enter the number of ***GPU hours*** you will need. - ```{note} + ```{admonition} General Guidelines + :class: tip When requesting ***GPU hours***, you MUST request both ***CPU hours*** and ***memory hours*** as well. The general guideline is that you need 16 ***CPU hours*** and 96 ***memory hours*** per 1 ***GPU hour***. If you need assistance in determining how many hours to request, please contact [oitresearch@smu.edu](mailto:oitresearch@smu.edu). ``` 6. Enter the number of ***memory hours*** you will need. -7. Please read and acknowledge that you will follow the ODSRCI Community Guidelines. +7. If you have users on your project, select which users should have access to the allocation. -8. Click on Submit. +8. Please read and acknowledge that you will follow the ODSRCI Community Guidelines. -9. Wait for your allocation to be approved by HPC Support. +9. Click on Submit. + +10. Wait for your allocation to be approved by HPC Support. ### Change ***Compute*** Allocation @@ -63,6 +67,46 @@ Coming Soon. ## ***Storage*** Allocations +A ***Storage*** allocation is a shared directory with a quota on gigabytes (GB) of storage, and number of files. Every HPC user will still have a `$HOME` directory and a `$SCRATCH` directory that does not count towards the quota. Please see the [Purge Policy](https://southernmethodistuniversity.github.io/hpc_docs/policies/policies.html#purge-policy) for details. + ### Request ***Storage*** Allocation -### Change ***Storage*** Allocation \ No newline at end of file +1. Select ***+ Request Resource Allocation***. + +2. Select ***Storage*** as your Resource from the dropwdown. + +3. Provide what you would like to name the shared folder. If a name is not provided, a generic name will be assigned. + +4. Provide a 2-3 sentence justification for the resources you are requesting. + +5. Select a Start Date and End Date for your allocation. The limit is 1 year, but can be renewed. + +6. Enter the amount of storage you would like in GB. + + ```{note} + This amount is a storage quota, which means you are capped at the provided GB, but are not guarunteed to get that much. + ``` + +7. Enter the number of files you expect to create or use in this allocation. + + ```{admonition} General Guidelines + :class: tip + - A conda environment needs about 100,000 files. + - A safe bet for most people is 500,000 files for a storage allocation. + ``` + +8. If you have users on your project, select which users should have access to the shared folder and whether they should have ***Read and Write*** access or ***Read Only*** access. + + ```{note} + ***Read Only*** means that they will only be able to see file contents, but not change them or create new files in the shared directory. ***Read and Write*** gives them full editing permissions. + ``` + +9. Please read and acknowledge that you will follow the ODSRCI Community Guidelines. + +10. Click on Submit. + +11. Wait for your allocation to be approved by HPC Support. + +### Change ***Storage*** Allocation + +Coming Soon. \ No newline at end of file From bc2760a8dce5c33a8b8a10ef0c3e722e980a4e99 Mon Sep 17 00:00:00 2001 From: Mateo Langston Smith Date: Mon, 5 Aug 2024 14:36:31 -0500 Subject: [PATCH 03/15] adjust images on add change projetc page --- docs/coldfront/add_change_project.md | 25 +++++-------------------- 1 file changed, 5 insertions(+), 20 deletions(-) diff --git a/docs/coldfront/add_change_project.md b/docs/coldfront/add_change_project.md index 16708506..1002de24 100644 --- a/docs/coldfront/add_change_project.md +++ b/docs/coldfront/add_change_project.md @@ -45,10 +45,10 @@ Only benefits eligible faculty or staff can create a project. :width: 800px ``` -6. Select all relevant Fields of Science. +6. Select all relevant Fields of Study. ```{image} - :alt: fields of science + :alt: fields of study :width: 800px ``` @@ -68,27 +68,12 @@ Only benefits eligible faculty or staff can create a project. 9. Please read and acknowledge that you will follow the ODSRCI Community Guidelines. -10. Click Save to create the project. - - ```{image} ../images/CF/add_change_project/save.png - :alt: save - :height: 40px - ``` +10. Click Save to create the project. ## Change a Project -1. From the project page, click on - - ```{image} ../images/CF/add_change_project/update_project.png - :alt: update project information - :height: 40px - ``` +1. From the project page, click on update project information. 2. Change any relevant information for Title, Description, Field of Science, and Departments. -3. Click on - - ```{image} ../images/CF/add_change_project/save.png - :alt: save - :height: 40px - ``` \ No newline at end of file +3. Click on save. \ No newline at end of file From fcc8518c5d49240d3b7ee0b367666bf5f95aa2d3 Mon Sep 17 00:00:00 2001 From: Mateo Langston Smith Date: Mon, 5 Aug 2024 15:32:40 -0500 Subject: [PATCH 04/15] update email links to help desk --- docs/coldfront/request_change_allocation.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/coldfront/request_change_allocation.md b/docs/coldfront/request_change_allocation.md index 6d7cee00..23a6bc20 100644 --- a/docs/coldfront/request_change_allocation.md +++ b/docs/coldfront/request_change_allocation.md @@ -24,7 +24,7 @@ There are 3 fields to specify when requesting a ***Compute*** allocation: ***CPU | ***Memory hours*** | Computed per job as (amount allocated memory in GB) * (run time in hours). For example, if a job was allocated 128GB of memory and ran for 45 minutes, it used (128) * (0.75) = 96 ***Memory hours***. | ```{note} -***CPU hour***, ***GPU hour***, and ***memory hour*** quota's will persist across all M3 queues and SuperPod queues. For example, if you use up your quota of ***GPU hours*** entirely on the gpu-dev queue on M3, then you will not have ***GPU hours*** left to use on M3 or the SuperPod. If you need assistance in determining how many hours to request, please contact [oitresearch@smu.edu](mailto:oitresearch@smu.edu). +***CPU hour***, ***GPU hour***, and ***memory hour*** quota's will persist across all M3 queues and SuperPod queues. For example, if you use up your quota of ***GPU hours*** entirely on the gpu-dev queue on M3, then you will not have ***GPU hours*** left to use on M3 or the SuperPod. If you need assistance in determining how many hours to request, please submit a help desk ticket to [help@smu.edu](mailto:help@smu.edu) with [HPC] in the subject line. ``` ### Request ***Compute*** Allocation @@ -41,14 +41,14 @@ There are 3 fields to specify when requesting a ***Compute*** allocation: ***CPU ```{admonition} General Guidelines :class: tip - When requesting ***CPU hours***, you MUST request ***memory hours*** as well. The general guideline is that you need 4 ***memory hours*** for 1 ***CPU hour***. If you need assistance in determining how many hours to request, please contact [oitresearch@smu.edu](mailto:oitresearch@smu.edu). + When requesting ***CPU hours***, you MUST request ***memory hours*** as well. The general guideline is that you need 4 ***memory hours*** for 1 ***CPU hour***. If you need assistance in determining how many hours to request, please submit a help desk ticket to [help@smu.edu](mailto:help@smu.edu) with [HPC] in the subject line. ``` 6. Enter the number of ***GPU hours*** you will need. ```{admonition} General Guidelines :class: tip - When requesting ***GPU hours***, you MUST request both ***CPU hours*** and ***memory hours*** as well. The general guideline is that you need 16 ***CPU hours*** and 96 ***memory hours*** per 1 ***GPU hour***. If you need assistance in determining how many hours to request, please contact [oitresearch@smu.edu](mailto:oitresearch@smu.edu). + When requesting ***GPU hours***, you MUST request both ***CPU hours*** and ***memory hours*** as well. The general guideline is that you need 16 ***CPU hours*** and 96 ***memory hours*** per 1 ***GPU hour***. If you need assistance in determining how many hours to request, please submit a help desk ticket to [help@smu.edu](mailto:help@smu.edu) with [HPC] in the subject line. ``` 6. Enter the number of ***memory hours*** you will need. From b77bc6bf29d145a0ace86e1c77ac3699c3e391ed Mon Sep 17 00:00:00 2001 From: Eric Godat Date: Mon, 5 Aug 2024 16:44:54 -0500 Subject: [PATCH 05/15] Create qs_instructor.md Quick Start for instructors --- docs/coldfront/qs_instructor.md | 130 ++++++++++++++++++++++++++++++++ 1 file changed, 130 insertions(+) create mode 100644 docs/coldfront/qs_instructor.md diff --git a/docs/coldfront/qs_instructor.md b/docs/coldfront/qs_instructor.md new file mode 100644 index 00000000..3bbc9108 --- /dev/null +++ b/docs/coldfront/qs_instructor.md @@ -0,0 +1,130 @@ +# Getting Started in ColdFront as an Instructor + +These instructions will help you get access to HPC resources for your class. +If you are the instructor of record in my.smu, much of this process will be easy and automated for you. +If you are not an instructor of record for a course but would like to set up a course (e.g. workshop or bootcamp), +please reach out to [help@smu.edu](mailto:help%40smu.edu?subject=%5BHPC%5D) and include [HPC] in the subject line. + +## Setting up your class + + ```{image} ../images/CF/quick_start/add_class.png + :alt: add a class button + :width: 400px + ``` + +1. Login to ColdFront via SSO with your SMU ID and Password +2. Select Add a class +3. Select your course from the drop down menu +4. Select which sections you would like to have access to HPC resources +5. Mark which additional options you need +6. Select Save once complete. + +Once a class is created you will have options to Add additional users and request additional allocations. + +## To add Students and Other Users + +For classes, the management of students is synched hourly with class enrollment records starting a week before the semester starts. +Once in the , students that add or drop will be added or removed from your class and allocations accordingly. + + ```{note} + All students will appear 7 days before the semester begins. + ``` + +If you wish to add a user who is not enrolled to your class (e.g. a co-instructor), follow the steps below. + + ```{note} + This is not especially common. Do not add students that will be enrolled in the course as this could disrupt their file permissions. + ``` + +1. Once your class is created, select Add Users within the Users section of your class + + ```{image} ../images/CF/quick_start/add_users.png + :alt: add users + :width: 400px + ``` + +3. If you are searching by “Exact Username Only” search for the user via SMU email alias + + ```{note} + If you are adding multiple users, you can list them all in the Search String box + ``` + +4. If you are searching by “All Fields” you can enter last name or SMU email alias + +5. Once you’ve found and selected the user(s), select the role the user should have + + ```{image} ../images/CF/quick_start/user_role.png + :alt: user role + :width: 100px + ``` + +6. Then Add Selected Users to Project +7. Once complete you will see all users requested under the Users section + +## In Class + +Once you are ready for your students to use the resources, have them go to [hpcaccess.smu.edu](hpcaccess.smu.edu) and log in to ColdFront. +They will see your class and associated allocations on their dashboard. They will see a button for **Pending EULA** next to each allocation. +They will need to accept the EULA for each allocation in order to get access the those resources. + + ```{note} + Once a student is in a course and accepts the EULA, they will be granted an HPC account. + In most cases this process is instantenous, however if you have a large number of files in a storage allocation for a class, this could take several minutes. + ``` +If you are using the Open OnDemand portal [hpc.smu.edu](hpc.smu.edu) for your course, students will be able to click on the link in the top menu bar to go directly to the M3 Portal. + +If you are using `srun` commands or `sbatch` scripts, your students will need to add the following to their commands/scripts in order to utilize the resources. + +`#SBATCH -A slurm_account_name` + +or + +`srun -A slurm_account_name …` + +The `slurm_account` can be found in the Information field under Allocations. + + ```{image} ../images/CF/quick_start/resource_table.png + :alt: resource table + :width: 800px + ``` + +## To Request Additional Resource Allocations + +All classes are granted a default compute allocation consisting of ***Core Usage (Hours)*** and ***Memory Usage (Hours)***. +Depending on the options chosen at the creation of the project, this may contain ***Accelerator Usage (Hours)*** or a second allocation for Storage. +The Storage allocation is Read-Only for students by default. + +If you find your class needing additional resources, you can request additional allocations for either Compute or Storage, by following the instructions below. + + ```{image} ../images/CF/quick_start/request_resource_allocation.png + :alt: request resource allocation + :width: 200px + ``` + +1. Next to Allocations, Select the **+Request Resource Allocation button** +2. Complete all required fields +3. Select the users you’d like to add to this allocation +4. Select Submit +5. Once complete you will see your status request as **Pending Review** under Allocations + + +## To view your current usage + +1. Under Allocations select the folder icon +2. You will see your Allocation details, EULA Agreements, and Usage by Hours + + +## Concluding the Semester + +At the end of the semester, your class will be Archived. +Once you class is successfully archived, you will not be able to make any changes but will still be able to view some details at any time + +## To view Archive Projects + +1. After logging into ColdFront, select Projects> Projects +2. Top right of your page, you will see View Archived Projects + + ```{image} ../images/CF/quick_start/view_archived.png + :alt: view archived + :width: 200px + ``` From 0affed6885d40c279519055a0c0106a83b0db0af Mon Sep 17 00:00:00 2001 From: Mateo Langston Smith Date: Mon, 5 Aug 2024 17:06:24 -0500 Subject: [PATCH 06/15] fix indentation on qs_instructor.md --- docs/coldfront/qs_instructor.md | 55 +++++++++++++++++---------------- 1 file changed, 28 insertions(+), 27 deletions(-) diff --git a/docs/coldfront/qs_instructor.md b/docs/coldfront/qs_instructor.md index 3bbc9108..66cf44bb 100644 --- a/docs/coldfront/qs_instructor.md +++ b/docs/coldfront/qs_instructor.md @@ -7,10 +7,10 @@ please reach out to [help@smu.edu](mailto:help%40smu.edu?subject=%5BHPC%5D) and ## Setting up your class - ```{image} ../images/CF/quick_start/add_class.png - :alt: add a class button - :width: 400px - ``` +```{image} ../images/CF/quick_start/add_class.png +:alt: add a class button +:width: 400px +``` 1. Login to ColdFront via SSO with your SMU ID and Password 2. Select Add a class @@ -26,15 +26,15 @@ Once a class is created you will have options to Add additional users and reques For classes, the management of students is synched hourly with class enrollment records starting a week before the semester starts. Once in the , students that add or drop will be added or removed from your class and allocations accordingly. - ```{note} - All students will appear 7 days before the semester begins. - ``` +```{note} +All students will appear 7 days before the semester begins. +``` If you wish to add a user who is not enrolled to your class (e.g. a co-instructor), follow the steps below. - ```{note} - This is not especially common. Do not add students that will be enrolled in the course as this could disrupt their file permissions. - ``` +```{note} +This is not especially common. Do not add students that will be enrolled in the course as this could disrupt their file permissions. +``` 1. Once your class is created, select Add Users within the Users section of your class @@ -43,23 +43,23 @@ If you wish to add a user who is not enrolled to your class (e.g. a co-instructo :width: 400px ``` -3. If you are searching by “Exact Username Only” search for the user via SMU email alias +2. If you are searching by “Exact Username Only” search for the user via SMU email alias ```{note} If you are adding multiple users, you can list them all in the Search String box ``` -4. If you are searching by “All Fields” you can enter last name or SMU email alias +3. If you are searching by “All Fields” you can enter last name or SMU email alias -5. Once you’ve found and selected the user(s), select the role the user should have +4. Once you’ve found and selected the user(s), select the role the user should have ```{image} ../images/CF/quick_start/user_role.png :alt: user role :width: 100px ``` -6. Then Add Selected Users to Project -7. Once complete you will see all users requested under the Users section +5. Then Add Selected Users to Project +6. Once complete you will see all users requested under the Users section ## In Class @@ -67,10 +67,11 @@ Once you are ready for your students to use the resources, have them go to [hpca They will see your class and associated allocations on their dashboard. They will see a button for **Pending EULA** next to each allocation. They will need to accept the EULA for each allocation in order to get access the those resources. - ```{note} - Once a student is in a course and accepts the EULA, they will be granted an HPC account. - In most cases this process is instantenous, however if you have a large number of files in a storage allocation for a class, this could take several minutes. - ``` +```{note} +Once a student is in a course and accepts the EULA, they will be granted an HPC account. +In most cases this process is instantenous, however if you have a large number of files in a storage allocation for a class, this could take several minutes. +``` + If you are using the Open OnDemand portal [hpc.smu.edu](hpc.smu.edu) for your course, students will be able to click on the link in the top menu bar to go directly to the M3 Portal. If you are using `srun` commands or `sbatch` scripts, your students will need to add the following to their commands/scripts in order to utilize the resources. @@ -83,10 +84,10 @@ or The `slurm_account` can be found in the Information field under Allocations. - ```{image} ../images/CF/quick_start/resource_table.png - :alt: resource table - :width: 800px - ``` +```{image} ../images/CF/quick_start/resource_table.png +:alt: resource table +:width: 800px +``` ## To Request Additional Resource Allocations @@ -96,10 +97,10 @@ The Storage allocation is Read-Only for students by default. If you find your class needing additional resources, you can request additional allocations for either Compute or Storage, by following the instructions below. - ```{image} ../images/CF/quick_start/request_resource_allocation.png - :alt: request resource allocation - :width: 200px - ``` +```{image} ../images/CF/quick_start/request_resource_allocation.png +:alt: request resource allocation +:width: 200px +``` 1. Next to Allocations, Select the **+Request Resource Allocation button** 2. Complete all required fields From 5f10f2ee69af468823abe3ef879917dc911b2f33 Mon Sep 17 00:00:00 2001 From: Eric Godat Date: Thu, 8 Aug 2024 11:43:51 -0500 Subject: [PATCH 07/15] Create qs_student.md --- docs/coldfront/qs_student.md | 48 ++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 docs/coldfront/qs_student.md diff --git a/docs/coldfront/qs_student.md b/docs/coldfront/qs_student.md new file mode 100644 index 00000000..fac438ad --- /dev/null +++ b/docs/coldfront/qs_student.md @@ -0,0 +1,48 @@ +# Getting Started in ColdFront as a Student + +These instructions will help you get access to HPC resources in your class. + +## Getting to ColdFront + +ColdFront is a platform for managing access to our HPC resources. You will need to go to [hpcaccess.smu.edu](hpcaccess.smu.edu) and log in to ColdFront using SSO. + +## In Class + +You will see your class and associated allocations on your dashboard. +Your class will have at least one allocation for **Compute** and possibly allocations for **Storage**. +You will see a button for **Pending EULA** next to each allocation. +You will need to accept the EULA for *each* allocation in order to get access the those resources. + +```{note} +Once you accept the EULA, they will be granted an HPC account. +In most cases this process is instantenous, however if your class has a large number of files in a storage allocation, this could take several minutes. +``` + +If you are using the Open OnDemand portal [hpc.smu.edu](hpc.smu.edu) for your class, you will be able to click on the link in the top menu bar to go directly to the M3 Portal. + +If you are using `srun` commands or `sbatch` scripts, you will need to add the following to your commands/scripts in order to utilize the resources. + +`#SBATCH -A slurm_account_name` + +or + +`srun -A slurm_account_name …` + +The `slurm_account` can be found in the Information field under Allocations. + +```{image} ../images/CF/quick_start/resource_table.png +:alt: resource table +:width: 800px +``` + +## To view your current usage + +1. Under Allocations select the folder icon +2. You will see your Allocation details, EULA Agreements, and Usage by Hours + + +## Concluding the Semester + +At the end of the semester, your class will be Archived. +Once you class is successfully archived, you will not be able to access any of the resources on the system. +Any files you have created that you wish to retain access to should be transferred off the HPC system. From de0314fd9a476fbe41142fd51cddc9acdda7bafa Mon Sep 17 00:00:00 2001 From: Eric Godat Date: Thu, 8 Aug 2024 17:32:11 -0500 Subject: [PATCH 08/15] Create add_class.md --- docs/coldfront/add_class.md | 85 +++++++++++++++++++++++++++++++++++++ 1 file changed, 85 insertions(+) create mode 100644 docs/coldfront/add_class.md diff --git a/docs/coldfront/add_class.md b/docs/coldfront/add_class.md new file mode 100644 index 00000000..fe5f65bf --- /dev/null +++ b/docs/coldfront/add_class.md @@ -0,0 +1,85 @@ +# Add a Class + +```{note} +Only benefits eligible faculty or staff can create a class. +``` + +These instructions will help you get access to HPC resources for your class. +If you are the instructor of record in my.smu, much of this process will be easy and automated for you. +If you are not an instructor of record for a course but would like to set up a course (e.g. workshop or bootcamp), +please reach out to [help@smu.edu](mailto:help%40smu.edu?subject=%5BHPC%5D) and include [HPC] in the subject line. + +### Setting up your class + +```{image} ../images/CF/quick_start/add_class.png +:alt: add a class button +:width: 400px +``` + +1. Login to ColdFront via SSO with your SMU credentials +2. Select Add a class +3. Select your course from the drop down menu +4. Select which sections you would like to have access to HPC resources +5. Mark which additional options you need +6. Select Save once complete. + +Once a class is created you will have options to Add additional users and request additional allocations. + +### To add Students and Other Users + +For classes, the management of students is synched hourly with class enrollment records starting a week before the semester starts. +Once in the , students that add or drop will be added or removed from your class and allocations accordingly. + +```{note} +All students will appear 7 days before the semester begins. +``` + +If you wish to add a user who is not enrolled to your class (e.g. a co-instructor), follow the steps below. + +```{note} +This is not especially common. Do not add students that will be enrolled in the course as this could disrupt their file permissions. +``` + +1. Once your class is created, select Add Users within the Users section of your class + + ```{image} ../images/CF/quick_start/add_users.png + :alt: add users + :width: 400px + ``` + +2. If you are searching by “Exact Username Only” search for the user via SMU email alias + + ```{note} + If you are adding multiple users, you can list them all in the Search String box + ``` + +3. If you are searching by “All Fields” you can enter last name or SMU email alias + +4. Once you’ve found and selected the user(s), select the role the user should have + + ```{image} ../images/CF/quick_start/user_role.png + :alt: user role + :width: 100px + ``` + +5. Then Add Selected Users to Project +6. Once complete you will see all users requested under the Users section + +### To Request Additional Resource Allocations + +All classes are granted a default compute allocation consisting of ***Core Usage (Hours)*** and ***Memory Usage (Hours)***. +Depending on the options chosen at the creation of the project, this may contain ***Accelerator Usage (Hours)*** or a second allocation for Storage. +The Storage allocation is Read-Only for students by default. + +If you find your class needing additional resources, you can request additional allocations for either Compute or Storage, by following the instructions below. + +```{image} ../images/CF/quick_start/request_resource_allocation.png +:alt: request resource allocation +:width: 200px +``` + +1. Next to Allocations, Select the **+Request Resource Allocation button** +2. Complete all required fields +3. Select the users you’d like to add to this allocation +4. Select Submit +5. Once complete you will see your status request as **Pending Review** under Allocations From e28e24f4c9637398c6eee0f06335b5e90d2d5b28 Mon Sep 17 00:00:00 2001 From: Eric Godat Date: Thu, 8 Aug 2024 17:35:15 -0500 Subject: [PATCH 09/15] Update qs_instructor.md changed SMUID to credentials --- docs/coldfront/qs_instructor.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/coldfront/qs_instructor.md b/docs/coldfront/qs_instructor.md index 66cf44bb..fd79f871 100644 --- a/docs/coldfront/qs_instructor.md +++ b/docs/coldfront/qs_instructor.md @@ -12,7 +12,7 @@ please reach out to [help@smu.edu](mailto:help%40smu.edu?subject=%5BHPC%5D) and :width: 400px ``` -1. Login to ColdFront via SSO with your SMU ID and Password +1. Login to ColdFront via SSO with your SMU credentials 2. Select Add a class 3. Select your course from the drop down menu 4. Select which sections you would like to have access to HPC resources From 8905dcdbb8bc6e74a1a1d3fd0beb07762a9244dd Mon Sep 17 00:00:00 2001 From: Eric Godat Date: Mon, 12 Aug 2024 14:40:12 -0500 Subject: [PATCH 10/15] Update qs_instructor.md Small fix --- docs/coldfront/qs_instructor.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/coldfront/qs_instructor.md b/docs/coldfront/qs_instructor.md index fd79f871..6e3335c8 100644 --- a/docs/coldfront/qs_instructor.md +++ b/docs/coldfront/qs_instructor.md @@ -17,7 +17,7 @@ please reach out to [help@smu.edu](mailto:help%40smu.edu?subject=%5BHPC%5D) and 3. Select your course from the drop down menu 4. Select which sections you would like to have access to HPC resources 5. Mark which additional options you need -6. Select Save once complete. +6. Select Submit once complete. Once a class is created you will have options to Add additional users and request additional allocations. From 30fcd56f31685466b35520c45bb6a85c09c05e9e Mon Sep 17 00:00:00 2001 From: Eric Godat Date: Mon, 12 Aug 2024 14:44:03 -0500 Subject: [PATCH 11/15] Update qs_instructor.md --- docs/coldfront/qs_instructor.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/coldfront/qs_instructor.md b/docs/coldfront/qs_instructor.md index 6e3335c8..701c3401 100644 --- a/docs/coldfront/qs_instructor.md +++ b/docs/coldfront/qs_instructor.md @@ -24,13 +24,13 @@ Once a class is created you will have options to Add additional users and reques ## To add Students and Other Users For classes, the management of students is synched hourly with class enrollment records starting a week before the semester starts. -Once in the , students that add or drop will be added or removed from your class and allocations accordingly. +Once a class is requested in ColdFront, students that add or drop will be added or removed from your class and allocations accordingly. ```{note} All students will appear 7 days before the semester begins. ``` -If you wish to add a user who is not enrolled to your class (e.g. a co-instructor), follow the steps below. +If you wish to add a user who is ***not*** enrolled to your class (e.g. a co-instructor), follow the steps below. ```{note} This is not especially common. Do not add students that will be enrolled in the course as this could disrupt their file permissions. From 8de83b1ac68b824f9ea043ce4e6a940f5ac2e3bc Mon Sep 17 00:00:00 2001 From: Eric Godat Date: Mon, 12 Aug 2024 15:03:49 -0500 Subject: [PATCH 12/15] Update qs_instructor.md Update for accepting EULA from Project page not home page --- docs/coldfront/qs_instructor.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/coldfront/qs_instructor.md b/docs/coldfront/qs_instructor.md index 701c3401..03a3ab45 100644 --- a/docs/coldfront/qs_instructor.md +++ b/docs/coldfront/qs_instructor.md @@ -64,7 +64,9 @@ This is not especially common. Do not add students that will be enrolled in the ## In Class Once you are ready for your students to use the resources, have them go to [hpcaccess.smu.edu](hpcaccess.smu.edu) and log in to ColdFront. -They will see your class and associated allocations on their dashboard. They will see a button for **Pending EULA** next to each allocation. +They will see your class and associated allocations on their dashboard. They will need to click on your class to be taken to the class page. + +Under Allocations, they will see a button for **Review and Accept EULA to activate** for to each allocation. They will need to accept the EULA for each allocation in order to get access the those resources. ```{note} From 11858edcb608e32777e650dbd0875dacca106b50 Mon Sep 17 00:00:00 2001 From: Mateo Langston Smith Date: Thu, 15 Aug 2024 15:38:54 -0500 Subject: [PATCH 13/15] update toc with coldfront docs --- docs/_toc.yml | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/_toc.yml b/docs/_toc.yml index df7e65f9..f51f3dfe 100644 --- a/docs/_toc.yml +++ b/docs/_toc.yml @@ -14,6 +14,16 @@ parts: - file: portal.md - file: m3_migration.md - file: mp_update.md +- caption: ColdFront + chapters: + - file: coldfront/quick_start.md + sections: + - file: coldfront/qs_instructor.md + - file: coldfront/qs_student.md + - file: coldfront/add_change_project.md + - file: coldfront/add_class.md + - file: coldfront/add_remove_users.md + - file: coldfront/request_change_allocation.md - caption: Applications chapters: - file: examples/chemistry.md From 5c3d7bd1fce58c19de032baedb73f0c038e97fe1 Mon Sep 17 00:00:00 2001 From: Mateo Langston Smith Date: Thu, 15 Aug 2024 16:06:39 -0500 Subject: [PATCH 14/15] LibCal widget added to front page for workshops --- docs/index.md | 33 ++++----------------------------- 1 file changed, 4 insertions(+), 29 deletions(-) diff --git a/docs/index.md b/docs/index.md index ecba24e6..fccf9f5c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -12,39 +12,14 @@ Research Computing Institute (ODSRCI) work together to provide the computational resources and tools required by SMU’s faculty, researchers, and students to accelerate advances in research innovation. -# Spring 2024 Workshop Series - Open to All! +# Upcoming Workshops - Open to All! -The Spring 2024 ODSRCI and OIT workshop series provides a hands-on experience +The ODSRCI and OIT workshops provide a hands-on experience that will guide researchers from the basics of using SMU's supercomputing resources to advanced parallelization and application specific usage. The topics will cover information useful for researchers to quickly begin to use the advanced compute capabilities provided with the cluster. -Students can register for the workshops in advance via -https://libcal.smu.edu/calendar. Please bring your laptop to the workshop. - -## ODSRCI Workshop Series - -| Date | Time | Workshop | Location | -| ----- | ------------ | ---------------------------------------------------------------- | ---------- | -| 2/15 | 10AM-1PM | NVIDIA DLI: Fundamentals of Deep Leaning | FLE109 | -| 2/29 | 10AM-1PM | NVIDIA DLI: Fundamentals of Accelerated Data Science with RAPIDS | FLE109 | -| 3/5 | 1PM-3PM | Parallel Programming in C++ | Zoom | -| 3/21 | 10AM-12PM | Adapting AI Workflows | FLE109 | -| 3/28 | 10AM-12PM | Generative AI & Stable Diffusion on M3 | FLE109 | -| 4/15 | 10AM-11:30AM | Digital Twins and Tools to Construct Them | FLE109 | -| N/A | On-Demand | Submitting HPC Jobs More Efficiently using SLURM | [HPC Docs] | - -## OIT Workshop Series - -| Date | Time | Workshop | Location | -| ----- | ----------- | ------------------------------------------------------------ | -------- | -| 2/14 | 3PM-5PM | Introduction to GitHub | FLE323 | -| 2/14 | 11AM-1PM | A Date with K8s: Kubernetes for Research Use Cases | Zoom | -| 2/8 | 10AM-1PM | Introduction to Programming in Python | FLE109 | -| 3/7 | 10AM-12PM | Introduction to Linux | FLE109 | -| 4/2 | 1PM-3PM | Containerizing All the Things: Using Containers for Research | Zoom | -| 4/11 | 10AM-12PM | Effective Visualization of Data in R | FLE109 | - -[HPC Docs]: +Students, faculty, or staff should register for the workshops in advance via the links below. Please bring your laptop to the workshop. + \ No newline at end of file From 0721c278abba1991cba461941a0ca1be9938e7b0 Mon Sep 17 00:00:00 2001 From: Mateo Langston Smith Date: Thu, 15 Aug 2024 16:24:20 -0500 Subject: [PATCH 15/15] Change policies and guidelines language --- docs/coldfront/qs_instructor.md | 8 ++++---- docs/coldfront/qs_student.md | 8 ++++---- docs/coldfront/quick_start.md | 2 +- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/coldfront/qs_instructor.md b/docs/coldfront/qs_instructor.md index 03a3ab45..95f252f0 100644 --- a/docs/coldfront/qs_instructor.md +++ b/docs/coldfront/qs_instructor.md @@ -66,11 +66,11 @@ This is not especially common. Do not add students that will be enrolled in the Once you are ready for your students to use the resources, have them go to [hpcaccess.smu.edu](hpcaccess.smu.edu) and log in to ColdFront. They will see your class and associated allocations on their dashboard. They will need to click on your class to be taken to the class page. -Under Allocations, they will see a button for **Review and Accept EULA to activate** for to each allocation. -They will need to accept the EULA for each allocation in order to get access the those resources. +Under Allocations, they will see a button for **Review and Accept Policies and Guidelines to activate** for to each allocation. +They will need to accept the Policies and Guidelines for each allocation in order to get access the those resources. ```{note} -Once a student is in a course and accepts the EULA, they will be granted an HPC account. +Once a student is in a course and accepts the Policies and Guidelines, they will be granted an HPC account. In most cases this process is instantenous, however if you have a large number of files in a storage allocation for a class, this could take several minutes. ``` @@ -114,7 +114,7 @@ If you find your class needing additional resources, you can request additional ## To view your current usage 1. Under Allocations select the folder icon -2. You will see your Allocation details, EULA Agreements, and Usage by Hours +2. You will see your Allocation details, Policies and Guidelines Agreements, and Usage by Hours ## Concluding the Semester diff --git a/docs/coldfront/qs_student.md b/docs/coldfront/qs_student.md index fac438ad..c7df9b53 100644 --- a/docs/coldfront/qs_student.md +++ b/docs/coldfront/qs_student.md @@ -10,11 +10,11 @@ ColdFront is a platform for managing access to our HPC resources. You will need You will see your class and associated allocations on your dashboard. Your class will have at least one allocation for **Compute** and possibly allocations for **Storage**. -You will see a button for **Pending EULA** next to each allocation. -You will need to accept the EULA for *each* allocation in order to get access the those resources. +You will see a button for **Pending Policies and Guidelines** next to each allocation. +You will need to accept the Policies and Guidelines for *each* allocation in order to get access the those resources. ```{note} -Once you accept the EULA, they will be granted an HPC account. +Once you accept the Policies and Guidelines, they will be granted an HPC account. In most cases this process is instantenous, however if your class has a large number of files in a storage allocation, this could take several minutes. ``` @@ -38,7 +38,7 @@ The `slurm_account` can be found in the Information field under Allocations. ## To view your current usage 1. Under Allocations select the folder icon -2. You will see your Allocation details, EULA Agreements, and Usage by Hours +2. You will see your Allocation details, Policies and Guidelines Agreements, and Usage by Hours ## Concluding the Semester diff --git a/docs/coldfront/quick_start.md b/docs/coldfront/quick_start.md index 8ecacb49..3d5f0b55 100644 --- a/docs/coldfront/quick_start.md +++ b/docs/coldfront/quick_start.md @@ -52,7 +52,7 @@ Once Project is created you will have multiple options to Add additional users, ## To view your current usage 1. Under Allocations select the folder icon -2. You will see your Allocation details, EULA Agreements, and Usage by Hours +2. You will see your Allocation details, Policies and Guidelines Agreements, and Usage by Hours ## To add a class for HPC Access [Faculty/TA ONLY]