diff --git a/docs/Interactive_Computing/OnDemand/Running_Jobs_From_Ondemand/.pages.yml b/docs/Interactive_Computing/OnDemand/Running_Jobs_From_Ondemand/.pages.yml new file mode 100644 index 000000000..34614d79f --- /dev/null +++ b/docs/Interactive_Computing/OnDemand/Running_Jobs_From_Ondemand/.pages.yml @@ -0,0 +1,4 @@ +--- +nav: + - Viewing Active Jobs: active_jobs.md + - Creating New Jobs: job_composer.md diff --git a/docs/Interactive_Computing/OnDemand/Running_Jobs_From_Ondemand/active_jobs.md b/docs/Interactive_Computing/OnDemand/Running_Jobs_From_Ondemand/active_jobs.md new file mode 100644 index 000000000..7c5539b52 --- /dev/null +++ b/docs/Interactive_Computing/OnDemand/Running_Jobs_From_Ondemand/active_jobs.md @@ -0,0 +1,45 @@ +# Viewing Active Jobs: `Active Jobs` + +The `Active Jobs` page allows you to see what jobs are running. This page queries `squeue` and `scontrol` and reports information from these slurm command to this dashboard. To access the `Active Jobs` page, click the `Jobs` tab at the top left of the Ondemand screen, then click on `Active Jobs`. + +![Direction to Jobs Section of Mahuika OnDemand](../../../assets/images/running_jobs_from_ondemand_Jobs_OnDemand_1.png) + +## The `Active Jobs` page + +There are three point of interest on this page: + +1. The Information Button: Show you more information about that specific job. +2. The Status Icon: Tells you what state your job is in (such as `Queued`, `Running`, and `Completed`). +3. The Trash Button: Allow you to cancel a specific job. + +![Main face of Active Jobs](../../../assets/images/Jobs_OnDemand_2.png) + +### The Information Button + +Clicking this button will allow you to see more information about this job: + +![Information on this Job](../../../assets/images/Jobs_OnDemand_3.png) + +This information tab contains three further buttons at the bottom left hand of the tab: + +1. The File Manager: Clicking this button will take you to the directory of your job on Mahuika OnDemand. In here, you will find your output files for your job. You can view text files from here, including `.out` and `.err` files. +2. The Terminal Button: Clicking this button will take you to the terminal, where you will be placed in the directory for this job. +3. The Trash Button: Allow you to cancel a specific job. + +### The Status Icon + +This can be seen as `Queued`, `Running`, or `Completed`. + +!!! note + + This does not auto-refresh, so you may need to refresh your screen for up to date information. + +![Queued](../../../assets/images/Jobs_OnDemand_2.png) +![Running](../../../assets/images/Jobs_OnDemand_4.png) +![Completed](../../../assets/images/Jobs_OnDemand_5.png) + +### The Trash Button + +You will get a pop-up indicating if you want to cancel a job before it is cancelled. Click `OK` to cancel your job. + +![Pop-Up about Cancelling Job](../../../assets/images/Jobs_OnDemand_6.png) diff --git a/docs/Interactive_Computing/OnDemand/Running_Jobs_From_Ondemand/job_composer.md b/docs/Interactive_Computing/OnDemand/Running_Jobs_From_Ondemand/job_composer.md new file mode 100644 index 000000000..f826e8d35 --- /dev/null +++ b/docs/Interactive_Computing/OnDemand/Running_Jobs_From_Ondemand/job_composer.md @@ -0,0 +1,32 @@ +# Creating New Jobs: `Job Composer` + +The `Job Composer` page allows you to set up your submit script and files for a job from within the Mahuika OnDemand platform. To access the `Job Composer` page, click the `Jobs` tab at the top left of the Ondemand screen, then click on `Job Composer`. This will open a new tab in your browser, showing the `Job Composer` + +![Direction to Jobs Section of Mahuika OnDemand](../../../assets/images/running_jobs_from_ondemand_Jobs_OnDemand_1.png) + +## The `Job Composer` page + +There are two tabs at the top of this page: + +1. [`Jobs`](#the-jobs-page): Create and run jobs +2. [`Template`](#the-template-page): Create a slurm submit template to use. + +![Job Composer](../../../assets/images/Jobs_OnDemand_7.png) + +## The `Jobs` Page + +This page allows you to create and submit jobs to slurm. To set-up a job: + +**First**, click the `+ New Job` button `-->` `From Default Template`: + +![Job Composter](../../../assets/images/Jobs_OnDemand_9.png) + +This will open allow you to select new buttons in the left hand screen. Clicking on a job will open a new window called `Job Details` on the right of the screen + +![Job Composter](../../../assets/images/Jobs_OnDemand_10.png) + +**Second**, to edit the location of your + +## The `Template` Page + + diff --git a/docs/Interactive_Computing/OnDemand/how_to_guide.md b/docs/Interactive_Computing/OnDemand/how_to_guide.md index d28cdd2c7..07a7699ef 100644 --- a/docs/Interactive_Computing/OnDemand/how_to_guide.md +++ b/docs/Interactive_Computing/OnDemand/how_to_guide.md @@ -84,7 +84,7 @@ Once the session is ready, you will see a button labeled Connect to Jupyter ## Interactive file explorer -If you would like to access your project or nobackup filesystem via the Interactive file explorer ( not the terminal), +If you would like to access your project or nobackup filesystem via the Interactive file explorer ( not the terminal), please use the 00_nesi_project parent directory which contains symlinks to all filesystems you have access to. ### OnDemand App diff --git a/docs/Interactive_Computing/OnDemand/index.md b/docs/Interactive_Computing/OnDemand/index.md index 752b5a32e..c9e67aa0d 100644 --- a/docs/Interactive_Computing/OnDemand/index.md +++ b/docs/Interactive_Computing/OnDemand/index.md @@ -23,6 +23,15 @@ A number of interactive applications can be accessed through OnDemand, including - [Virtual desktop](Apps/virtual_desktop.md) - [MATLAB](Apps/MATLAB.md) - currently under development, let us know if this is of interest +## Running Jobs from OnDemand + +It is possible to create and submit jobs to slurm interactively from Mahuika using the `Jobs` section of Mahuika OnDemand. The `Jobs` section of Mahuika OnDemand can be found in the top right of the screen, as circled in red in the image below. There are two subsections that you can choose to use: + +- [`Active Jobs`](Running_Jobs_From_Ondemand/active_jobs.md): This allows you to see and interactive with your active jobs. +- [`Job Composer`](Running_Jobs_From_Ondemand/job_composer.md): This allows you to craft submit scripts for submitting to slurm. + +![Direction to Jobs Section of Mahuika OnDemand](../../assets/images/running_jobs_from_ondemand_Jobs_OnDemand_1.png) + ## Changes from Jupyter on Mahuika - JupyterLab is no longer the main user interface but is just another application to be launched via the OnDemand interface diff --git a/docs/assets/images/Jobs_OnDemand_1.png b/docs/assets/images/Jobs_OnDemand_1.png new file mode 100644 index 000000000..bf81e3540 Binary files /dev/null and b/docs/assets/images/Jobs_OnDemand_1.png differ diff --git a/docs/assets/images/Jobs_OnDemand_10.png b/docs/assets/images/Jobs_OnDemand_10.png new file mode 100644 index 000000000..d9e44813c Binary files /dev/null and b/docs/assets/images/Jobs_OnDemand_10.png differ diff --git a/docs/assets/images/Jobs_OnDemand_2.png b/docs/assets/images/Jobs_OnDemand_2.png new file mode 100644 index 000000000..5cac5bc35 Binary files /dev/null and b/docs/assets/images/Jobs_OnDemand_2.png differ diff --git a/docs/assets/images/Jobs_OnDemand_3.png b/docs/assets/images/Jobs_OnDemand_3.png new file mode 100644 index 000000000..68432dc1e Binary files /dev/null and b/docs/assets/images/Jobs_OnDemand_3.png differ diff --git a/docs/assets/images/Jobs_OnDemand_4.png b/docs/assets/images/Jobs_OnDemand_4.png new file mode 100644 index 000000000..c12da6c4c Binary files /dev/null and b/docs/assets/images/Jobs_OnDemand_4.png differ diff --git a/docs/assets/images/Jobs_OnDemand_5.png b/docs/assets/images/Jobs_OnDemand_5.png new file mode 100644 index 000000000..2dfa7afaf Binary files /dev/null and b/docs/assets/images/Jobs_OnDemand_5.png differ diff --git a/docs/assets/images/Jobs_OnDemand_6.png b/docs/assets/images/Jobs_OnDemand_6.png new file mode 100644 index 000000000..bbd27ffa8 Binary files /dev/null and b/docs/assets/images/Jobs_OnDemand_6.png differ diff --git a/docs/assets/images/Jobs_OnDemand_7.png b/docs/assets/images/Jobs_OnDemand_7.png new file mode 100644 index 000000000..023678d87 Binary files /dev/null and b/docs/assets/images/Jobs_OnDemand_7.png differ diff --git a/docs/assets/images/Jobs_OnDemand_8.png b/docs/assets/images/Jobs_OnDemand_8.png new file mode 100644 index 000000000..812f0465e Binary files /dev/null and b/docs/assets/images/Jobs_OnDemand_8.png differ diff --git a/docs/assets/images/Jobs_OnDemand_9.png b/docs/assets/images/Jobs_OnDemand_9.png new file mode 100644 index 000000000..64a63b008 Binary files /dev/null and b/docs/assets/images/Jobs_OnDemand_9.png differ diff --git a/docs/assets/images/running_jobs_from_ondemand_Jobs_OnDemand_1.png b/docs/assets/images/running_jobs_from_ondemand_Jobs_OnDemand_1.png new file mode 100644 index 000000000..bf81e3540 Binary files /dev/null and b/docs/assets/images/running_jobs_from_ondemand_Jobs_OnDemand_1.png differ diff --git a/docs/redirect_map.yml b/docs/redirect_map.yml index e9c845e1b..29fc973bd 100644 --- a/docs/redirect_map.yml +++ b/docs/redirect_map.yml @@ -177,3 +177,5 @@ Getting_Started/Getting_Help/Job_efficiency_review.md : Getting_Started/Job_effi Getting_Started/Getting_Help/Making_a_Helpful_Support_Request.md : Getting_Started/Making_a_Helpful_Support_Request.md Getting_Started/FAQs/Where_should_I_store_my_data_on_NeSI_systems.md : Getting_Started/FAQs/Where_should_I_store_my_data.md Getting_Started/my-nesi-org-nz/The_NeSI_Project_Request_Form.md : Getting_Started/my-nesi-org-nz/Project_Request_Form.md +Interactive_Computing/OnDemand/Running_Jobs/MATLAB.md : Interactive_Computing/OnDemand/Running_Jobs/running_jobs_from_ondemand.md +Interactive_Computing/OnDemand/Running_Jobs/running_jobs_from_ondemand.md : Interactive_Computing/OnDemand/running_jobs_from_ondemand.md