Merge pull request #87 from silx-kit/update-doc

Update demo config and readme

Author: t20100

README.md

@@ -10,7 +10,7 @@
   partitions set in the Spawner and allows the user to select Slurm resources to
   use.
 
-<img style="margin:auto" src=https://user-images.githubusercontent.com/9449698/194308511-f0e6d6a9-ba7a-4086-a871-23b08523c61a.png width="50%">
+<img style="margin:auto" src=https://user-images.githubusercontent.com/9449698/215526389-2ef5ac32-5d50-49de-aa5f-46972feaccf1.png width="50%">
 
 ## Install
 
@@ -99,6 +99,9 @@ c.MOSlurmSpawner.partitions = {
 }
 ```
 
+For a minimalistic working demo, check the
+[`demo/jupyterhub_conf.py`](demo/jupyterhub_conf.py) config file.
+
 ### Field descriptions
 
 - `architecture`: The architecture of the partition. This is only cosmetic and
@@ -147,7 +150,7 @@ The spawn page (available at `/hub/spawn`) will be generated according to the
 partition settings. For example, this is the spawn page generated for the
 partition settings above:
 
-<img style="margin:1rem auto" src=https://user-images.githubusercontent.com/9449698/194308511-f0e6d6a9-ba7a-4086-a871-23b08523c61a.png width="50%">
+<img style="margin:1rem auto" src=https://user-images.githubusercontent.com/9449698/215526389-2ef5ac32-5d50-49de-aa5f-46972feaccf1.png width="50%">
 
 This spawn page is separated in two tabs: a _Simple_ and an _Advanced_ tab. On
 the _Simple_ tab, the user can choose between the partitions set though
@@ -159,15 +162,15 @@ Clicking on the **Start** button will request the job.
 The spawn page adapts to the chosen partition. This is the page when selecting
 the `partition_2`:
 
-<img style="margin:1rem auto" src=https://user-images.githubusercontent.com/9449698/194308454-697c717f-daf0-4927-9fa6-6b96ba09dba6.png width="50%">
+<img style="margin:1rem auto" src=https://user-images.githubusercontent.com/9449698/215526553-4ba57510-efac-4a28-a576-ef81ff9ec2f5.png width="50%">
 
 As the maximum number of cores is different, the CPUs row change accordingly.
 Also, as `gpu` was set for `partition_2`, a new button row appears to enable GPU
 requests.
 
 The _Advanced_ tab allows finer control on the requested resources.
 
-<img style="margin:1rem auto" src=https://user-images.githubusercontent.com/9449698/194308524-38417bb8-f520-4940-9c94-af960f11e535.png width="50%">
+<img style="margin:1rem auto" src=https://user-images.githubusercontent.com/9449698/215526665-a650a54d-e7ec-4d50-b5ab-a02d93b23d19.png width="50%">
 
 The user can select any partition (`partition_3` is added in this case) and the
 table of available resources reflects this. The user can also choose any number

demo/jupyterhub_conf.py

@@ -13,16 +13,6 @@
 jupyterhub_moss.set_config(c)
 
 
-SINFO_OUTPUT = """unused 40 28+ 121/1191/0/1312 (null) 196000+ infinite
-partition_1 48 35+ 38/1642/0/1680 (null) 196000+ 1-00:00:00
-partition_2 7 128 116/780/0/896 gpu:GPU-MODEL:2 512000 12:00:00
-partition_3 28 40 114/1006/0/1120 (null) 310000 4:00:00
-other_mixed 10 64 152/488/0/640 gpu:OTHER-GPU:2(S:0-1) 455000+ 7-00:00:00
-other_mixed 94 28+ 153/3583/0/3736 (null) 196000+ 7-00:00:00
-"""
-c.MOSlurmSpawner.slurm_info_cmd = f'echo "{SINFO_OUTPUT}"'
-
-
 # Partition descriptions, see https://github.com/silx-kit/jupyterhub_moss#partition-settings
 c.MOSlurmSpawner.partitions = {
     "partition_1": {
@@ -85,12 +75,23 @@
     },
 }
 
+# Uncomment the following to customize the options_form template
+# c.JupyterHub.template_paths = [os.path.join(os.path.dirname(__file__), "templates")]
 
-# JupyterHub
+# Mock SLURM sinfo command for the demo
+SINFO_OUTPUT = """unused 5/35/0/40 28+ 121/1191/0/1312 (null) 196000+ infinite
+partition_1 2/46/0/48 35+ 38/1642/0/1680 (null) 196000+ 1-00:00:00
+partition_2 2/5/0/7 128 116/780/0/896 gpu:GPU-MODEL:2 512000 12:00:00
+partition_3 4/24/0/28 40 114/1006/0/1120 (null) 310000 4:00:00
+other_mixed 3/7/0/10 64 152/488/0/640 gpu:OTHER-GPU:2(S:0-1) 455000+ 7-00:00:00
+other_mixed 6/86/0/94 28+ 153/3583/0/3736 (null) 196000+ 7-00:00:00
+"""
+c.MOSlurmSpawner.slurm_info_cmd = f'echo "{SINFO_OUTPUT}"'
+
+# Batchspawner: Do not run sudo for the demo
+c.BatchSpawnerBase.exec_prefix = ""
+
+# JupyterHub basic config
 c.JupyterHub.ip = "127.0.0.1"
 c.JupyterHub.hub_ip = "127.0.0.1"
 c.JupyterHub.port = 8000
-c.JupyterHub.template_paths = [os.path.join(os.path.dirname(__file__), "templates")]
-
-# Batchspawner
-c.BatchSpawnerBase.exec_prefix = ""  # Do not run sudo