Dev

.readthedocs.yaml

@@ -0,0 +1,34 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.9"
+    # You can also specify other tool versions:
+    # nodejs: "16"
+    # rust: "1.55"
+    # golang: "1.17"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py
+
+# If using Sphinx, optionally build your docs in additional formats such as PDF
+# formats:
+#    - pdf
+
+# Optionally declare the Python requirements required to build your docs
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - doc
+
+formats: all

README.md

@@ -1,10 +1,10 @@
-# Lumache
+# 神工坊高性能仿真平台
 
-![Lumache logo](lumache-logo.png)
+![Lumache logo](simforge-logo.png)
 
-**Lumache** (/lu'make/) is a Python library for cooks and food lovers
+<!-- **Lumache** (/lu'make/) is a Python library for cooks and food lovers
 that creates recipes mixing random ingredients.
 
 [![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-908a85?logo=gitpod)](https://gitpod.io/#https://github.com/readthedocs/tutorial-sphinx-markdown-library)
 
-_(Example library used in the ["Document your project with Markdown, Sphinx, and Read the Docs"](https://github.com/readthedocs/tutorial-sphinx-markdown) tutorial)_
+_(Example library used in the ["Document your project with Markdown, Sphinx, and Read the Docs"](https://github.com/readthedocs/tutorial-sphinx-markdown) tutorial)_ -->

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/FAQ.md

@@ -0,0 +1,102 @@
+# 第6章 FAQ
+## 图形相关
+
+### VNC和VDI有什么区别？
+
+- VDI：虚拟远程桌面接口
+
+- VNC：虚拟网络控制台
+
+|  图形界面   | 额外操作  | 是否额外付费 |  性能 |
+|  :----:  | :----:  |  :----:  |  :----:  | 
+| VDI  | 开通远程桌面|是 | 高 |
+| VNC  | 无需额外步骤 | 否 | 一般 |
+
+{ref}`仿真计算的GUI模式`和**图形应用**均可使用上述两种方式提交。
+
+### 如何使平台界面进入全屏模式？
+
+右键点击平台界面的空白处，进入全屏模式
+
+![全屏](figs/faq/quanping.png)
+
+### VNC模式启动图形作业，软件窗口最小化后，或者存在多个窗口，如何切换选择？
+
+鼠标中键，根据窗口名称单击选择，可切换出对应窗口
+
+### VNC模式启动图形作业，VNC窗口关闭或60分钟后重新进入平台，如何重新进入VNC窗口？
+
+点击作业管理![](figs/fre/work_mgt.png)，找到对应的图形作业，单击作业号进入作业详情，在该作业的详情页面右上角单击**图形窗口**或通过作业管理作业号右边小图标![](figs/web.png)即可重新进入。
+
+![](figs/warn.png) **警告** 
+不必要的VNC作业进程注意及时关闭，以免造成队列资源浪费和费用损失
+
+### VDI模式启动图形作业，软件窗口最小化后，该如何恢复？
+
+解锁底部dock栏![](figs/fre/unlock.png)，单击软件的窗口即可。
+
+### 如何切换图形应用的运行模式？
+
+已有实例，右击图标，选择默认实例，即可切换；若无对应实例，新建实例，设置图形应用以VNC或VDI模式启动。参考{ref}`配置实例`。
+
+## 数据管理
+### 文件、目录命名有什么要求？
+
+- 文件、目录的命名不要带特殊字符（**包括空格**），可能会影响软件运行。建议使用A1_B2这样的命名方式。
+- 文件命名字符长度不可以超过30个字符
+
+### 如何在线编辑文件？
+
+在线编辑文件有两种方式：一是通过数据管理，右击进行文本编辑；二是对于一些特殊后缀的文件，可开通VDI，通过shell 命令进行查看编辑。
+
+### 上传文件速度慢？
+
+可通过ftp公网上传
+
+1. 使用任意客户端（FileZilla、WinScp、Xftp等）
+2. 网络连接地址：ftp.hpc.simforge.cn
+3. 网络连接端口：21
+4. 连接用户名：神工坊账号、密码
+*注1：FileZilla下载地址：https://www.filezilla.cn/download*
+*注1：WinScp下载地址:https://winscp.net/eng/download.php*
+
+## 作业管理
+
+### 作业被系统强制终止
+
+请确认作业提交时是否设置了运行时限。
+
+### 重新进入门户后，运行的作业不在作业管理器首页？
+点击作业管理![](figs/fre/work_mgt.png)，将显示条数增加以增加排序范围。
+
+![](figs/faq/shaixuan.png)
+
+之后根据需要点击排序功能，如“状态”。
+
+![](figs/faq/shaixuan2.png)
+
+## 资源管理
+### 队列的分类?
+
+队列一般分为：
+- CPU计算节点：如q_x86_sf
+- GPU渲染节点：如GPU_sf
+
+![](figs/warn.png)**警告** 请不要在使用**仿真计算**应用时提交至**GPU渲染队列**，作业将被管理员杀掉。
+
+![](figs/warn.png)**警告** 请不要在使用**图形应用**时提交至**CPU计算队列**，作业将被管理员杀掉。
+
+### 什么是远程队列？
+
+远程队列是相较于本地队列而言的。神工坊2.0平台**可调取的资源不局限于本地集群**，也包含无锡超算甚至其他超算背后的海量资源。某些应用部署在其他集群，统一称为远程应用，提交作业时需要使用对应的远程队列。
+
+例如：使用应用**Abaqus614-u**时，队列选择下拉框中的q_x86_sf即为本地队列，q_intel_share、q_x86_share即为远程队列，您可根据需求选择所用的队列。具体队列资源介绍见{ref}`平台队列资源`
+
+## 计费相关
+
+### 体验金和余额什么关系？
+
+- 体验金是平台赠送金额，余额是用户自己充值的金额。扣款时，会优先扣除体验金，之后扣除余额。当全部扣除完毕时，48小时内平台只会对用户进行提醒。超过48小时，用户的作业和虚拟机桌面会被关闭。
+- 在平台界面的右上角点击![人](figs/faq/people.png)，选择【余额管理】可查看相关信息。
+
+![余额管理](figs/faq/trial_fee.png)

docs/source/chapter_one.md

@@ -0,0 +1,68 @@
+# 第1章 简介
+
+##  文档概述
+
+<!-- <div id="GUI_app"></div>
+
+<span id="jump">跳转到的地方</span> -->
+
+本文档提供了有关如何使用”神工坊“高性能仿真平台V2.0用户门户的指导。
+
+本文档是为需要使用”神工坊“高性能仿真平台V2.0用户门户的人员编写的。本文档的目标读者为工业制造等领域的仿真工程师。
+
+
+## 符号约定
+
+本文档使用如下符号约定：
+
+![](figs/warn.png) **警告** 提醒您要小心，以避免误操作导致设备损坏或数据丢失。
+
+![](figs/notice.png) **注意** 强调关键点或提供更多信息，如操作限制、最佳实践或帮助性的建议或参考，作为对正文的补充。
+
+![](figs/hint.png)**提示** 表示以下信息将帮助您解决某个问题或节省您的时间
+
+## “神工坊”高性能仿真平台V2.0介绍
+
+“神工坊”高性能仿真平台是专为工业制造领域提供高性能工业仿真和仿真软件开发服务在线平台。平台以国家超级计算无锡中心丰富的软件资源和海量的硬件资源为支撑，为用户提供了一个本地“PC”式体验的高性能仿真平台，平台基于高效、低延迟远程传输协议和GPU渲染等方式，给用户提供流畅、清晰的工业仿真软件原生界面操作体验的同时，保留了超算强大算力的支撑。另外，平台支持多级用户管理功能，方便企业整体入驻，为企业提供多级部门管理、在线共享空间、在线分享图形界面等功能，助力企业在线协同研发，提高设计研发效率。
+面向开发用户，平台提供自研软件在线编译、运行服务，并支持自研软件发布至平台应用商城，供平台其他用户订阅使用，并能获取用户使用反馈，协助软件迭代升级。
+
+## 概念及术语
+在您开始使用”神工坊“高性能仿真平台V2.0用户门户前，请先了解下表中所描述的概念和术语。
+
+<center>表 1-1 “神工坊“高性能仿真平台V2.0用户门户 概念和术语</center>
+
+| 概念     | 描述 |
+|  :-------:        | :----:  |
+| 主机（host） | 集群中提供计算资源的实体，作业在其上被提交或执行。 |
+| 提交主机（Submission host） | 作业在其上被提交的主机。 |
+| 运行主机（Execution host） | 执行作业的主机。 |
+| 作业（Job） | 按照应用实例提交至神工坊应用空间的一组命令。可占用一至多个Job slot。 |
+| 作业槽（Job slot） | 神工坊平台中处理器分配的最小单元。可以是一至多个物理处理器或物理处理器的一部分。默认情况下，一个job slot就是一个处理器核。 |
+| 队列（Queue） | 网络范围内的一个存放作业的地方，负责对不同作业实施调度及管理调度策略。 |
+| 项目（Project） | 网络范围内的一个存放作业的地方，负责对不同作业实施调度及管理调度策略。 | 资源池（Resources Pool） | 管理员可对多种不同调度器的资源池进行统一管理。|
+| 密级（secret_level） | 系统设置针对项目，作业，用户设置的安全等级。|
+| 应用实例 | 应用实例可以将用户的参数存储为实例，用户切换应用实例完成应用资源选择。|
+
+## 平台队列资源
+
+以下是目前神工坊2.0平台已经接入的硬件资源（更新时间2024.0625）：
+| 名称         |  队列类型|所在集群 |    型号规格          |    集群资源 |
+|:-------:      |:-------:     | :----:    | :----:           |:----:      |  
+| q_x86_sfexper | CPU计算队列| 本地AMD集群| AMD EPYC 7H12/7742  |     1\*128\*512G    |
+| q_x86_sf      |CPU计算队列 |本地AMD集群| AMD EPYC 7H12/7742|     8\*128\*512G   |
+|  GPU_sf       | GPU图形队列|本地集群| nvidia Quadro P400 |   1\*64\*128G     |
+|  GPU_RTX      |  GPU图形队列 |本地集群| nvidia Quadro RTX 4000|    1\*40\*512G    |
+| q_x86_share   |CPU计算队列 | 远程Intel集群| Intel(R) Xeon(R) CPU E5-2680 v3 |    766\*24\*128G    |
+| q_x86_cn_sim  |CPU计算队列 | 远程Intel集群| Intel(R) Xeon(R) CPU E5-2680 v3 |    5\*24\*128G    |
+| q_amd_share   |CPU计算队列 | 远程AMD集群  | AMD EPYC 7H12| 500\*128\*256G    |
+| q_intel_share |CPU计算队列 | 远程Intel集群 | Intel Xeon 8358| 60\*64\*256G      |
+| wzhcnormal |CPU计算队列 | 远程Hygon集群 | Hygon 7285 | 1561\*64\*256G   |
+
+![no](figs/notice.png) **注意** :
+
+1. 远程队列目前仅支持非图形界面方式提交，本地集群支持图形化作业
+2. 仿真计算应用需使用到CPU队列，图形应用需使用到GPU队列
+3. 集群资源格式为：节点数\*每节点核数\*每节点内存大小
+
+![warn](figs/warn.png) **警告**
+不必要的作业进程注意及时关闭，以免造成队列资源浪费和费用损失