update scow tutorial; add revision date

chenggroup · Oct 24, 2024 · 56211a2 · 56211a2
1 parent bc1b905
commit 56211a2
Show file tree

Hide file tree

Showing 23 changed files with 48 additions and 13 deletions.
diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml
@@ -15,5 +15,6 @@ jobs:
       - run: pip install \
               mkdocs-material>=9.5.0 \
               mkdocs-macros-plugin \
-              mkdocs-static-i18n[material]
+              mkdocs-static-i18n[material] \
+              mkdocs-git-revision-date-localized-plugin
       - run: mkdocs gh-deploy --force
diff --git a/docs/images/25e6661f60f6b1605b9ca0057ffcf525_MD5.jpeg b/docs/images/25e6661f60f6b1605b9ca0057ffcf525_MD5.jpeg
diff --git a/docs/images/607cb8517831172490594e89bdab5512_MD5.jpeg b/docs/images/607cb8517831172490594e89bdab5512_MD5.jpeg
diff --git a/docs/images/scow/image1.png b/docs/images/scow/image1.png
diff --git a/docs/images/scow/image10.png b/docs/images/scow/image10.png
diff --git a/docs/images/scow/image11.png b/docs/images/scow/image11.png
diff --git a/docs/images/scow/image12.png b/docs/images/scow/image12.png
diff --git a/docs/images/scow/image13.png b/docs/images/scow/image13.png
diff --git a/docs/images/scow/image14.png b/docs/images/scow/image14.png
diff --git a/docs/images/scow/image15.png b/docs/images/scow/image15.png
diff --git a/docs/images/scow/image16.png b/docs/images/scow/image16.png
diff --git a/docs/images/scow/image2.png b/docs/images/scow/image2.png
diff --git a/docs/images/scow/image3.png b/docs/images/scow/image3.png
diff --git a/docs/images/scow/image4.png b/docs/images/scow/image4.png
diff --git a/docs/images/scow/image5.png b/docs/images/scow/image5.png
diff --git a/docs/images/scow/image6.png b/docs/images/scow/image6.png
diff --git a/docs/images/scow/image7.png b/docs/images/scow/image7.png
diff --git a/docs/images/scow/image8.png b/docs/images/scow/image8.png
diff --git a/docs/images/scow/image9.png b/docs/images/scow/image9.png
diff --git a/docs/wiki/cluster_usage/conda.md b/docs/wiki/cluster_usage/conda.md
@@ -3,19 +3,19 @@ title: Anaconda
 authors: Yongbin Zhuang
 comments: true
 ---
-
 # Anaconda 使用指南
 
 ## 初始化设定
+
 登录 HPC
 
 ```bash
 module load miniconda/3
 conda init bash
 ```
-这会自动修饰你的`~/.bashrc`文件
-登出HPC，再次登陆
+这会自动修饰你的 `~/.bashrc` 文件。
 
+登出HPC，再次登陆
 
 打开你的~/.condarc文件
 
@@ -40,6 +40,7 @@ pkgs_dirs:
 退出文件
 
 通过以下命令确认你的环境
+
 ```bash
 conda env list
 ```
@@ -74,6 +75,6 @@ conda config --set env_prompt '({name})'
 
 [参考文献](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html)
 
-## 使用 Jupyter Notebook
+## 在集群上使用 Jupyter Notebook
 
-请参考 [Open Ondemand使用说明](./open_ondemand.md)。
+请参见 [OpenSCOW/Open Ondemand使用说明](./open_ondemand.md)。
diff --git a/docs/wiki/cluster_usage/open_ondemand.md b/docs/wiki/cluster_usage/open_ondemand.md
@@ -3,10 +3,10 @@ Title: OpenSCOW/Open Ondemand 使用说明
 Authors: Weihong Xu
 comments: true
 ---
-
 # OpenSCOW/Open Ondemand 使用说明
 
 ## 介绍
+
 为方便在HPC集群上执行一些交互类应用，我们在 ChengLab HPC 集群的 `mgt02` 节点部署了
 OpenSCOW 超算门户和 Open Ondemand (OOD) 实例。使用该服务可参考以下步骤。
 
@@ -23,11 +23,44 @@ OpenSCOW 超算门户和 Open Ondemand (OOD) 实例。使用该服务可参考
 
 ## OpenSCOW
 
