dimine-python-sdk 0.1.8__py3-none-any.whl

dimine_python_sdk/docs/guides/data_types.md

@@ -0,0 +1,152 @@
+# 数据类型说明
+
+## 数采文件信息
+
+### 类型定义
+
+```python
+class FileInfo(BaseModel):
+    id: str = Field(description='文件id')  # 
+    name: str = Field(description='文件名')  # 
+```
+
+## 图层信息
+
+
+### 类型定义
+
+```python
+class LayerInfo(BaseModel):
+    id: str = Field(description='图层id')  # 
+    name: str = Field(description='图层名称')  # 
+```
+
+## 属性信息
+单个属性的定义，比如：属性名称、数据类型
+### 类型定义
+
+```python
+class PropertyInfo(BaseModel):
+    name: str = Field(description='属性名称')  # 
+    type: Literal['long', 'string', 'int', 'short'] = Field(description='数据类型')  # 
+```
+
+## 属性信息和属性值
+在属性定义的基础上增加属性值字段
+
+### 类型定义
+
+```python
+class PropertyValue(BaseModel):
+    value: str | int | float | None = Field(default=None, description='属性值')  # 
+```
+
+## 要素信息
+要素定义，也是一组属性的定义，比如：巷道要素，包含属性如名称、长度、宽度、高度等
+
+### 类型定义
+
+```python
+class FeatureInfo(BaseModel):
+    name: str = Field(description='要素名称', validation_alias='feature_name')  # 
+    properties: List[PropertyInfo] = Field(default_factory=list, description='要素属性', validation_alias='feature_define')  # 
+```
+
+## 几何对象基础类
+是所有几何对象类型的基类
+
+### 类型定义
+
+```python
+class BaseGeometry(BaseModel):
+    id: str = Field(default='', description='点id')  # 
+    color: List[int] = Field(default=[0, 0, 0], description='颜色')  # 
+    feature: str = Field(default='', description='所属要素名')  # 
+    layer: str = Field(default='', description='所在图层id')  # 
+    properties: List[PropertyValue] = Field(default_factory=list, description='点属性')  # 
+```
+
+## 点
+表示一个点对象，只有一个坐标
+
+### 类型定义
+
+```python
+class Point(BaseGeometry):
+    type: Optional[Literal['point']] = Field(default='point', description='点类型')  # 
+    geometry: np.ndarray = Field(default=np.array([]), description='点坐标, shape=(3,)')  # 
+```
+
+
+## 线
+表示一条直线或者多段线
+
+### 类型定义
+
+```python
+class Line(BaseModel):
+    type: Optional[Literal['line']] = Field(default='line', description='线类型')  # 
+    geometry: np.ndarray = Field(default=np.array([]), description='线坐标, shape=(N,3)')  # 
+```
+
+
+## 实体对象几何信息
+
+使用三角网体表示一个实体对象， 每三个点构成一个三角形
+
+### 类型定义
+
+```python
+class TINGeometry(BaseType):
+    """三角网模型定义，"""
+    model_config = {"arbitrary_types_allowed": True}
+    faces: np.ndarray = Field(default=np.array([]), description="三角面片：每行是三个顶点的索引，三个顶点连接起来形成一个三角面。shape=(N,3)")
+    points: np.ndarray = Field(default=np.array([]), description="所有顶点坐标, shape=(N,3)")
+```
+
+
+
+## 实体对象
+包含实体对象几何信息，参考EntityGeometry
+
+### 类型定义
+
+```python
+class Entity(BaseGeometry):
+    """实体"""
+    type: Optional[Literal["entity"]] = Field(default="entity", description="体类型")
+    geometry: TINGeometry = Field(default=None, description="三角网模型对象（TIN）")
+```
+
+## GEOMETRY
+GEOMETRY 是一个联合类型，可以是以下类型之一：
+- Point
+- Line
+- Shell
+
+### 类型定义
+
+```python
+GEOMETRY = Union[Point, Line, Shell]
+```
+
+## Shell
+表示一个三维实体对象，使用三角网（TIN）表示实体几何信息，每个面由三个顶点构成三角形。
+
+### 类型定义
+
+```python
+class Shell(BaseGeometry):
+    """实体"""
+    type: Optional[Literal["shell"]] = Field(default="shell", description="体类型")
+    geometry: TINGeometry = Field(default=None, description="三角网模型对象（TIN）")
+
+class TINGeometry(BaseType):
+    """三角网模型定义"""
+    model_config = {"arbitrary_types_allowed": True}
+    faces: np.ndarray = Field(default=np.array([]), description="三角面片：每行是三个顶点的索引，每行构成一个三角形面。shape=(N,3)")
+    points: np.ndarray = Field(default=np.array([]), description="所有顶点坐标, shape=(N,3)")
+```
+
+
+

