# PyPhotEngine

**Repository Path**: Photlab/pyphot-engine

## Basic Information

- **Project Name**: PyPhotEngine
- **Description**: 光纤仿真计算引擎
- **Primary Language**: Python
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-11-11
- **Last Updated**: 2024-11-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# phot-engine 


  ##  1 模块简介

Phot-Engine 是一个用于连接 Phot-Design 图形用户界面（GUI）和底层计算库（Phot）的计算引擎。它通过提供计算接口，允许 Phot-Design 调用 Phot 库的底层计算功能，完成光学设计相关的复杂计算任务。该引擎负责将来自用户界面的参数和任务请求转换为底层可执行的计算指令，并将计算结果返回给 Phot-Design 进行显示或进一步处理。

##  2 功能说明
phot-engine目前主要实现GPU+CPU异构协同仿真计算框架，关键技术主要包括GAS图计算框架技术、层次化任务调度和资源调度策略。
### 2.1 任务调度与管理：
接收来自 Phot-Design 的任务请求，分配给合适的底层计算模块进行处理。
### 2.2 计算接口提供：
Phot-Engine 提供一系列计算接口，支持光纤通信系统、光学器件等的多种计算任务，并将结果返回给用户界面进行可视化处理。
### 2.3 扩展性与模块化：
Phot-Engine 设计为模块化架构，支持扩展其他计算库和功能。

##  3 依赖环境
### 3.1 环境依赖安装
本说明默认您在Windows下进行环境配置，Linux在某些细节可能略有不同。
### 3.2 编程语言&开发环境依赖
   - 编程语言：python3.10及以上
   - 开发环境：pycharm2021.1.3及以上
### 3.3 安装项目相关依赖
    - 创建 Python 虚拟环境： 在项目根目录中，创建并激活 Python 虚拟环境：
```
python -m venv project-venv
venv\Scripts\activate  # 对于macOS用户：source venv/bin/activate
```
    - 激活虚拟环境后，安装所需依赖：

```
pip install -r requirements.txt
```

## 4 开发指南
- 计算引擎开发详见
[开发指南](https://gitee.com/ning_mi/pyphot-engine/blob/V1.5/phot_engine/docs/%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97.md)

## 5 调试方法
### 5.1 使用PyCharm 进行调试：
    - 在 PyCharm 中打开项目目录。
    - 配置 Python 虚拟环境为项目解释器。
    - 在需要调试的模块中设置断点，使用 PyCharm 的调试功能进行单步跟踪
### 5.2 日志记录： 
Phot-Engine 提供内置日志系统，默认将日志输出到 logs/ 目录。日志等级可以通过配置文件调整，以帮助定位问题。

## 6 打包方式（whl类型）：
进入项目根目录后执行命令
```shell
cd to pyphot-engine
python setup.py bdist_wheel
```

## 7 部署步骤：
将第6步打包的引擎whl文件集成至phot-server即可。
```
pip install phot_engine-1.5.0-py3-none-any.whl
```