diff --git a/README.md b/README.md index 2b4892c..abf19df 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,10 @@ The `global.rst` file contains an [RST substitution](https://docutils.sourceforg Found in the `docs/source/_static/css/custom.css` file. Only a minimal set of CSS tweaks are there as we keep close to the default theme. +**Images and Tables** + +Located in the `assets/img` and `assets/data` folders. The `csv` files in the `data` folder are useful for displaying tables with good formatting. + ## Reference For `Re Structured Text` help: @@ -57,6 +61,6 @@ For `Re Structured Text` help: [RST Specs](https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html) -The site has a cheatsheet page which is built from `docs/source/cheatsheet.rst` and not linked in the website but accessible as [https://vikingdocs.york.ac.uk/cheatsheet.html](https://vikingdocs.york.ac.uk/cheatsheet.html). +The site has a *cheatsheet* page to showcase example syntax, it's built from `docs/source/cheatsheet.rst` and not linked in the website but accessible as [https://vikingdocs.york.ac.uk/cheatsheet.html](https://vikingdocs.york.ac.uk/cheatsheet.html). diff --git a/docs/source/assets/data/partition_table.csv b/docs/source/assets/data/partition_table.csv index ea24956..7911b3f 100644 --- a/docs/source/assets/data/partition_table.csv +++ b/docs/source/assets/data/partition_table.csv @@ -1,10 +1,11 @@ Partition |br| Name,Max Job |br| Time,Max Jobs |br| per User,Max Cores |br| Running |br| per User,Max Running |br| Memory |br| Per User,Default |br| Coes |br| Per Job,Default |br| Memory |br| Per Core,Number |br| of Nodes -nodes,48 hrs,No Limit,500,2.4 TB,1,4.8 GB,170 -test,30 mins,2 running |br| 4 total,8,16 GB,1,1 GB,170 -preempt,30 days,No limit,No limit,No limit,1,4.8 GB,170 -himem,48 hrs,No limit,288,3.78 TB,1,11.875 GB,4 -himem_week,7 days,No limit,64,760 GB,1,11.875 GB,1 -gpu,72 hrs,No limit,40,384 GB,1,9.6 GB,2 -week,7 days,No limit,400,1.92 TB,1,4.75 GB,10 -month,30 days,No limit,120,575 GB,1,4.75 GB,3 -interactive,8 hrs,1,1,19258M,1,9629M,1 +nodes,48 hrs,No Limit,960,51G,,,116 +week,7 days,No Limit,,,,,11 +month,30 days,No Limit,,,,,2 +test,30 mins,2,8,16G,,1G,116 +preempt,30 days,No Limit,,,,,116 +gpu,3 days,No Limit,,,,,16 +gpuplus,3 days,No Limit,,,,,6 +himmem,2 days,No Limit,,,,20G,2 +himem_week,7 days,No Limit,,,,20G,1 +interactive,8 hours,1,1,25G,,10G,1 diff --git a/docs/source/cheatsheet.rst b/docs/source/cheatsheet.rst index d4da35b..f2c136d 100644 --- a/docs/source/cheatsheet.rst +++ b/docs/source/cheatsheet.rst @@ -5,7 +5,7 @@ Main heading ============ -Use a clear line under each heading at least the length of the text +Use a clear line under each heading at least the length of the text. All headings must be *sentence case* (capitalise the first character only) to adhere to the University style guide. Subheading ---------- diff --git a/docs/source/using_viking/resource_partitions.rst b/docs/source/using_viking/resource_partitions.rst index 9f1beea..99856bc 100644 --- a/docs/source/using_viking/resource_partitions.rst +++ b/docs/source/using_viking/resource_partitions.rst @@ -8,7 +8,7 @@ .. attention:: - THIS IS THE OLD PARTITION TABLE + The resource partitions are currently being configured and not all limits are currently set. This will change over the coming days and this page will be updated accordingly. Resource partitions @@ -30,7 +30,13 @@ Additional partition information -------------------------------- nodes - Practical job limit of 500 running jobs, assuming 1 core per job. There is also a total limit of 2.4TB + Maximum limit of 960 cores. + +week + Partition for jobs that need to run for longer than the 48h max time allowed by the nodes partition, but for less than a week. The max running cores and max running memory limits are practical limits, due to the resources available on the nodes. + +month + Partition for jobs that need to run for longer than the 7 day max time allowed by the week partition, but for less than 30 days. The max running cores and max running memory limits are practical limits, due to the resources available on the nodes. test For testing small jobs @@ -38,25 +44,21 @@ test preempt **Warning:** Jobs submitted to this partition are subject to preemption. There is no guarantee when or if a job will run, or whether it will complete. This partition has no limits on the resources that can be requested, but a lower priority than the nodes partition. Jobs will run if there are free resources in the nodes partition, but will be cancelled if these resources are later required for another higher priority job. -himem - For running jobs that require memory greater than that available in other partitions. Three nodes (himem02, himem04 and himem05) have 64 cores, one node (himem01) has 96 cores. The max running cores and max running memory limits are practical limits, due to the resources available on the nodes. - -himem_week - Partition for running jobs that require memory greater than that available in other partitions. The max running cores and max running memory limits are practical limits, due to the resources available on the nodes. - gpu Partition for running jobs that require GPUs, see documentation for details about how to request GPUs. - There are 4 GPUs and 40 cores on each GPU node, subject to the following rules: + - Your job script must request at least one GPU + - You can use **no more than six GPUs** at a time across all of your jobs running in the GPU partition +gpuplus + Partition for running jobs that require GPUs, see documentation for details about how to request GPUs. - Your job script must request at least one GPU - - You can request a maximum of 10 cores per GPU - - You can use no more than 2 GPUs at a time across all of your jobs running in the GPU partition + - You can use **no more than two GPUs** at a time across all of your jobs running in the GPU partition -week - Partition for jobs that need to run for longer than the 48h max time allowed by the nodes partition, but for less than a week. The max running cores and max running memory limits are practical limits, due to the resources available on the nodes. +himem + For running jobs that require memory greater than that available in other partitions. Each of the two nodes (himem01 and himem02) have 96 cores. The max running cores and max running memory limits are practical limits, due to the resources available on the nodes. -month - Partition for jobs that need to run for longer than the 7 day max time allowed by the week partition, but for less than 30 days. The max running cores and max running memory limits are practical limits, due to the resources available on the nodes. +himem_week + Partition for running jobs that require memory greater than that available in other partitions. The max running cores and max running memory limits are practical limits, due to the resources available on the nodes. interactive - Partition for jobs that would like to use Viking interactively. This could be used for graphical work with the 8 hr queue limit set to mimic a working day. You can run interactive jobs in the ``nodes`` partition (or any other), but the queue time will be shorter in the ``interactive`` partition. + Partition for jobs that would like to use Viking interactively. This could be used for graphical work with the **eight hour queue limit** set to mimic a working day. You can run interactive jobs in the ``nodes`` partition (or any other), but the queue time will be shorter in the ``interactive`` partition.