Updates spec and improved cards

- Split kernels into programming language and environments - added technical section, url accessiablity, resources totals and usage statistics - added target group to cards
NFDI-Jupyter · Oct 25, 2023 · a2e384b · a2e384b
1 parent 238d05e
commit a2e384b
Show file tree

Hide file tree

Showing 17 changed files with 271 additions and 86 deletions.
diff --git a/data/GESIS-Notebooks.yaml b/data/GESIS-Notebooks.yaml
@@ -5,17 +5,21 @@ support: [email protected]
 health_api_url: http://notebooks.gesis.org/binder/health
 documentation_url: https://the-turing-way.netlify.app/communication/binder/zero-to-binder.html
 target_group_open_for: Open, with a focus on Computational Social Science
+restricted: false
 login_process: Open
-deployment_url: https://github.com/gesiscss/orc2
 features:
   version: JupyterHub 3.0.0-beta.1, BinderHub
-  kernels: ["configurable by the user"]
+  programming_languages: ["configurable by the user"]
+  environments: ["configurable by the user"]
   extensions: ["configurable by the user"]
   proxy_apps: []
   install: true
   shared_folder: false
   persistent_storage: false
   misc: ["Part of the BinderHub Federation"]
+technicals:
+  deployment_url: https://github.com/gesiscss/orc2
+  misc: []
 resources:
   default_server_user: 1
   max_server_user: 250

diff --git a/data/RWTH-NFDI-Jupyter-Service.yaml b/data/RWTH-NFDI-Jupyter-Service.yaml
@@ -1,14 +1,18 @@
 title: RWTH HPC JupyterHub
 provider: ITC RWTH Aachen University
 service_url: https://jupyterhub.hpc.itc.rwth-aachen.de:9651/
+service_url_requirement: Network address of RWTH, FH Aachen, Bochum, Bonn, Cern, Darmstadt, Duisburg/Essen, Erlangen, Hagen, Desy, Juelich, LRZ Muenchen, Muenster, Siegen, Wien, Wuppertal or Saarland University
 support: [email protected]
 health_api_url: https://jupyterhub.hpc.itc.rwth-aachen.de:9651/hub/api/health
 documentation_url: https://help.itc.rwth-aachen.de/service/rhr4fjjutttf/article/689934fec5a34c909c54606f6bc2e827/
-target_group_open_for: Researchers, RWTH Students/Employees/Guests, Juelich Members, Users sponsored by other Users, Users upon project application 
+target_group_open_for: Researchers, RWTH Students/Employees/Guests, Juelich Members, Users sponsored by other Users, Users upon project application
+restricted: true
 login_process: Login with RWTH HPC Account through most NHR or NRW VPNs
 features:
   version: JupyterHub 3.0+, JupyterLab 3.4.7+