dimine_python_sdk/docs/guides/features.md

@@ -0,0 +1,271 @@
+# 要素管理
+
+要素（Feature）是几何模型的属性集合定义。例如，巷道要素可能包含名称、长度、宽度、高度等属性。通过要素管理系统，可以创建、更新和删除要素定义。
+
+## 1. 创建要素
+
+为文件创建新的要素定义，包含要素名称和属性列表：
+
+```python
+import asyncio
+from dimine_python_sdk.conn import open_client
+
+async def main():
+    async with open_client() as client:
+        # 获取文件列表
+        files = await client.get_files()
+
+        # 创建要素定义
+        await client.create_feature(
+            file_id=files[len(files)-1].id,
+            feature_name="巷道要素",
+            feature_define=[
+                {"name": "名称", "type": "string"},
+                {"name": "长度", "type": "double"},
+                {"name": "宽度", "type": "double"},
+                {"name": "高度", "type": "double"},
+                {"name": "材质", "type": "string"},
+                {"name": "掘进日期", "type": "string"}
+            ]
+        )
+        print("要素创建成功")
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+
+## 2. 获取要素信息
+
+获取文件中所有要素的定义信息：
+
+```python
+import asyncio
+from dimine_python_sdk.conn import open_client
+from dimine_python_sdk.models.types import FeatureInfo, PropertyInfo
+
+async def main():
+    async with open_client() as client:
+        # 获取文件列表
+        files = await client.get_files()
+        features = await client.get_features(files[0].id)
+
+        print(f"文件包含 {len(features)} 个要素:")
+        for feature in features:
+            print(f"\n要素名称: {feature.name}")
+            print("属性定义:")
+            for prop in feature.properties:
+                print(f"  - {prop.name}: {prop.type}")
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+
+## 3. 更新要素
+
+更新已存在的要素定义，可以添加、修改或删除属性：
+
+```python
+import asyncio
+from dimine_python_sdk.conn import open_client
+
+async def main():
+    async with open_client() as client:
+        # 获取文件列表
+        files = await client.get_files()
+
+        # 更新要素定义
+        await client.update_feature(
+            file_id=files[len(files)-1].id,
+            feature_name="巷道要素",
+            feature_define=[
+                {"name": "名称", "type": "string"},
+                {"name": "长度", "type": "double"},
+                {"name": "宽度", "type": "double"},
+                {"name": "高度", "type": "double"},
+                {"name": "材质", "type": "string"},
+                {"name": "掘进日期", "type": "string"},
+                {"name": "支护类型", "type": "string"}  # 新增属性
+            ]
+        )
+        print("要素更新成功")
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+
+## 4. 删除要素
+
+删除文件中的指定要素：
+
+```python
+import asyncio
+from dimine_python_sdk.conn import open_client
+
+async def main():
+    async with open_client() as client:
+        # 获取文件列表
+        files = await client.get_files()
+
+        # 删除要素
+        await client.delete_feature(
+            file=files[len(files)-1].id,
+            feature_name="巷道要素"
+        )
+        print("要素删除成功")
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+
+## 5. 要素与几何模型的关系
+
+要素定义了几何模型可以拥有的属性。创建几何模型时，需要指定所属的要素：
+
+```python
+import asyncio
+import numpy as np
+from dimine_python_sdk.conn import open_client
+from dimine_python_sdk.models.types import Point, PropertyValue
+
+async def main():
+    async with open_client() as client:
+        # 获取文件、图层、要素信息
+        files = await client.get_files()
+        layers = await client.get_layers(file_id=files[0].id)
+        features = await client.get_features(files[0].id)
+
+        # 创建带属性的点模型
+        point = Point(
+            file=files[0].id,
+            layer=layers[0].id,
+            feature=features[0].name,  # 关联到要素
+            geometry=np.array([100, 200, 300]),
+            properties=[
+                PropertyValue(name="名称", value="钻孔ZK-001", type="string"),
+                PropertyValue(name="高程", value="1250.5", type="float"),
+                PropertyValue(name="孔深", value="150.0", type="float")
+            ]
+        )
+
+        await client.create_geometry([point])
+        print("带属性的点模型创建成功")
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+
+## 6. 属性类型说明
+
+要素属性支持以下数据类型：
+
+- **string**: 字符串类型
+- **int**: 整数类型
+- **long**: 长整数类型
+- **short**: 短整数类型
+- **double**: 浮点数类型
+
+### 属性使用注意事项
+
+1. **数据类型匹配**: 设置属性值时需要与定义的类型匹配
+2. **属性名称唯一**: 在同一个要素中，属性名称不能重复
+3. **字段命名**: 属性名称建议使用中文，便于在Dimine软件中显示
+
+## 7. 完整示例：创建和管理要素
+
+```python
+import asyncio
+import numpy as np
+from dimine_python_sdk.conn import open_client
+from dimine_python_sdk.models.types import Point, Line, Shell, PropertyValue
+
+async def main():
+    async with open_client() as client:
+        # 1. 获取文件信息
+        files = await client.get_files()
+        file_id = files[0].id
+        layers = await client.get_layers(file_id=file_id)
+        layer_id = layers[0].id
+
+        # 2. 创建多个要素
+        await client.create_feature(
+            file_id=file_id,
+            feature_name="勘探孔",
+            feature_define=[
+                {"name": "孔号", "type": "string"},
+                {"name": "孔深", "type": "double"},
+                {"name": "倾角", "type": "double"},
+                {"name": "方位角", "type": "double"},
+                {"name": "岩性", "type": "string"}
+            ]
+        )
+
+        await client.create_feature(
+            file_id=file_id,
+            feature_name="测点",
+            feature_define=[
+                {"name": "点号", "type": "string"},
+                {"name": "高程", "type": "double"},
+                {"name": "X坐标", "type": "double"},
+                {"name": "Y坐标", "type": "double"},
+                {"name": "Z坐标", "type": "double"}
+            ]
+        )
+
+        # 3. 获取要素信息
+        features = await client.get_features(file_id)
+        print(f"创建了 {len(features)} 个要素")
+
+        # 4. 创建与要素关联的几何模型
+       勘探孔要素 = None
+        测点要素 = None
+
+        for feature in features:
+            if feature.name == "勘探孔":
+                勘探孔要素 = feature
+            elif feature.name == "测点":
+                测点要素 = feature
+
+        # 创建勘探孔模型
+        if 勘探孔要素:
+            drill_hole = Line(
+                file=file_id,
+                layer=layer_id,
+                feature=勘探孔要素.name,
+                geometry=np.array([[0, 0, 0], [100, 50, -150]]),
+                color=[255, 0, 0],
+                properties=[
+                    PropertyValue(name="孔号", value="ZK-001", type="string"),
+                    PropertyValue(name="孔深", value="150.0", type="float"),
+                    PropertyValue(name="倾角", value="56.3", type="float")
+                ]
+            )
+            await client.create_geometry([drill_hole])
+
+        # 创建测点模型
+        if 测点要素:
+            survey_point = Point(
+                file=file_id,
+                layer=layer_id,
+                feature=测点要素.name,
+                geometry=np.array([50, 25, -75]),
+                color=[0, 255, 0],
+                properties=[
+                    PropertyValue(name="点号", value="D-001", type="string"),
+                    PropertyValue(name="高程", value="1225.0", type="float")
+                ]
+            )
+            await client.create_geometry([survey_point])
+
+        print("要素和模型创建完成")
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+
+## 8. 最佳实践
+
+1. **要素规划**: 在创建模型前，先规划好需要的要素类型和属性
+2. **命名规范**: 使用清晰的要素名称，如"巷道"、"钻孔"、"测点"等
+3. **属性精简**: 只包含必要的属性，避免过度设计
+4. **类型选择**: 根据数据特性选择合适的属性类型
+5. **版本管理**: 如果需要修改要素定义，建议先删除后重建，避免数据不一致

