From db5e5dad641be0eea0eb17106d09d06c698bb7ef Mon Sep 17 00:00:00 2001 From: German <28149841+germa89@users.noreply.github.com> Date: Fri, 27 Sep 2024 20:05:03 +0200 Subject: [PATCH] docs: final reog --- doc/source/user_guide/hpc.rst | 1 - doc/source/user_guide/hpc/index.rst | 55 ---------------------- doc/source/user_guide/hpc/introduction.rst | 9 ++-- doc/source/user_guide/hpc/mapdl.rst | 9 ---- doc/source/user_guide/index.rst | 17 ++++--- 5 files changed, 13 insertions(+), 78 deletions(-) delete mode 100644 doc/source/user_guide/hpc.rst delete mode 100644 doc/source/user_guide/hpc/index.rst delete mode 100644 doc/source/user_guide/hpc/mapdl.rst diff --git a/doc/source/user_guide/hpc.rst b/doc/source/user_guide/hpc.rst deleted file mode 100644 index 8b13789179..0000000000 --- a/doc/source/user_guide/hpc.rst +++ /dev/null @@ -1 +0,0 @@ - diff --git a/doc/source/user_guide/hpc/index.rst b/doc/source/user_guide/hpc/index.rst deleted file mode 100644 index 656da0c1d6..0000000000 --- a/doc/source/user_guide/hpc/index.rst +++ /dev/null @@ -1,55 +0,0 @@ -.. _ref_hpc: - - -.. toctree:: - :maxdepth: 1 - :hidden: - - introduction - pymapdl - mapdl - troubleshooting - -******************************** -High performance computing (HPC) -******************************** - -This page provides an overview on how to use PyMAPDL in HPC clusters. -While it only considers the SLURM scheduler, many of the assumptions for this scheduler might apply to other schedulers, such as PBS, SGE, or LSF. - - -.. grid:: 2 2 2 2 - :gutter: 1 2 3 3 - :padding: 1 2 3 3 - - .. grid-item-card:: Introduction to SLURM - :link: ref_hpc_slurm - :link-type: ref - - Short and basic introduction on how SLURM clusters work. - How to submit, list and cancel jobs is explained briefly. - - - .. grid-item-card:: PyMAPDL on SLURM HPC clusters - :link: ref_hpc_pymapdl - :link-type: ref - - How to use PyMAPDL on a SLURM cluster, from - managing the Python virtual environment to job submission. - - - .. grid-item-card:: MAPDL on SLURM HPC clusters - :link: ref_hpc_mapdl - :link-type: ref - - How launch MAPDL jobs on a SLURM cluster across - one or multiple nodes. - - - .. grid-item-card:: Troubleshooting - :link: ref_hpc_troubleshooting - :link-type: ref - - Most common issues when running PyMAPDL on a cluster are - listed here with their solutions. - diff --git a/doc/source/user_guide/hpc/introduction.rst b/doc/source/user_guide/hpc/introduction.rst index f4722b4ebe..e9ab7b1a1e 100644 --- a/doc/source/user_guide/hpc/introduction.rst +++ b/doc/source/user_guide/hpc/introduction.rst @@ -1,14 +1,11 @@ .. _ref_hpc_slurm: -================= -SLURM HPC cluster -================= +===================== +Introduction to SLURM +===================== -Introduction -============ - High performance computing (HPC) clusters are powerful systems designed to handle computationally intensive tasks efficiently. SLURM (Simple Linux Utility for Resource Management) is one of the most widely used job schedulers in HPC environments. This diff --git a/doc/source/user_guide/hpc/mapdl.rst b/doc/source/user_guide/hpc/mapdl.rst deleted file mode 100644 index b6743446fe..0000000000 --- a/doc/source/user_guide/hpc/mapdl.rst +++ /dev/null @@ -1,9 +0,0 @@ - -.. _ref_hpc_mapdl: - -=========================== -MAPDL on SLURM HPC clusters -=========================== - -TBD - diff --git a/doc/source/user_guide/index.rst b/doc/source/user_guide/index.rst index 2d9797425c..ef12344826 100644 --- a/doc/source/user_guide/index.rst +++ b/doc/source/user_guide/index.rst @@ -11,12 +11,6 @@ This section provides a general overview of PyMAPDL and how you use it. pydata_sphinx_theme -.. toctree:: - :maxdepth: 1 - :hidden: - - troubleshoot - .. toctree:: :maxdepth: 1 :hidden: @@ -28,6 +22,7 @@ This section provides a general overview of PyMAPDL and how you use it. parameters components post + troubleshoot .. toctree:: :maxdepth: 1 @@ -46,11 +41,19 @@ This section provides a general overview of PyMAPDL and how you use it. :hidden: :caption: Advanced - hpc/index.rst xpl upf krylov +.. toctree:: + :maxdepth: 1 + :hidden: + :caption: High performance computing + + hpc/introduction + hpc/pymapdl + hpc/troubleshooting + PyMAPDL overview ================