-  kernels: ["Python 3.9", "Octave", "R", "C++ 11/14/17", "Matlab 2022b", "Matlab 2020b",  "Python: Keras", "Python: Tensorflow",  "Python: Tensorboard", "Python: Gurobi", "Python: Pytorch" ]
+  programming_languages: ["Python 3.9", "Octave", "R", "C++ 11/14/17", "Matlab 2020b", "Matlab 2022b"]
+  environments: ["Python: Keras + Tensorflow", "Python: Tensorboard + Keras + Tensorflow", "Python: Pytorch",  "Pytorch: Tensorboard", "Python: Gurobi", "Matlab: Gurobi", "Custom"]
+  environments_info: "https://help.itc.rwth-aachen.de/service/rhr4fjjutttf/article/50a810bf34da41c3a37bd315505af92a/"
   extensions: ["ipytree",
         "jupyterlab-drawio",
         "jupyterlab-plotly",
@@ -23,7 +27,11 @@ features:
   install: false
   shared_folder: true
   persistent_storage: true
-  misc: ["Available computing time (core-hours) vary based on user affiliation or project. Project application is necesary.", "Runs on HPC Hardware under Slurm.", "Users installs planned, by request only at the moment."]
+  misc: ["Available computing time (core-hours) vary based on user affiliation or project. Project application is necessary.",
+         "Users installs planned, by request only at the moment."]
+technicals:
+  deployment: "Runs on HPC Hardware under Slurm."
+  misc: []
 resources:
   default_server_user: 1
   max_server_user: 5

diff --git a/data/gwdg.yaml b/data/gwdg.yaml
@@ -5,16 +5,21 @@ support: [email protected]
 health_api_url: 
 documentation_url: https://docs.gwdg.de/doku.php?id=en:services:application_services:jupyter:start
 target_group_open_for: Users having a full GWDG account (which can include people working in partner projects)
+restricted: true
 login_process: Login via Shibboleth (AcademicID - academiccloud.de)
 features:
   version: JupyterLab 3.5 (via JupyterHub)
-  kernels: ["Python", "Julia", "R", "Bash"]
+  programming_languages: ["Python", "Julia", "R", "Bash"]
+  environments: []
   extensions: ["git","plotly","matplotlib"]
   proxy_apps: []
   install: true
   shared_folder: false
   persistent_storage: true
-  misc: ["Based on Jupyter Datascience Notebook image, extended with user-requested data science tools"]
+  misc: []
+technicals:
+  deployment: "Based on Jupyter Datascience Notebook image, extended with user-requested data science tools"
+  misc: []
 resources:
   default_server_user: 1
   max_server_user: 1

diff --git a/data/gwdg_hpc.yaml b/data/gwdg_hpc.yaml
@@ -5,21 +5,25 @@ support: [email protected]
 health_api_url: https://jupyter-hpc.gwdg.de/hub/api
 documentation_url: https://docs.gwdg.de/doku.php?id=en:services:application_services:jupyter:hpc
 target_group_open_for: Users with a full GWDG account (including people working in partner projects).
+restricted: true
 login_process: Login via LDAP
 features:
   version: JupyterHub 1.0.0, Notebook Server 6.0.3
-  kernels: ["Python", "R", "Bash"]
+  programming_languages: ["Python", "R", "Bash"]
+  environments: []
+  environments_info: ""
   extensions: ["ipyparallel"]
   proxy_apps: []
-  install:
+  install: false
   shared_folder: true
   persistent_storage: true
   misc:
     [
       "Own directory can be made writable for others.",
-      "Project directories are possible (POSIX group members can get acces).",
-      "Scratch file system (very fast), and Stornext (slower, for home file system)",
+      "Project directories are possible (POSIX group members can get access)."
     ]
+technicals:
+  misc: ["Scratch file system (very fast), and Stornext (slower, for home file system)"]
 resources:
   default_server_user: 1
   max_server_user: 1

diff --git a/data/hooks.py b/data/hooks.py
@@ -23,11 +23,25 @@ def generate_cards(*args, **kwargs):
                         logo = file_name.split("/")[-1][:-4]+"png"
                     else:
                         logo = "default-logo.png"
-
-                outfile.write("- title: %s\n"%d["title"])
+                url_requires = d.get("service_url_requirement", False)
+                if url_requires:
+                    service_url = "#"
+                    button_attr = ".md-button--disabled"
+                else:
+                    service_url = d["service_url"]
+                    button_attr = ".md-button .md-button--primary"
+                lock = ":material-lock:" if d.get("restricted", True) else ":material-lock-open-variant:"
+
+                outfile.write("- title: %s\n" % d["title"])
                 outfile.write("""  content: |
-    Provider: *%s*\n
+    Provider: *%s*
+    <p class=\"nt-card-text\">Target Group: %s</p>\n
     <div class=\"nfdi-card-link\">[:octicons-arrow-right-24: Service Details](details/%s.md)\n
-    [:material-lock: Login](%s){.md-button .md-button--primary}</div>\n"""%(d["provider"],service_name, d["service_url"]))
+    [%s Login](%s){%s}</div>\n""" % (d["provider"],
+                                     d["target_group_open_for"],
+                                     service_name,
+                                     lock,
+                                     service_url,
+                                     button_attr))
                 outfile.write("  image: assets/%s\n" % logo)
                 outfile.write("  icon: \":octicons-arrow-right-24:\"\n")
diff --git a/data/jupyter-jsc.fz-juelich.de.yaml b/data/jupyter-jsc.fz-juelich.de.yaml
@@ -5,16 +5,23 @@ support: [email protected]
 health_api_url: 
 documentation_url: https://docs.jupyter-jsc.fz-juelich.de
 target_group_open_for: HPC users of JSC. Helmholtz users in general
+restricted: true
 login_process: Login via JSC account or Helmholtz AAI
 features:
-  version: JupyterHub 2.3.1 JupyterLab 2.6,3.2,3.3,3.4
-  kernels: ["Bash", "Cling", "JavaScript", "Julia", "Octave", "R", "Ruby", "PyDeepLearning", "PyQuantum", "PyVisualization", "Custom"]
+  version: JupyterHub 2.3.1; JupyterLab 2.6,3.2,3.3,3.4
+  programming_languages: ["Bash", "Cling", "JavaScript", "Julia", "Octave", "R", "Ruby"]
+  environments: ["PyDeepLearning", "PyQuantum", "PyVisualization", "Custom"]
+  environments_info: "https://docs.jupyter-jsc.fz-juelich.de/github/FZJ-JSC/jupyter-jsc-notebooks/blob/documentation/02-Configuration/01-Kernels&Proxies.ipynb"
   extensions: ["Bokeh", "JupyterLab Preview", "JupyterLab Manager", "JupyterLab Sidecar", "JupyterLab Git", "JupyterLab server proxy", "JupyterLab toc", "JupyterLab lsp", "JupyterLab quickopen", "JupyterLab pyviz", "JupyterLab Code Formatter", "BQPlot", "Dask Labextension", "IPyVolume", "ITKWidgets", "Leaflet", "Matplotlib", "ThreeJS", "Vue", "Vuetify", "JuypterLab Control", "JupyterLab Dash", "JupyterLab Datawidgets", "JupyterLab GitLab", "JupyterLab Lmod", "JupyterLab plotly", "JupyterLab System Monitor", "JupyterLAb Theme Toggle", "JupyterLab topbar extension", "JupyterLab iframe", "nbdime", "plotlywidget", "pvlink", "Jupyter Slurm Provisioner", "NVDashboard"]
   proxy_apps: ["XPra"]
   install: true
   shared_folder: false
   persistent_storage: true
-  misc: ["Start on multiple (external) systems possible (including hpc). Resources depend highly on system", "2FA authentication available", "WebDAV connection possible", "SSL encryption between JupyterLab and JupyterHub"]
+  misc: ["Start on multiple (external) systems possible (including HPC). Resources depend highly on system",
+         "2FA authentication available",
+         "WebDAV connection possible"]
+technicals:
+  misc: ["SSL encryption between JupyterLab and JupyterHub"]
 resources:
   default_server_user: 1
   max_server_user: 100

diff --git a/data/kit-horeka.yaml b/data/kit-horeka.yaml
@@ -5,16 +5,23 @@ support: https://support.nhr.kit.edu
 health_api_url: 
 documentation_url: https://www.nhr.kit.edu/userdocs/jupyter
 target_group_open_for: Researchers, Users upon project application, Helmholtz users
+restricted: true
 login_process: Login through Home Organizations, Helmholtz AAI
 features:
   version: Jupyterhub 3.1.1, Jupyterlab 3.4.8
-  kernels: [Python, Julia, R]
+  programming_languages: [Python, Julia, R]
+  environments: []
   extensions: ["jupyterlab-lmod","dask-labextension", "jupyterlab-git", "jupyterlab-latex", "jupytext"]
   proxy_apps: ["jupyter-codeserver-proxy", "jupyter-desktop-server"]
   install: true
   shared_folder: true
   persistent_storage: true
-  misc: ["Available resources and apps may vary based on Cluster", "BEEGFS Filesystem can be mounted", "LSDF can be mounted", "User can install own python kernels", "Container integration via pyxis"]
+  misc: ["Available resources and apps may vary based on Cluster",
+         "User can install own python kernels"]
+technicals:
+  misc: ["BEEGFS Filesystem can be mounted",
+         "LSDF can be mounted",
+         "Container integration via pyxis"]
 resources:
   default_server_user: 1
   max_server_user: 1

diff --git a/data/mpcdf.yaml b/data/mpcdf.yaml
@@ -5,10 +5,12 @@ support: [email protected]
 health_api_url: 
 documentation_url: 
 target_group_open_for: Researchers of the Max Planck Society
+restricted: true
 login_process:
 features:
   version: JupyterHub 1.x (lab view)
-  kernels: ["Python", "Julia", "R"]
+  programming_languages: ["Python", "Julia", "R"]
+  environments: []
   extensions: []
   proxy_apps: []
   install: true

diff --git a/data/nfdi4ing.yaml b/data/nfdi4ing.yaml
@@ -5,28 +5,45 @@ support: [email protected]
 health_api_url: 
 documentation_url: 
 target_group_open_for: Researchers of NFDI4Ing
+restricted: true
 login_process: Login via Shibboleth (DFN-AAI & eduGAIN federation)
 features:
   version: JupyterHub 1.x (lab view)
-  kernels: ["Python", "Matlab", "Julia", "R"]
+  programming_languages: ["Python", "Matlab", "Julia", "R"]
+  environments: []
+  environments_info: ""
   extensions: []
   proxy_apps: ["Matlab IDE"]
   install: true
   shared_folder: false
   persistent_storage: true
   misc: ["WebDAV connection possible"]
+technicals:
+  platform: Linux Virtual Machine
+  deployment: Docker compose with pre-defined Jupyter Server images
+  login_attributes: ["pairwise-id", "displayName", "mail"]
+  hardware_location: "Stuttgart, Germany"
+  misc: []
 resources:
   default_server_user: 1
   max_server_user: 1
   default_cpu: 1
   max_cpu: 4
+  total_cpu: 40
+  burst_total_cpu: 40
   default_cpu_time: 1 h
   max_cpu_time: 72 h
   default_memory: 100 MB
   max_memory: 4 GB
+  total_memory: 32 GB
+  burst_total_memory: 32 GB
   default_gpu: 0
   max_gpu: 0
+  total_gpu: 0
+  burst_total_gpu: 0
   default_disk: 10 GB
   max_disk: 10 GB
   default_persistent_disk: 2 GB
   max_persistent_disk: 2 GB
+usage:
+  average_daily_sessions: 1
diff --git a/data/pc2-upb.yaml b/data/pc2-upb.yaml
@@ -1,20 +1,30 @@
 title: PC² JupyterHub
 provider: Paderborn Center for Parallel Computing, University of Paderborn
 service_url: https://jh.pc2.uni-paderborn.de
+service_url_requirement: VPN or on-site at the University of Paderborn
 support: [email protected]
 health_api_url: https://jh.pc2.uni-paderborn.de.de/hub/api/health
 documentation_url: https://pc2.uni-paderborn.de/go/jh
 target_group_open_for: All users of a computing time project at PC²
+restricted: true
 login_process: Login via LDAP
 features:
   version: JupyterHub 3.1.0, JupyterLab 3.6
-  kernels: ["Python", "Julia", "R"]
+  programming_languages: ["Python", "Julia", "R"]
+  environments: []
   extensions: ["jupyterlab-nvdashboard", "jupyterlab-lmod", "jupyterlab-desktop", "jupyterlab-plotly", "jupyterlab-pygments"]
   proxy_apps: ["Remote Desktop (noVNC)", "Full offered software on clusters with graphical interface (https://pc2.uni-paderborn.de/go/software)"]
   install: yes
   shared_folder: true
   persistent_storage: true
-  misc: ["Singularity integration (default + custom container)", "Pre-Set Environments", "Course functionality", "Remote Desktop with Slurm tools and module", "Remote Slurm kernel to start only kernels remote on cluster", "Direct connection of the cluster parallel filesystem", "User home directory for e.g. user-specific packages"]
+  misc: ["Pre-Set Environments",
+         "Course functionality",
+         "User home directory for e.g. user-specific packages"]
+technicals:
+  misc: ["Singularity integration (default + custom container)",
+         "Remote Desktop with Slurm tools and module",
+         "Remote Slurm kernel to start only kernels remote on cluster",
+         "Direct connection of the cluster parallel filesystem"]
 resources:
   default_server_user: 1
   max_server_user: 10
@@ -27,6 +37,6 @@ resources:
   default_gpu:
   max_gpu: 128
   default_disk:
-  max_disk: 6 PB temporary scratch data (requested on application)
+  max_disk: 6 PB
   default_persistent_disk:
-  max_persistent_disk: 185 TB permanent data (requested on application)
+  max_persistent_disk: 185 TB
diff --git a/data/template.yaml b/data/template.yaml
@@ -1,32 +1,53 @@
 title: 
 provider: 
-service_url: 
+service_url:
+service_url_requirement:
 support: 
 health_api_url: 
 documentation_url: 
-target_group_open_for: 
-login_process: 
+target_group_open_for:
+restricted:
+login_process:
 features:
   version: 
-  kernels: []
+  programming_languages: []
+  environments: []
+  environments_info:
   extensions: []
   proxy_apps: []
   install: 
   shared_folder:
   persistent_storage:
   misc: []
+technicals:
+  platform:
+  deployment:
+  deployment_url:
+  login_attributes: []
+  hardware_location:
+  misc: []
 resources:
   default_server_user: 
   max_server_user: 
   default_cpu: 
-  max_cpu: 
+  max_cpu:
+  total_cpu:
+  burst_total_cpu:
   default_cpu_time:
   max_cpu_time:
   default_memory:
   max_memory:
+  total_memory:
+  burst_total_memory:
   default_gpu:
   max_gpu:
+  total_gpu:
+  burst_total_gpu:
   default_disk:
   max_disk:
   default_persistent_disk:
   max_persistent_disk:
+  total_disk:
+  burst_total_disk:
+usage:
+  average_daily_sessions:
diff --git a/data/uni-leipzig.yaml b/data/uni-leipzig.yaml
@@ -1,14 +1,18 @@
 title: Webbasiertes Data Science und Machine Learning mit Jupyter
 provider: University of Leipzig
 service_url: https://lab.sc.uni-leipzig.de
+service_url_requirement: VPN or on-site at Leipzig University
 support: [email protected]
 health_api_url: 
 documentation_url: https://www.sc.uni-leipzig.de, https://www.urz.uni-leipzig.de/unsere-services/servicedetail/service/webbasiertes-data-science-und-machine-learning-mit-jupyter
 target_group_open_for: Students and employees of University of Leipzig
+restricted: true
 login_process: Login via SC account
 features:
-  version: JupyterHub 3.1.0, JupyterLab 3.5.3
-  kernels: ["Python 3.11", "Python 3.9 OpenCV 4.7", "Python 3.9 PyTorch 1.10", "Python 3.9 TensorFlow 2.6.2", "SageMath 10.0", "R 4.2.2", "Julia 1.8.5"]
+  version: JupyterHub 3.1.0; JupyterLab 3.5.3
+  programming_languages: ["Python 3.11", "SageMath 10.0", "R 4.2.2", "Julia 1.8.5"]
+  environments: ["Python 3.9 OpenCV 4.7", "Python 3.9 PyTorch 1.10", "Python 3.9 TensorFlow 2.6.2"]
+  environments_info: ""
   extensions: ["server-proxy", "jupyterlab-manager", "webio-jupyterlab-provider", "jupyterlab_pygments", "jupyterlab_lmod"]
   proxy_apps: []
   install: true