dimine_python_sdk/docs/guides/io.md

@@ -0,0 +1,157 @@
+# IO操作
+
+IO操作包括文件的导入、导出、文件类型转换
+
+## 1. 文件打开
+
+将外部文件打开到数采软件当前场景中：
+
+```python
+import asyncio
+from dimine_python_sdk.conn import open_client
+
+async def main():
+    async with open_client() as client:
+        # 打开文件（支持多种格式：dmf、dmm、dtm、dwg等）
+        file_path = "D:/temp/test_export.dtm"
+        file_info = await client.open_file(file_path)
+        print(f"打开文件: {file_info.name}, ID: {file_info.id}")
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+
+**支持的打开文件格式：**
+- `.dtm` - Dimine地形模型文件
+- `.dmf` - Dimine标准工程文件格式
+- `.dmm` - Dimine模型文件格式
+- `.dwg` / `.dxf` - AutoCAD文件格式
+- 以及其他Dimine支持的格式
+
+## 2. 文件导出
+
+将数采软件场景中的文件导出为指定格式：
+
+```python
+import asyncio
+from dimine_python_sdk.conn import open_client
+
+async def main():
+    async with open_client() as client:
+        # 获取文件列表
+        files = await client.get_files()
+
+        if len(files) > 0:
+            # 导出文件（根据文件扩展名自动识别格式）
+            await client.export_file(
+                file_id=files[0].id,
+                file_path="D:/temp/test_export.dwg"
+            )
+            print("文件导出成功")
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+
+**支持的导出文件格式：**
+- `.dwg` / `.dxf` - AutoCAD格式
+- `.dmf` - Dimine工程文件
+- `.dmm` - Dimine模型文件
+- `.dtm` - Dimine地形模型
+- 以及其他Dimine支持的格式
+
+**参数说明：**
+- `file_id`: 文件ID或文件名称
+- `file_path`: 导出目标路径
+- `mkdir`: 是否自动创建目录（默认为True）
+
+## 3. 文件关闭
+
+关闭当前场景中的指定文件：
+
+```python
+import asyncio
+from dimine_python_sdk.conn import open_client
+
+async def main():
+    async with open_client() as client:
+        # 获取文件列表
+        files = await client.get_files()
+
+        # 关闭文件
+        await client.close_file(file_id=files[0].id)
+        print("文件已关闭")
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+
+## 3. 文件关闭
+
+关闭当前场景中的指定文件：
+
+```python
+import asyncio
+from dimine_python_sdk.conn import open_client
+
+async def main():
+    async with open_client() as client:
+        # 获取文件列表
+        files = await client.get_files()
+
+        # 关闭文件
+        if len(files) > 0:
+            await client.close_file(files[0].id)
+            print("文件已关闭")
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+
+## 4. 文件操作完整示例
+
+```python
+import asyncio
+from dimine_python_sdk.conn import open_client
+
+async def main():
+    async with open_client() as client:
+        # 1. 打开文件
+        print("打开文件...")
+        file_path = "D:/temp/test.dtm"
+        file_info = await client.open_file(file_path)
+        print(f"已打开: {file_info.name}, ID: {file_info.id}")
+
+        # 2. 获取文件列表
+        files = await client.get_files()
+        print(f"\n当前文件数: {len(files)}")
+
+        # 3. 导出文件
+        if len(files) > 0:
+            print("导出文件...")
+            await client.export_file(
+                file_id=files[0].id,
+                file_path="D:/temp/test_export.dwg"
+            )
+            print("导出成功")
+
+        # 4. 关闭文件
+        if len(files) > 0:
+            print("关闭文件...")
+            await client.close_file(files[0].id)
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+
+## 支持的文件格式
+
+Dimine软件支持多种文件格式的导入导出：
+
+- **DMF**: Dimine标准工程文件格式
+- **DMM**: Dimine模型文件格式
+- **CAD**: AutoCAD文件格式（.dwg, .dxf等）
+- **DMB**: Dimine块定义文件
+- **DMD**: Dimine数据文件
+- **DMO**: Dimine对象文件
+

dimine_python_sdk/docs/index.md

@@ -0,0 +1,41 @@
+# dimine-python-sdk
+
+## 1. 概述
+**简介**：
+
+本SDK提供Dimine数采Python接口，用于与Dimine数字采矿设计软件进行高效交互。开发者可通过编写 Python 脚本，实现对采矿模型、场景等核心资源的增删改查操作，以及获取场景信息、执行分析任务等，从而将采矿设计工作流自动化或集成到现有系统中。
+
+**核心特性**：
+
+  - 模型管理：创建、读取、更新、删除采矿设计模型（如地质模型、采场模型、巷道模型等）。
+  - 场景交互：获取当前打开的工程场景信息，包括场景列表、场景内对象属性。
+  - 数据查询：支持按条件过滤模型、查询属性、空间关系检索。
+  - 实时同步：操作结果实时反映在软件界面中。
+  - 异步支持：提供异步调用接口，适用于批量处理或长时间任务。
+
+**适用平台/语言**：Python 3.12 及以上版本；支持 Windows / Linux 操作系统；需安装数字采矿设计软件客户端。
+
+
+## 2. 快速安装
+```bash
+pip install dimine-python-sdk
+```
+
+## 3. 快速开始
+
+获取数采当前打开的文件列表
+```python
+import asyncio
+from dimine_python_sdk.conn import open_client
+
+async def main():
+    async with open_client() as client:
+        files = await client.get_files()
+        print(files)
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+
+
+

