# PKPM官方API发布

**Repository Path**: pkpmgh/pkpm-official---api-release

## Basic Information

- **Project Name**: PKPM官方API发布
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 21
- **Forks**: 6
- **Created**: 2024-01-15
- **Last Updated**: 2026-02-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# PKPM官方API发布


### API6.0更新说明：

#### PKPM API6.0针对python二次开发全面优化(python3.8-python3.13)
支持三种配置方式

**全新支持python3.8-python3.13**

**1、支持使用AI大模型进行PKPM的二次开发（[PKPM-Agent](https://gitee.com/pkpmgh/PKPMAgentRelease "查看PKPM-Agent 用户手册")）**

- 🧩 **收藏AI对话生成的代码，复用以开发自定义功能**
- 🚀 **脚本执行器免环境配置，开箱即用**
- ⚡ **与PKPM打开工程共享进程，即改即生效**

<div align="center">
<table>
<tr>
<td><img src="HelpImage/收藏.png" alt="快捷指令" width="400"></td>
<td><img src="HelpImage/快捷指令到了脚本执行器.png" alt="快捷指令" width="400"></td>
</tr>
</table>
</div>

**2、利用PKPM内置完整Python环境和您自己的IDE进行PKPM二次开发**

- ⚙️ **简单配置即可使用，内置常用Python库**
- 💻 **包含pyi文件，支持语法高亮与代码补全**

**3、通过pip官方源安装PKPM API**

- 🌠 **独立于PKPM安装程序，灵活部署**
- 🌐 **一行命令即可安装配置完整的pkpm-api**


### API6.0三种配置方式的详细说明

**1、PKPM-Agent内置的python脚本执行器**

- **环境要求**：安装PKPM2026R2.0及以后的版本
- **操作步骤**：参见下图，在Python快捷指令(脚本执行器)中您可以完成"新建脚本"、"运行脚本"、"排序脚本目录"、"搜索脚本"、"控制台输出"等，操作逻辑和一般IDE相似。新建脚本会有二次开发的说明文档，请遵照此说明进行相关代码的编写

详细的PKPM-Agent操作参见：[PKPM-Agent 用户手册](https://gitee.com/pkpmgh/PKPMAgentRelease "查看PKPM-Agent 用户手册")

<img src="HelpImage/代码执行界面.png" alt="" width="800">

**2、利用PKPM内置完整python环境和您自己的IDE进行PKPM二次开发**

- **环境要求**：安装PKPM2026R1.1及以后的版本
- **操作步骤**：参见下图，需要选择您软件安装目录下`Ribbon\PythonEnv`文件夹下的`python.exe`作为python解释器，并在您自己脚本的开头引入安装目录`Ribbon\PythonEnv\Scripts`文件夹下的`PKPMEnvInit.py`文件

<img src="HelpImage/ide二次开发.png" alt="" width="800">

例如

```python
import sys
import os
import subprocess
sys.path.append(r"E:\pkpm_r\PKPM_2026R2.0-64_20260209_0201_code\Release\Ribbon\PythonEnv\Scripts\PKPMEnvInit.py") #这里需要提供您安装目录下的Ribbon\PythonEnv\Scripts\PKPMEnvInit.py绝对路径
import PKPMEnvInit
import APIPyInterface
```

**3、通过pip官方源安装PKPM API**
- **环境要求**：python为3.8-3.13版本
- **安装至您的某个虚拟环境**：`.\.venv\Scripts\python.exe -m pip install pkpm-api`；
- **安装至您的默认python环境**：`pip install pkpm-api`
- **pypi官网访问缓慢**:下载本项目 .\APIPython_3.8-3.13_whl文件\ 下的whl文件至本地（注意和您的python版本对应），使用pip利用下载的whl文件进行安装

**PythonAPI完整环境及测试脚本**
- 如果您已经通过上述方式安装了pkpm_api，仅下载本项目 .\APIPythonTest_python3\*\* \ 文件夹下的APIPythonTest.py文件即可；如果您未安装pkpm_api，可以下载.\APIPythonTest_python3\*\* \ 整个文件夹的完整环境（需要注意和您的python版本对应，还需注意文件夹中的内容可以被您的python解释器检索到）




#### API5.0更新说明：

1、新增层间板和组合梁类，参见说明文档3.13和3.14；

2、新增工程参数类，参见说明文档3.27；

3、新增特殊构件定义中的柱和支撑隔震支座，参见说明文档3.43；

4、新增楼层剪切刚度和相关比值，参见说明文档3.39，对应PKPM后处理计算书中立面规则性-楼层侧向剪切刚度；

5、新增【楼层剪力/层间位移】刚度和相关比值，参见说明文档3.40，对应PKPM后处理计算书中立面规则性-【楼层剪力/层间位移】刚度；

6、新增楼层受剪承载力和承载力比值，参见说明文档3.41，对应PKPM后处理计算书中立面规则性-楼层受剪承载力；

7、新增有效质量系数信息，参见说明文档3.42，对应PKPM后处理计算书中抗震分析及调整-有效质量系数；

8、修复了Gitee上及用户群的已知bug。

Tips：感谢大家使用PKPM—API，后续如果发现问题，推荐在gitee上提交问题方便记录（https://gitee.com/pkpmgh/pkpm-official---api-release/issues），也可以通过QQ群（1149092638）给我们留言，我们会定期收集这些问题并处理。

#### 介绍

{PKPMAPI 支持 C++/C#/Python(目前python支持3.7版本) 三种语言}

#### 必须环境文件列表：

 **C#版本API**：  APIFrameworkRef_x64.dll

​						CfgDll55X64.dll

​						CFGPointer_X64.dll

​						Engineering_Quantity_For_x64.dll

​						PkpmMaterial_x64.dll

​						PMDATAAPI_x64.dll

​						PMSAP_DBS64.dll

​						PmsrwData_x64.dll

​						Steel_Sect_X64.dll 及STSLIB文件夹。

 **python版本API** ：    APIPyInterface.pyd
                        APIPyInterface.pyi
                        CFGPointer_X64.dll
                        Engineering_Quantity_For_x64.dll
                        PKPMSteelSect_X64.dll
                        PMDATAAPI_x64.dll
                        PMDrawAPI.dll
                        PMDrawAPI.pyi
                        PMSAP_DBS64.dll
                        PkpmMaterial_x64.dll
                        PmsrwData_x64.dll
                        RibbonKitAPI.dll
                        wxlCmdMngr.dll
​						 Steel_Sect_X64.dll 及STSLIB文件夹。

 **C++版本API** ：头文件26个，库文件1个（PMDATAAPI_x64.lib）。

#### 环境配置说明

使用前请先检查以上必备环境文件是否齐全。

检查齐全后，请确保按下列说明进行了环境配置：

==C#项目==：项目已添加引用APIFrameworkRef_x64.dll，且所需的其余dll和该APIFrameworkRef_x64.dlll在同一目录下。项目代码中已导入命名空间：using APIFrameworkRef。请确认项目当前配置下（一般为Release x64）生成文件和调试启动项目一致。

==Python项目（仅支持64位）==
Python语言的PKPM二次开发当前支持三种环境配置方式

1、2026R2.0起可以使用PKPM-Agent的脚本执行器，环境已经完备，即开即用，[PKPM-Agent 用户手册](https://gitee.com/pkpmgh/PKPMAgentRelease "查看PKPM-Agent 用户手册")

2、2026R1.1起PKPM内置完整Python环境，支持您使用自己的IDE进行开发和调试。需要选择您软件安装目录下`Ribbon\PythonEnv`文件夹下的`python.exe`作为python解释器，并在您自己脚本的开头引入安装目录`Ribbon\PythonEnv\Scripts`文件夹下的`PKPMEnvInit.py`文件，例如
```python
import sys
import os
import subprocess
sys.path.append(r"E:\pkpm_r\PKPM_2026R2.0-64_20260209_0201_code\Release\Ribbon\PythonEnv\Scripts\PKPMEnvInit.py") # 这里需要提供您安装目录下的Ribbon\PythonEnv\Scripts\PKPMEnvInit.py绝对路径
import PKPMEnvInit
import APIPyInterface

# 具体代码请参见示例代码文件
```

3、使用pip官方安装pkpm_api库，例如将pkpm_api安装至您的某个虚拟环境`.\.venv\Scripts\python.exe -m pip install pkpm-api`,或安装至您的默认python环境中`pip install pkpm_api`


==C++项目==：请确保项目的附加包含目录和附加库目录正确设置包含了头文件和库文件的位置。并在程序中进行了头文件和库文件的声明，具体声明可参考示例C++项目。

#### 测试代码使用说明

==C#测试代码==：代码起始需修改变量：模型工作文件夹path、模型名字name，RunAnalyse函数下 cycle_path和cycle_exe请对应修改为用户电脑JWSCYCLE.exe所在目录的对应位置，并保证该文件夹是存在的。

==Python测试代码==：代码起始需修改变量：模型工作文件夹path、模型名字name。RunAnalyse函数下 cycle_path和cycle_exe请对应修改为用户电脑JWSCYCLE.exe所在目录的对应位置，并保证该文件夹是存在的。

==C++测试代码==：代码起始需修改变量：模型名字PMname，（C++测试代码为直接读取用户创建的空模型，因此请保证存在一个空模型）。RunAnalyse函数下 cycle_path和cycle_exe请对应修改为用户电脑JWSCYCLE.exe所在目录的对应位置，模型工作文件夹path修改为模型所在目录，并保证该文件夹是存在的。GetAnalyseResult函数下正确设置Resultpath为模型的目录地址。