-该实例包含一套交互式作业提交入口和Jupyter、VSCode应用入口，未来可根据需要部署更多应用。
+该实例包含一套交互式作业提交入口和 Jupyter、VS Code 应用入口，未来可根据需要部署更多应用。
 
 请在内网访问 [http://172.27.127.191:8081](http://172.27.127.191:8081) 即可使用，注意用户名和密码参照上方的指引配置。
 
-详细的使用说明请参考[官方文档](https://pkuhpc.github.io/OpenSCOW/docs/info)。
+> 以下部分引用自嘉庚智算用户手册
+
+### 主界面介绍
+
+- 仪表盘：分为两个部分，快捷入口和平台概览
+- 快捷入口点击后面的+号可以自定义需要导入的模块，例如可以添加按钮快速在集群上提交 VSCode 作业
+   ![快捷入口](../../images/scow/image4.png)
+- 网页端可提交作业至集群
+  - 进入 SCOW 平台后，点击提交作业
+    ![提交作业](../../images/scow/image5.png)
+  - 需填写命令、分区、QOS、节点数、单节点核心数、最长运行时间，确认无误后可点击下面提交按钮（也可以提交时选择保存为模板，方便同类型作业提交）
+    ![作业参数](../../images/scow/image6.png)
+- 如没有报错，提交后会跳转到未结束的作业模块（可以同时选上作业模板，方便同类型作业提交），提交成功和作业ID
+    ![作业管理](../../images/scow/image7.png)
+- 点击作业中的进入目录，可以看到作业标准/错误输出文件，支持下载、重命名、删除、提交
+    ![作业详情](../../images/scow/image8.png)
+- 集群命令行界面登录：从 Shell 模块中可进入到命令行界面
+    ![命令行入口](../../images/scow/image9.png)
+    ![命令行界面](../../images/scow/image10.png)
+- 作业模板：可保存之前提交过的作业脚本
+    ![作业模板](../../images/scow/image11.png)
+- 支持查看本用户所有历史作业，可按批量搜索（按集群）、精确搜索（按集群+作业 ID）
+    ![历史作业](../../images/scow/image12.png)
+- 平台概览：包括集群 CPU、GPU 空闲可用节点，作业排队情况等
+    ![平台概览](../../images/scow/image13.png)
+- 交互式应用模块
+  - 用户可以在此使用平台提供的交互式应用，并提交到集群作业管理系统上，如 Jupyter、 VS Code 等。
+		![](../../images/25e6661f60f6b1605b9ca0057ffcf525_MD5.jpeg)
+ - 例如提交 Jupyter Lab 作业，则点击上图中 JupyterLab 的按钮，然后配置所需的作业参数
+		![](../../images/607cb8517831172490594e89bdab5512_MD5.jpeg)
+	如图所示，这种情况则用户提交作业，在自己用户下的 `local` 环境中创建 Jupyter 作业，并在加载 conda 环境前加载 `cuda/11.8` 环境。该作业将被提交到 `gpu3` 队列中，使用 `normal` 优先级，申请 1 个节点上 4 个 CPU 核及 1 张 GPU 卡，申请 8 GB 内存资源。 
+- 文件管理模块：在网页端可以对自己目录下的文件进行增删改
+	![文件管理](../../images/scow/image15.png)
+更详细的使用说明请参考[官方文档](https://pkuhpc.github.io/OpenSCOW/docs/info)。
 
 ## Open Ondemand
 
@@ -56,7 +89,7 @@ Host cheng-hpc
 
 #### Jupyter
 
-为正常使用Jupyter, 需要在集群中通过conda进行安装，如果已有可忽略。具体步骤如下：
+为正常使用 Jupyter, 需要在集群中通过 conda 进行安装，如果已有可忽略。具体步骤如下：
 
 - 登录 `login01` or `mgt02`
 - `module load miniconda/3` 
@@ -65,9 +98,9 @@ Host cheng-hpc
 - `source activate <env>` # 载入刚刚安装的环境
 - `pip install nbconvert==6.4.3` # workaound 一个bug... 未来或可不用
 
-通过界面上的 Interactive Apps => Jupyter 即可打开启动界面。里面多数选项可保持默认，唯一需要填写的是 Jupyter所在的conda环境（默认为base, 如Jupyter位于其它环境请选择其它文件名），以及用户名（填写登录用户名即可）。
+通过界面上的 Interactive Apps => Jupyter 即可打开启动界面。里面多数选项可保持默认，唯一需要填写的是 Jupyter 所在的 conda 环境（默认为 `base`, 如 Jupyter 位于其它环境请选择其它文件名），以及用户名（填写登录用户名即可）。
 
-提交作业后会进入Session界面，在该界面可以看到提交作业的状态。当启动完毕后会出现connect to jupyter，点击即可使用。
+提交作业后会进入 Session 界面，在该界面可以看到提交作业的状态。当启动完毕后会出现 `connect to jupyter` ，点击即可使用。
 
 ## 常用技巧
 

diff --git a/docs/wiki/cluster_usage/ssh_note.md b/docs/wiki/cluster_usage/ssh_note.md
@@ -4,7 +4,6 @@ authors: 庄永斌
 priority: 1.02
 comments: true
 ---
-
 # SSH 使用入门
 
 *此入门仅介绍一些作者认为必要且实用的功能，完善的帮助手册可以通过命令，`man ssh_config`, `man ssh`查看* 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -78,6 +78,7 @@ plugins:
                 toggle:
                   icon: material/lightbulb-outline
                   name: Switch to automatic mode
+  - git-revision-date-localized
 
 theme:
   name: material