GdiSDK

目录

  • 概述 (Overview)
    • GdiSDK是什么？
    • 设计理念
    • 核心架构
      • 数据层 (DataClass)
      • 处理层 (Modules)
      • 应用层 (Pipeline)
      • 交互层 (GDIM)
    • 应用场景
      • 通用应用场景
      • 专业应用场景
    • 技术特性
      • 现代化技术栈
      • 开发友好
    • 获取支持
  • 新手入门 (Getting Started)
    • 为什么使用GdiSDK？
      • 专业鸿沟问题
      • 数据质量挑战
      • GdiSDK的技术优势
    • 安装和环境搭建
      • 系统要求
      • 安装Python环境
      • 创建虚拟环境
      • 安装GdiSDK
      • 配置开发环境
      • 注册GDIM账户
    • 入门案例
      • 案例一：提取钻孔一览表数据
      • 案例二：写入钻孔一览表至GDIM
      • 案例三：生成钻孔一览表报告
    • 下一步
  • AI辅助开发 (Code Agent)
    • 什么是 AI IDE？
    • 什么是 Skills？
    • 为什么推荐使用 gdisdk-skills？
    • gdisdk-skills 仓库
    • 安装 Skills
      • 安装前提
      • 项目内安装（推荐）
      • 全局安装
      • 安装后验证
    • llms.txt（文档索引）
    • Skill 详解
      • gdim-app-*：按应用类型生成 Pipeline 脚本
      • local-function-coder：编写 PythonCoder 本地函数
      • pipeline-organizer：整理 Pipeline 目录
      • pipeline-gdim-review：上传前兼容性检查
    • 推荐开发工作流
    • 参考资料
  • 用户指南 (User Guide)
    • 什么是GDIM？
    • 什么是工作流 (Pipeline)？
    • 什么是模块 (Module)？
    • 端口类型与核心数据结构
    • 创建一个Pipeline
    • 理解Pipeline机制
    • 如何定义Pipeline的UI交互
      • 自动绑定属性（auto_bind）
        • 从地图 POI 注入（poi_field）
        • 子表按主键更新（pk_field）
    • GDIM数据更新（自定义数据更新配置）
    • 如何上传Pipeline至GDIM
    • 如何创建一个PythonCoder
    • 如何创建一个自定义模块
    • 如何定义模块的UI交互
  • 工作流构建 (Pipeline Build)
    • 开始前确认需求
    • 选择 gdi 或 gdisdk
    • 核对 GDIM 表名与字段
    • 查找模块
      • 没有合适模块时
    • 步骤 1：创建 PipeLine 与 workspace
    • 步骤 2：配置 GDIM 状态
    • 步骤 3：实例化与配置模块
    • 步骤 4：连接端口
    • 步骤 5：暴露 Pipeline 属性
    • 步骤 6：设置返回结果
    • 步骤 7：保存 .pipe
    • 步骤 8：本地测试（用户要求时）
      • 加载已保存的 .pipe
    • 完整示例
    • 常见错误
    • 与其它文档的关系
  • GDIM应用类型 (App Types)
    • GDIM数据更新 (Data Update)
      • 适用场景
      • 平台如何运行
      • 推荐拓扑
      • 预览字段与墓碑行（前端写入 vs GdimTableWriter）
      • 保存的 .pipe 不能连接 GdimTableWriter
      • 主表完整示例
      • 子表还需要 auto_bind="pk_field"
      • 常见错误
      • 与其它文档的关系
    • GDIM地图弹窗 (Map POI Popup)
      • 平台如何运行
      • 规则
      • 推荐拓扑
      • 完整示例
      • 本地测试
      • 常见错误
      • 与其它文档的关系
    • GDIM数据对接 (Data Exchange)
      • 两个方向
      • 导出规则
        • 导出示例
      • 导入规则
        • 导入示例
      • 第三方格式
      • 常见错误
      • 与其它文档的关系
    • GDIM自动报告 (Report App)
      • 平台如何运行
      • 推荐拓扑
      • 规则
      • 两阶段开发：先导出模板变量，再配置模板
      • 完整示例
      • 常见错误
      • 与其它文档的关系
    • 五种应用类型
    • 如何判断类型
    • 从脚本识别类型
    • 与其它文档的关系
  • 上传GDIM检查 (GDIM Upload Check)
    • 为什么需要单独检查
    • 总检查清单
    • 当前已整理的重点模块
    • 推荐检查顺序
  • 运行机制 (Runtime)
    • Pipeline 是什么
    • 连线如何生效
    • 如何执行
    • 模块何时算成功执行
    • 属性绑定
    • 运行上下文
      • 用项目名称定位
    • 跨 Pipeline 数据：save_data_to_db 与 GDIM 数据库
    • 保存与复用
    • 推荐理解顺序
    • 相关主题
  • 流程控制 (Flow Control)
    • 什么时候需要流程控制
    • ForEachController 是什么
    • 核心概念
    • 三种结果访问方式
      • 聚合端口的命名规则
    • 接入 Pipeline
    • 完整示例
    • 常见注意事项
    • 调试与排错
    • 相关 API
    • 相关主题
  • 运行调试 (Debug)
    • 何时使用
    • 如何开启
    • 命令行看啥
    • Trace 文件
    • 结果解读
    • 排查思路
    • 相关主题
  • GDIM开发模式 (Dev Mode)
    • 为什么需要开发模式
    • 如何开启
    • 查看表名与字段名
    • 查看 Pipeline 工作流节点状态图
    • 在 Pipeline 中如何选用 name / title
    • 与其它文档的关系
    • 后续计划
  • 学习案例 (Examples)
    • 案例一：按所需深度筛选钻孔
      • 案例概述
      • 你将学到
      • 实现思路
      • 关键代码
      • 更进一步
    • 案例二：绘制钻孔深度柱状图
      • 案例概述
      • 你将学到
      • 实现思路
      • 关键代码
      • 更进一步
    • 案例三：计算地层平均厚度
      • 案例概述
      • 你将学到
      • 实现思路
      • 关键代码
      • 更进一步
    • 案例四：处理地层表数据
      • 案例概述
      • 你将学到
      • 实现思路
      • 关键代码
      • 更进一步
    • 案例五：向 GDIM 写入数据
      • 案例概述
      • 你将学到
      • 实现思路
      • 关键代码
      • 更进一步
    • 案例六：在word中打印钻孔一览表
      • 案例概述
      • 你将学到
      • 实现思路
      • 关键代码
      • 更进一步
    • 案例七：绘制沉降时程曲线
      • 案例概述
      • 你将学到
      • 实现思路
      • 关键代码
      • 更进一步
    • 案例八：生成三维沉降曲面
      • 案例概述
      • 你将学到
      • 实现思路
      • 关键代码
      • 更进一步
    • 案例九：生成沉降分析报告
      • 案例概述
      • 你将学到
      • 实现思路
      • 关键代码
      • 更进一步
    • 案例十：基于大模型生成场地评价报告
      • 案例概述
      • 你将学到
      • 实现思路
      • 关键代码
      • 更进一步
    • 案例十一：基于大模型进行报告审核
      • 案例概述
      • 你将学到
      • 实现思路
      • 关键代码
      • 更进一步
    • 案例十二：导出GDIM表数据
      • 案例概述
      • 你将学到
      • 实现思路
      • 关键代码
      • 更进一步
    • 案例十三：将数据导入到GDIM
      • 案例概述
      • 你将学到
      • 实现思路
      • 关键代码
      • 更进一步
    • 案例十四：平台数据对接GEO5
      • 案例概述
      • 你将学到
      • 实现思路
      • 关键代码
      • 更进一步
  • 模块帮助 (Module Help)
    • modules.readers 模块帮助
      • CsvReader
      • ExcelReader
      • MdbReader
      • GdimTemplateReader
      • GdimTableReader
      • ReadGtbFile
      • GdimAppDataReader
      • GdimAppProjectInfoReader
      • GdimCrossSectionReader
      • GdimTerrainDataReader
    • modules.writers 模块帮助
      • DocDataWriter
      • TextWriter
      • ExportGdimTables
      • GdimTableWriter
      • MergeDocData
      • DocPrinter
      • ExcelPrinter
      • CreateGdimProject
      • UpdateGdimAppProjectInfo
      • BorePlanDrawWriter
      • BoreLogDrawWriter
      • GeoSectionsWriter
    • modules.converters 模块帮助
      • ConvertToMaterialTable
      • ConvertToMultiProfile1D
      • PdfToImages
      • TableToMarkdown
      • TablesToMarkdown
      • DocxToMarkdown
      • TableToDataFrame
      • TableToJson
      • JsonToTable
      • TableToSingleResult
      • TableToResultModel
      • SingleResultToText
      • SingleResultToTable
      • ResultModelToTable
      • TableToString
    • modules.dataClean 模块帮助
      • NullValueChecker
    • modules.mergers 模块帮助
      • MergeSingleResult
      • MergeResultModels
      • MergeTables
      • MergeGdimTables
      • AddTables
      • ConcatenateTables
    • modules.filters 模块帮助
      • TableSeriesSelector
      • TableFieldsSelector
      • TableSelector
      • TableCollectionSelector
      • TablesQuery
      • DropDuplicateRows
      • GdimAppDataSelector
      • MarkdownSectionFilter
    • modules.statistics 模块帮助
      • TableDescribe
      • ValuesCount
      • SphericalKMeans
      • MathematicalStatistics
    • modules.operators 模块帮助
      • ArithmeticOperator
      • ModifyTableColumns
      • AddTableColumns
        • 1）Inline 方式（推荐，最方便）
        • 2）文件方式（上传GDIM必须采用此方式，需要 @local_function）
      • TableCalculator
        • 1）Inline 方式：自定义汇总逻辑
        • 2）文件方式：上传GDIM必须采用此方式（需要 @local_function）
      • RenameTableColumns
    • modules.gisOperators 模块帮助
      • ConvexHullCenter
      • CreatePolyLines
    • modules.geoSurvey 模块帮助
      • SeismicDesignParameters
      • RecentlyDepositedLoess
      • Collapsibility
      • Liquefaction
      • WaterSoilCorrosion
    • modules.shallowFoundation 模块帮助
      • CreateRecFoundation
      • FoundationSettlement
      • BearingCapacityModify
      • SoilUniformity
      • BearingCapacityBySPT
      • BearingCapacityByStrength
    • modules.foundationPit 模块帮助
      • NailCohesionByTest
    • modules.pileFoundation 模块帮助
      • SkinCapacityByTest
      • BaseCapacityByTest
    • modules.geoDataProcess 模块帮助
      • MapBoreTypeToKCAD
      • AddLayerNumberByStdLayerTable
      • CompleteLayerTable
      • SortByLayerNumber
      • SliceTerrain
      • ExportGeoSectionsByBores
      • AddBoreLogForGeoSections
      • CalculateCorrectedBlowCount
    • modules.contaDataProcess 模块帮助
      • ContaDataToNumeric
    • modules.llmAI 模块帮助
      • PromptTemplate
      • LLMNode
      • TableDataExtractor
      • DictDataExtractor
      • TableAnalyzer
    • modules.plotters 模块帮助
      • LineChartPlotter
      • BarChartPlotter
      • ScatterChartPlotter
      • HistogramPlotter
      • PieChartPlotter
      • TablePlotter
      • PlotMerger
    • modules.widgets 模块帮助
      • PythonCoder
        • 1）在 Pipeline 中创建并配置 PythonCoder
        • 2）在脚本中定义本地函数（@local_function）
        • 1）Inline 本地函数 vs 文件本地函数（GDIM 上传要求）
        • 2）@local_function 的 module 参数可以做什么
        • 3）为动态输出端口指定 ``ptype``（GDIM 前端展示）
        • 4）UI Schema 的本地函数与 reset 参数
        • 5）兼容 gdi / gdisdk 的包导入写法
        • 6）本地函数可用的第三方包
  • 端口类型 (Port Type)
    • 端口、端口类型与 PortTypeHint
    • TableData：模块之间传递单张业务表
    • TableCollection：模块之间整体传递多张关联表
    • ResultModel：推荐的结构化结果端口类型
    • SingleResult：兼容旧模块的“关键指标结果”端口类型
    • AgentRunResult：用于保留大模型原始运行结果的端口类型
    • DocData：报告打印的数据容器（模板 keys 与渲染数据）
    • PlotData：前端图表输出端口
    • Text：前端可展示的文本端口
    • Picture：前端可展示的图片端口
    • 设计动机：为数据智能准备好的结构
    • 端口类型家族概览
  • 端口数据结构 (Port Dataclass)
    • 快速导航
    • FieldMetadata
      • 导入路径
      • 初始化参数
      • 使用示例
    • TableData
      • 导入路径
      • 初始化参数
      • 主要属性
      • 常用方法
      • 使用示例
    • TableSeries
      • 导入路径
      • 主要属性
      • 常用方法
    • TableCollection
      • 导入路径
      • 初始化参数
      • 常用方法
      • 使用示例
    • UnitResult
      • 导入路径
      • 字段
      • 使用示例
    • ResultModel
      • 导入路径
      • 定义方式
      • 主要属性
      • 常用方法
      • 使用示例
    • SingleResult
      • 导入路径
      • 初始化参数
      • 主要属性
      • 常用方法
      • 使用示例
    • AgentRunResult
      • 导入路径
      • 说明
      • 选型建议
      • 使用示例
    • DocData
      • 导入路径
      • 字段
      • 常用方法
    • PlotData
    • CoordinateSystem
      • 导入路径
      • 字段
      • 使用示例
    • GdimTemplate
      • 导入路径
      • 常用方法
      • 典型适用场景
      • 获取方式
    • GdimMinIOFile
      • 导入路径
      • 字段
      • 常用方法
      • 典型适用场景
    • GdimTableFile
      • 导入路径
      • 字段
      • 常用方法
      • 典型适用场景
    • 如何在设计模块端口时配合使用
  • UI控件 (UI Schema)
    • 什么是 UI Schema？
    • 常用 UIAttributeSchema 类型概览
    • 与 PipeLine 属性及 GDIM UI 的协同
    • 更多示例与推荐阅读
  • API参考 (API Reference)
    • Modules Package
      • modules.contaDataProcess
        • Classes
      • modules.converters
        • Classes
      • modules.dataClean
        • Classes
      • modules.filters
        • Classes
      • modules.foundationPit
        • Classes
      • modules.geoDataProcess
        • Classes
      • modules.geoSurvey
        • Classes
      • modules.gisOperators
        • Classes
      • modules.llmAI
        • Classes
      • modules.mergers
        • Classes
      • modules.operators
        • Classes
      • modules.pileFoundation
        • Classes
      • modules.plotters
        • Classes
      • modules.readers
        • Classes
      • modules.shallowFoundation
        • Classes
      • modules.statistics
        • Classes
      • modules.thirdPartyIntegrations
        • Classes
      • modules.widgets
        • Classes
      • modules.writers
        • Classes
    • Pipeline Package
      • pipeline.exceptions
        • Classes
      • pipeline.flowControl
        • Notes
        • Classes
      • pipeline.links
        • Classes
      • pipeline.module
        • Classes
      • pipeline.moduleDecorators
        • Functions
      • pipeline.nameSpace
        • Classes
        • Functions
      • pipeline.observability
        • Examples
        • Functions
      • pipeline.pipeData.ui_schema
        • Classes
      • pipeline.pipeline
        • Classes
      • pipeline.port
        • Classes
      • pipeline.portTypes
        • Classes
        • Functions
      • pipeline.runner
        • Classes
    • Dataclass Package
      • dataclass.gdimData
        • Classes
        • Functions
      • dataclass.gdimFilters
        • Classes
        • Functions
      • dataclass.geoProfiles
        • Classes
        • Functions
      • dataclass.geoStructures
        • Classes
      • dataclass.llmAIModels
        • Classes
      • dataclass.logs
        • Classes
        • Functions
      • dataclass.results
        • Classes
        • Functions
      • dataclass.specialTables
        • Classes
        • Functions
      • dataclass.tables
        • Classes
      • dataclass.terminologies
        • Classes
  • 更新日志 (Change Log)
    • 版本历史
      • v0.3.5
      • v0.3.4
      • v0.3.3
      • v0.3.2
      • v0.3.1
      • v0.3.0
      • v0.2.8
      • v0.2.7
    • 更新说明
      • 版本命名规范
    • 升级指南
      • 从旧版本升级
    • 贡献指南
      • 如何报告问题
    • 联系我们
GdiSDK
  • Search

© Copyright 2026, 南京库仑软件技术有限公司.