dimine_python_sdk/docs/quickstart.md

@@ -0,0 +1,45 @@
+# 快速开始
+以下介绍如何使用sdk获取数采当前文件列表、图层信息、模型对象等信息
+
+
+## 1. 获取文件列表
+```python
+import asyncio
+from dimine_python_sdk.conn import open_client
+async def main():
+    async with open_client() as client:
+        files = await client.get_files()
+        print(files)
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+
+## 2. 获取图层信息
+```python
+import asyncio
+from dimine_python_sdk.conn import open_client
+async def main():
+    async with open_client() as client:
+        files = await client.get_layers(file_id="123")
+        print(files)
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+
+## 3. 获取模型对象
+```python
+import asyncio
+from dimine_python_sdk.conn import open_client
+async def main():
+    async with open_client() as client:
+        files = await client.get_files()
+        layers = await client.get_layers(file_id=files[len(files)-1].id)
+        geometries = await client.get_geometry(file_id=files[len(files)-1].id, layer_id=layers[0].id, ["point"])
+        print(geometries)
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+

dimine_python_sdk/docs/reference/SUMMARY.md

@@ -0,0 +1,19 @@
+# API 参考
+
+* [logger](logger.md)
+* [base_conn_client](conn\base_conn_client.md)
+* [conn_client](conn\conn_client.md)
+* [model_func](lib\algorithm\model_func.md)
+* [file_conversion](lib\io\file_conversion.md)
+* [models](lib\io\models.md)
+* [project_plotting](lib\io\project_plotting.md)
+* [block_data](lib\prospecting\block_data.md)
+* [drill_db](lib\prospecting\drill_db.md)
+* [models](lib\prospecting\models.md)
+* [valuation](lib\prospecting\valuation.md)
+* [entity](lib\types\entity.md)
+* [line](lib\types\line.md)
+* [point](lib\types\point.md)
+* [conn](models\conn.md)
+* [errors](models\errors.md)
+* [types](models\types.md)

dimine_python_sdk/docs/reference/conn/base_conn_client.md

@@ -0,0 +1,3 @@
+# base_conn_client
+
+::: dimine_python_sdk.conn.base_conn_client

dimine_python_sdk/docs/reference/conn/conn_client.md

@@ -0,0 +1,3 @@
+# conn_client
+
+::: dimine_python_sdk.conn.conn_client

dimine_python_sdk/docs/reference/lib/algorithm/model_func.md

@@ -0,0 +1,3 @@
+# model_func
+
+::: dimine_python_sdk.lib.algorithm.model_func