From b02680e78655e6727e22bf9a57b3e7b7abbbb200 Mon Sep 17 00:00:00 2001 From: John LaGrone Date: Fri, 19 Jan 2024 14:25:05 -0600 Subject: [PATCH 01/16] add index for Amber example --- docs/examples/amber/index.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 docs/examples/amber/index.md diff --git a/docs/examples/amber/index.md b/docs/examples/amber/index.md new file mode 100644 index 00000000..025e92d9 --- /dev/null +++ b/docs/examples/amber/index.md @@ -0,0 +1,28 @@ +# Amber + +**Amber** is a suite of biomolecular simulation programs. + +**Amber homepage**: [ambermd.org/](https://ambermd.org/) + +**Official Amber Tutorials**: [ambermd.org/tutorials/](https://ambermd.org/tutorials/) + +## Using Amber on the SuperPod + +### Example submission script + +```{literalinclude} amber_gpu_example.sbatch +--- +language: bash +linenos: true +--- +``` + +## Using Amber on M3 + +```{literalinclude} amber_cpu_example.sbatch +--- +language: bash +linenos: true +--- +``` + From f9d2c3aeb3978fce52381bd498d2f54b30b52c2e Mon Sep 17 00:00:00 2001 From: John LaGrone Date: Fri, 19 Jan 2024 14:25:45 -0600 Subject: [PATCH 02/16] remove exclusive flag in example --- docs/examples/amber/amber_cpu_example.sbatch | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/examples/amber/amber_cpu_example.sbatch b/docs/examples/amber/amber_cpu_example.sbatch index 40cb741e..96ab4d45 100644 --- a/docs/examples/amber/amber_cpu_example.sbatch +++ b/docs/examples/amber/amber_cpu_example.sbatch @@ -4,7 +4,6 @@ #SBATCH -p dev #SBATCH -N 1 #SBATCH --ntasks-per-node=4 -#SBATCH --exclusive # Amber module purge From 95ce5b7f646b279586ad908bc9aff27e1fd5d56b Mon Sep 17 00:00:00 2001 From: John LaGrone Date: Mon, 22 Jan 2024 09:57:06 -0600 Subject: [PATCH 03/16] add links to other docs --- docs/examples/amber/index.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/examples/amber/index.md b/docs/examples/amber/index.md index 025e92d9..a703e12b 100644 --- a/docs/examples/amber/index.md +++ b/docs/examples/amber/index.md @@ -1,5 +1,11 @@ # Amber +:::{seealso} +For examples and tips on submitting jobs, see [our SLURM documentation](../../slurm/slurm.md) and [Best Practices for Jobs](../../slurm/best_practices.md) + +For compute resources, see [HPC Queues](../../about/queeues.md) +::: + **Amber** is a suite of biomolecular simulation programs. **Amber homepage**: [ambermd.org/](https://ambermd.org/) @@ -8,6 +14,11 @@ ## Using Amber on the SuperPod +Files used in the example are available: + + - [on github](https://github.com/SouthernMethodistUniversity/hpc_docs/tree/update_examples/docs/examples/amber) + - on the SuperPod at `/hpc/mp/examples/amber/` + ### Example submission script ```{literalinclude} amber_gpu_example.sbatch @@ -19,6 +30,13 @@ linenos: true ## Using Amber on M3 +Files used in the example are available: + + - [on github](https://github.com/SouthernMethodistUniversity/hpc_docs/tree/update_examples/docs/examples/amber) + - on M3 at `/hpc/m3/examples/amber/` + +### Example submission script + ```{literalinclude} amber_cpu_example.sbatch --- language: bash From 1e6493044493d3d4c86bda2f2a11485ecc968f34 Mon Sep 17 00:00:00 2001 From: John LaGrone Date: Mon, 22 Jan 2024 10:23:50 -0600 Subject: [PATCH 04/16] Start adding labels so links work in admonitions. See https://jupyterbook.org/en/stable/content/executable/output-insert.html#content-executable-output-insert --- docs/about/queues.md | 7 ++++--- docs/tutorials/slurm/best_practices.md | 1 + docs/tutorials/slurm/slurm.md | 1 + 3 files changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/about/queues.md b/docs/about/queues.md index 568829bb..1e37bbc0 100644 --- a/docs/about/queues.md +++ b/docs/about/queues.md @@ -1,11 +1,12 @@ +(about:queues)= # Queues SMU's high-performance computing (HPC) clusters use [SLURM](https://slurm.schedmd.com/) to schedule and manage resources. -:::{seealso} -For examples and tips on SLURM usage, see [our SLURM documentation](../slurm/slurm.md). -::: +```{seealso} +For examples and tips on SLURM usage, see [our SLURM documentation](tutorials:slurm) and [Best Practices](tutorials:slurm:best_practices). +``` :::{note} The efficiency of SLURM and our HPC systems depend on reasonable resource requests. diff --git a/docs/tutorials/slurm/best_practices.md b/docs/tutorials/slurm/best_practices.md index d9ace642..cbf7e1d6 100644 --- a/docs/tutorials/slurm/best_practices.md +++ b/docs/tutorials/slurm/best_practices.md @@ -1,3 +1,4 @@ +(tutorials:slurm:best_practices)= # Best Practices for Jobs The following are some tips that will help your and everyone elses jobs use HPC resources more efficiently. diff --git a/docs/tutorials/slurm/slurm.md b/docs/tutorials/slurm/slurm.md index 67fa7497..9ba4b6c8 100644 --- a/docs/tutorials/slurm/slurm.md +++ b/docs/tutorials/slurm/slurm.md @@ -1,3 +1,4 @@ +(tutorials:slurm)= # Slurm ## Submitting Jobs Using Slurm From ebffbf34c3c3084b32df25f4fe6ddc58898fdd37 Mon Sep 17 00:00:00 2001 From: John LaGrone Date: Mon, 22 Jan 2024 10:30:51 -0600 Subject: [PATCH 05/16] remove html divs. They don't appear to have been used / unrecognized command from interpreter --- docs/tutorials/slurm/slurm.md | 219 ---------------------------------- 1 file changed, 219 deletions(-) diff --git a/docs/tutorials/slurm/slurm.md b/docs/tutorials/slurm/slurm.md index 9ba4b6c8..1ee47d77 100644 --- a/docs/tutorials/slurm/slurm.md +++ b/docs/tutorials/slurm/slurm.md @@ -46,16 +46,10 @@ jobs: [here](https://computing.llnl.gov/linux/slurm/sinfo.html). The usage command (with the most-helpful optional arguments in brackets) is - ```{=html} -
- ``` ``` bash $ sinfo [-a] [-l] [-n ] [-p ] [-s] [-a] [-a] [-a] ``` - ```{=html} -
- ``` where these options are: - `-a` or `--all` \-- Display information about all partitions @@ -72,34 +66,21 @@ jobs: Examples: - ```{=html} -
- ``` ``` bash $ sinfo --long -p highmem # long output for all nodes allocated to the "highmem" partition $ sinfo -s # summarizes output on all nodes on all partitions ``` - ```{=html} -
- ``` - - `squeue` \-- views information about jobs located in the SLURM scheduling queue. A full list of options is available [here](https://computing.llnl.gov/linux/slurm/squeue.html). The usage command (with the most-helpful optional arguments in brackets) is - ```{=html} -
- ``` ``` bash $ squeue [-a] [-j] [-l] [-p] [--start] [-u] ``` - ```{=html} -
- ``` where these options are: - `-a` or `--all` \-- Display information about jobs and job steps @@ -121,34 +102,22 @@ jobs: Examples: - ```{=html} -
- ``` ``` bash $ squeue # all jobs $ squeue -u rkalescky --start # anticipated start time of jobs $ squeue --jobs 12345,12346,12348 # information on only jobs 12345, 12346 and 12348 ``` - ```{=html} -
- ``` - `sbatch` \-- submits a batch script to SLURM. A full list of options is available [here](https://computing.llnl.gov/linux/slurm/sbatch.html). The usage command is - ```{=html} -
- ``` ``` bash $ sbatch [options] `