diff --git a/readme.md b/readme.md index ea6f994..a2e6566 100644 --- a/readme.md +++ b/readme.md @@ -1,124 +1,126 @@ -# SWdata-texttoCAD - -本仓库用于存放行星减速器关节模组的 SolidWorks 源文件数据集,方便后续用于 Text-to-CAD 相关研究。 - -## 📁 目录结构 - -所有模组文件统一放在 `1_行星关节模组/` 下,按传动类型和级数分类存放: - -```text -1_行星关节模组/ -├── 1.1_NGW/ # NGW 型行星减速器 -│ ├── 1.1.1_一级/ # 单级减速 -│ │ └── [模组文件夹]/ -│ └── 1.1.2_二级/ # 两级减速 -│ └── [模组文件夹]/ -├── 1.2_NW/ # NW 型行星减速器 -│ ├── 1.2.1_一级/ -│ │ └── [模组文件夹]/ -│ └── 1.2.2_二级/ -│ └── [模组文件夹]/ -├── 1.3_WW/ # WW 型行星减速器 -│ ├── 1.3.1_一级/ -│ │ └── [模组文件夹]/ -│ └── 1.3.2_二级/ -│ └── [模组文件夹]/ -└── 1.4_NGWN/ # NGWN 型行星减速器 - ├── 1.4.1_一级/ - │ └── [模组文件夹]/ - └── 1.4.2_二级/ - └── [模组文件夹]/ -``` - -## 📤 上传文件指引(给上传者) - -### 第一步:确定你的模组属于哪一类 - -- 看你的减速器有没有**固定内齿圈**、输出端是不是**行星架** → 是的话就是 **NGW** -- 如果不确定属于 NGW / NW / WW / NGWN 中的哪一种,先确认清楚再放 -- 传动级数:一组行星轮系算一级,两组串联算两级 - -### 第二步:创建模组文件夹 - -在对应的分类文件夹下(例如 `1.1.2_二级/`),新建一个文件夹,**文件夹名建议按以下格式**: - -```text -PJ_NGW_S2_090_T80_001 -``` - -字段说明(供参考,不强求完全一致): - -| 字段 | 含义 | 示例 | -|------|------|------| -| PJ | 行星关节模组(固定前缀) | PJ | -| NGW | 传动型式 | NGW / NW / WW / NGWN | -| S2 | 级数 | S1 / S2| -| 090 | 外径档(mm) | 060 / 070 / 090 / 110 | -| T80 | 扭矩档(N·m) | T80 | -| 001 | 同规格序号 | 001 / 002 | - -### 第三步:放入文件 - -每个模组文件夹内建议包含以下内容: - -```text -PJ_NGW_S2_090_T80_001/ -├── 装配/ -│ └── (总装文件).sldasm -├── 零件/ -│ └── *.sldprt -├── 导出/ -│ ├── (总装文件).step -│ └── 零件/ -│ └── *.step -├── 清单/ -│ ├── 零件清单.xlsx -│ └── 配合说明.txt -└── 模组信息表.xlsx -``` - -**要求:** - -- 总装文件、零件文件请使用英文或数字命名,避免特殊符号 -- 每个自制件均需导出 STEP 文件 -- 标准件(轴承、螺钉等)不强制建实体模型,但需在零件清单中写明型号、数量 -- `模组信息表.xlsx` 至少包含:模组编号、传动类型、级数、减速比、额定扭矩、质量、设计说明 - -## 📥 下载指引(给下载者) - -根据你需要的模组类型,进入对应文件夹下载即可: - -| 你想要的 | 去这里找 | -|----------|----------| -| NGW 单级减速器 | `1_行星关节模组/1.1_NGW/1.1.1_一级/` | -| NGW 两级减速器 | `1_行星关节模组/1.1_NGW/1.1.2_二级/` | -| NW 单级减速器 | `1_行星关节模组/1.2_NW/1.2.1_一级/` | -| NW 两级减速器 | `1_行星关节模组/1.2_NW/1.2.2_二级/` | -| WW 单级减速器 | `1_行星关节模组/1.3_WW/1.3.1_一级/` | -| WW 两级减速器 | `1_行星关节模组/1.3_WW/1.3.2_二级/` | -| NGWN 单级减速器 | `1_行星关节模组/1.4_NGWN/1.4.1_一级/` | -| NGWN 两级减速器 | `1_行星关节模组/1.4_NGWN/1.4.2_二级/` | - -每个模组文件夹内都包含完整的 SW 源文件、STEP 文件、零件清单和模组信息表,下载后可直接使用。 - -## 📋 文件名与角色参考 - -零件清单中建议使用以下角色名(中英文均可,但同一模组内保持一致): - -| 角色 | 说明 | -|------|------| -| sun_gear | 太阳轮 | -| planet_gear | 行星轮 | -| ring_gear | 内齿圈 | -| carrier | 行星架 | -| carrier_pin | 行星轴/销 | -| input_shaft | 输入轴 | -| output_flange | 输出法兰 | -| gear_housing | 减速器壳体 | -| motor_housing | 电机壳(一体模组时使用) | -| bearing_seat | 轴承座 | -| seal_cover | 密封盖 | - -两级模组如有两套太阳轮/行星架,建议在文件名或备注中加 `_L1`、`_L2` 区分一级和二级。 - - +# SWdata-texttoCAD + +本仓库用于存放行星减速器关节模组的 SolidWorks 源文件数据集,方便后续用于 Text-to-CAD 相关研究。 + +## 📁 目录结构 + +所有模组文件统一放在 `1_行星关节模组/` 下,按传动类型和级数分类存放: + +```text +1_行星关节模组/ +├── 1.1_NGW/ # NGW 型行星减速器 +│ ├── 1.1.1_一级/ # 单级减速 +│ │ └── [模组文件夹]/ +│ └── 1.1.2_二级/ # 两级减速 +│ └── [模组文件夹]/ +├── 1.2_NW/ # NW 型行星减速器 +│ ├── 1.2.1_一级/ +│ │ └── [模组文件夹]/ +│ └── 1.2.2_二级/ +│ └── [模组文件夹]/ +├── 1.3_WW/ # WW 型行星减速器 +│ ├── 1.3.1_一级/ +│ │ └── [模组文件夹]/ +│ └── 1.3.2_二级/ +│ └── [模组文件夹]/ +└── 1.4_NGWN/ # NGWN 型行星减速器 + ├── 1.4.1_一级/ + │ └── [模组文件夹]/ + └── 1.4.2_二级/ + └── [模组文件夹]/ +``` + +## 📤 上传文件指引(给上传者) + +### 第一步:确定你的模组属于哪一类 + +- 看你的减速器有没有**固定内齿圈**、输出端是不是**行星架** → 是的话就是 **NGW** +- 如果不确定属于 NGW / NW / WW / NGWN 中的哪一种,先确认清楚再放 +- 传动级数:一组行星轮系算一级,两组串联算两级 + +### 第二步:创建模组文件夹 + +在对应的分类文件夹下(例如 `1.1.2_二级/`),新建一个文件夹,**文件夹名建议按以下格式**: + +```text +PJ_NGW_S2_090_T80_001 +``` + +字段说明(供参考,不强求完全一致): + +| 字段 | 含义 | 示例 | +|------|------|------| +| PJ | 行星关节模组(固定前缀) | PJ | +| NGW | 传动型式 | NGW / NW / WW / NGWN | +| S2 | 级数 | S1 / S2| +| 090 | 外径档(mm) | 060 / 070 / 090 / 110 | +| T80 | 扭矩档(N·m) | T80 | +| 001 | 同规格序号 | 001 / 002 | + +### 第三步:放入文件 + +每个模组文件夹内建议包含以下内容: + +```text +PJ_NGW_S2_090_T80_001/ +├── 装配/ +│ └── (总装文件).sldasm +├── 零件/ +│ └── *.sldprt +├── 导出/ +│ ├── (总装文件).step +│ └── 零件/ +│ └── *.step +├── 清单/ +│ ├── 零件清单.xlsx +│ └── 配合说明.txt +├── 模组信息表.xlsx +├── joint_module_assembly.schema.json #schema文件 +└── planetary joint_full.example.json #sop文件 +``` + +**要求:** + +- 总装文件、零件文件请使用英文或数字命名,避免特殊符号 +- 每个自制件均需导出 STEP 文件 +- 标准件(轴承、螺钉等)不强制建实体模型,但需在零件清单中写明型号、数量 +- `模组信息表.xlsx` 至少包含:模组编号、传动类型、级数、减速比、额定扭矩、质量、设计说明 + +## 📥 下载指引(给下载者) + +根据你需要的模组类型,进入对应文件夹下载即可: + +| 你想要的 | 去这里找 | +|----------|----------| +| NGW 单级减速器 | `1_行星关节模组/1.1_NGW/1.1.1_一级/` | +| NGW 两级减速器 | `1_行星关节模组/1.1_NGW/1.1.2_二级/` | +| NW 单级减速器 | `1_行星关节模组/1.2_NW/1.2.1_一级/` | +| NW 两级减速器 | `1_行星关节模组/1.2_NW/1.2.2_二级/` | +| WW 单级减速器 | `1_行星关节模组/1.3_WW/1.3.1_一级/` | +| WW 两级减速器 | `1_行星关节模组/1.3_WW/1.3.2_二级/` | +| NGWN 单级减速器 | `1_行星关节模组/1.4_NGWN/1.4.1_一级/` | +| NGWN 两级减速器 | `1_行星关节模组/1.4_NGWN/1.4.2_二级/` | + +每个模组文件夹内都包含完整的 SW 源文件、STEP 文件、零件清单和模组信息表,下载后可直接使用。 + +## 📋 文件名与角色参考 + +零件清单中建议使用以下角色名(中英文均可,但同一模组内保持一致): + +| 角色 | 说明 | +|------|------| +| sun_gear | 太阳轮 | +| planet_gear | 行星轮 | +| ring_gear | 内齿圈 | +| carrier | 行星架 | +| carrier_pin | 行星轴/销 | +| input_shaft | 输入轴 | +| output_flange | 输出法兰 | +| gear_housing | 减速器壳体 | +| motor_housing | 电机壳(一体模组时使用) | +| bearing_seat | 轴承座 | +| seal_cover | 密封盖 | + +两级模组如有两套太阳轮/行星架,建议在文件名或备注中加 `_L1`、`_L2` 区分一级和二级。 + +