Merge pull request #52 from lunarc/develop

Merge for 0.9.9 release
lunarc · Dec 21, 2023 · 887f12d · 887f12d
2 parents 08f3034 + a593f13
commit 887f12d
Show file tree

Hide file tree

Showing 17 changed files with 15,129 additions and 325 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -17,16 +17,17 @@
 sys.path.insert(0, os.path.abspath('../..'))
 
 
+
 # -- Project information -----------------------------------------------------
 
-project = 'GfxLauncher - A graphical application launcher for SLURM'
+project = 'GFX Launcher - An application launcher framework for SLURM'
 copyright = '2017-2023, Jonas Lindemann'
 author = 'Jonas Lindemann'
 
 # The short X.Y version
-version = '0.9.3'
+version = '0.9.8'
 # The full version, including alpha/beta/rc tags
-release = '0.9.3'
+release = '0.9.8'
 
 
 # -- General configuration ---------------------------------------------------
@@ -67,7 +68,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -89,7 +90,7 @@
 html_theme_options = {
 
     # Set the name of the project to appear in the navigation.
-    'nav_title': 'GfxLauncher',
+    'nav_title': 'GFX Launcher Toolkit',
 
     # Set you GA account ID to enable tracking
     #'google_analytics_account': 'UA-XXXXX',
@@ -99,15 +100,15 @@
     #'base_url': 'https://project.github.io/project',
 
     # Set the color and the accent color
-    'color_primary': 'blue',
+    'color_primary': 'dark-blue',
     'color_accent': 'light-blue',
 
     # Set the repo location to get a badge with stats
     #'repo_url': 'https://github.com/project/project/',
     #'repo_name': 'Project',
 
     # Visible levels of the global TOC; -1 means unlimited
-    'globaltoc_depth': 3,
+    'globaltoc_depth': 2,
     # If False, expand all TOC entries
     'globaltoc_collapse': True,
     # If True, show hidden TOC entries
@@ -128,7 +129,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+#html_static_path = ['_static']
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.

diff --git a/docs/source/configuration.rst b/docs/source/configuration.rst
@@ -9,43 +9,57 @@ An example configuration file is shown below:
 
     [general]
     script_dir = /sw/pkg/ondemand-dt/run
-    install_dir = /sw/pkg/ondemand-dt/gfxlauncher
-    help_url = "https://lunarc-documentation.readthedocs.io/en/latest/gfxlauncher/"
+    install_dir = /sw/pkg/gfxlauncher
+    help_url = "https://lunarc-documentation.readthedocs.io/en/latest/getting_started/gfxlauncher/"
     browser_command = firefox
 
     [slurm]
-    default_part = lvis
-    default_account = lvis-test
+    default_part = gpua40
+    default_account = lu-test
 
     feature_mem96gb = "96 GB Memory node"
     feature_mem64gb = "64 GB Memory node"
-    feature_ignore = "rack-,rack_,bc,haswell,cascade,enc,jobtmp,skylake,ampere,kepler,sandy"
-
-    part_lu = "Aurora CPU"
-    part_lu32 = "Aurora CPU (32c)"
-    part_gpua40 = "Aurora GPU (A40)"
-    part_gpua100 = "Aurora GPU (A100)"
-    part_lvis = "On-demand (K20)"
-    part_lvis2 = "On-demand (A40)"
-    part_win = "Windows on-demand (V100)"
+    feature_mem128gb = "128 GB Memory node"
+    feature_mem192gb = "192 GB Memory node"
+    feature_mem384gb = "384 GB Memory node"
+    feature_mem768gb = "768 GB Memory node"
+    feature_mem256gb = "256 GB Memory node"
+    feature_mem512GB = "512 GB Memory node"
+    feature_gpua40 = "NVIDIA A40 GPU"
+    feature_milan = "AMD Milan CPU"
+    feature_gpu3k20 = "3 x NVIDIA K20 GPU (128GB RAM)"
+    feature_kepler = "2 x NVIDIA K80 GPU"
+    feature_ampere = "2 x NVIDIA A100 GPU"
+    feature_ignore = "milan,rack-,rack_,bc,haswell,cascade,enc,jobtmp,skylake,ampere,kepler,sandy"
+
+    part_lu48 = "AMD 48 cores"
+    part_lu32 = "Intel 32 cores"
+    part_gpua40 = "AMD/NVIDIA A40 48c 24h"
+    part_gpua100 = "AMD/NVIDIA A100 48 cores"
+    part_gpua40i = "Intel/NVIDIA A40 32c 48h"
     part_ignore = "lunarc,hep"
 
-    group_ondemand = lvis,lvis2
+    group_ondemand = gpua40, gpua40i
+    group_develop = gpua40i
     group_metashape184 = lvis2
-    group_cpu = lu,lu32
-    group_gpu = gpuk20,gpua100
+    group_cpu = lu48
+    group_gpu = gpua100,gpua40
     group_win = win
-    group_all = lvis,lvis2,lu,lu32,gpua40,gpua100
+    group_all = lu48,lu32,gpua100,gpua40
+
+    group_ondemand_tasks = 4
+    group_ondemand_memory = -1
+    group_ondemand_exclusive = no
 
     use_sacctmgr = yes
 
     [menus]
-    menu_prefix = "On-Demand - "
+    menu_prefix = "Applications - "
     desktop_entry_prefix = "gfx-"
 
     [vgl]
-    vgl_bin = /sw/pkg/rviz/vgl/bin/latest
-    vgl_path = /sw/pkg/rviz/vgl/bin/latest
+    vgl_bin = /usr/bin/vglconnect
+    vgl_path = /usr/bin
     backend_node = gfx0
     vglconnect_template = %s/vglconnect %s %s/%s
 
@@ -57,6 +71,7 @@ An example configuration file is shown below:
     xfreerdp_path = /sw/pkg/freerdp/2.0.0-rc4/bin
     xfreerdp_cmdline = %s /v:%s /u:$USER /d:ad.lunarc /sec:tls /cert-ignore /audio-mode:1 /gfx +gfx-progressive -bitmap-cache -offscreen-cache -glyph-cache +clipboard /size:1280x1024 /dynamic-resolution /t:"LUNARC HPC Desktop Windows 10 (NVIDA V100)"
 
+
 General section - [general]
 ---------------------------
 
@@ -75,7 +90,7 @@ This section contain settings related to SLURM.
 | default_account | If no account information is given this is the default account used.                       |
 +-----------------+--------------------------------------------------------------------------------------------+
 | use_sacctmgr    | If set to yes (default) gfxlaunch will use project information from the sacctmgr command   |
-|                 | instead of grantfiles. This is the default.                                                        |
+|                 | instead of grantfiles. This is the default.                                                |
 +-----------------+--------------------------------------------------------------------------------------------+
 
 .. note:: grantfile and grantfile_base are specific to SNIC/LUNARC HPC resources and can be disabled.
@@ -105,7 +120,7 @@ To make the resource selection more intuitive it is also possible to give the SL
 
 .. code-block:: ini
 
-    part_gpua100 = "Aurora GPU (A100)"
+    part_gpua100 = "AMD/NVIDIA A100 48 cores"
 
 Ignoring partitions
 ~~~~~~~~~~~~~~~~~~~
@@ -136,13 +151,13 @@ Menu section - [menu]
 
 Directories and files for the **gfxconvert** menu generation is given in this section. The following variables are used by **gfxconvert**.
 
-+----------------------------+-----------------------------------------------------------------------------+
-| Variable                   | Description                                                                 |
-+----------------------------+-----------------------------------------------------------------------------+
-| menu_prefix                | Prefix added to the menu descriptio to identify menus generated by gfxmenu  |
-+----------------------------+-----------------------------------------------------------------------------+
-| directdesktop_entry_prefix | Prefix added to desktop-shortcuts generated by gfxmenu                      |
-+----------------------------+-----------------------------------------------------------------------------+
++----------------------------+-------------------------------------------------------------------------------+
+| Variable                   | Description                                                                   |
++----------------------------+-------------------------------------------------------------------------------+
+| menu_prefix                | Prefix added to the menu descriptions to identify menus generated by gfxmenu. |
++----------------------------+-------------------------------------------------------------------------------+
+| directdesktop_entry_prefix | Prefix added to desktop-shortcut files generated by gfxmenu.                  |
++----------------------------+-------------------------------------------------------------------------------+
 
 VirtualGL section - [vgl]
 -------------------------
@@ -152,7 +167,7 @@ This section is used by **gfxlaunch** to configure where the binaries for Virtua
 +----------------------+-----------------------------------------------------------------------------+
 | Variable             | Description                                                                 |
 +----------------------+-----------------------------------------------------------------------------+
-| vgl_path             | Path for VirtualGL executables                                              |
+| vgl_path             | Path for VirtualGL executables (for example: /usr/bin)                      |
 +----------------------+-----------------------------------------------------------------------------+
 | vgl_connect_template | Command to execute vglconnect. Should be %s/vglconnect %s %s/%s by default. |
 +----------------------+-----------------------------------------------------------------------------+

diff --git a/docs/source/gfxconvert.rst b/docs/source/gfxconvert.rst