136 lines
5.0 KiB
Markdown
136 lines
5.0 KiB
Markdown
# 项目结构说明
|
||
|
||
## 目录结构
|
||
|
||
```
|
||
D:\code\storage\
|
||
├── src/ # 核心源代码
|
||
│ ├── storage_optimization.py # 储能容量优化核心模块
|
||
│ ├── excel_reader.py # Excel数据读取模块
|
||
│ ├── economic_optimization.py # 经济优化模块
|
||
│ ├── solar_optimization.py # 太阳能优化模块
|
||
│ └── advanced_visualization.py # 高级可视化模块
|
||
│
|
||
├── tests/ # 测试文件
|
||
│ ├── test_*.py # 所有Python测试文件
|
||
│ ├── test_*.xlsx # 测试Excel文件
|
||
│ ├── extreme_*.xlsx # 极端场景测试文件
|
||
│ └── test_zero_grid_simple.py # 简化版测试文件
|
||
│
|
||
├── config/ # 配置文件
|
||
│ ├── pyproject.toml # 项目配置
|
||
│ ├── requirements.txt # 依赖配置
|
||
│ ├── uv.lock # uv锁定文件
|
||
│ └── main.spec # PyInstaller配置
|
||
│
|
||
├── docs/ # 文档文件
|
||
│ ├── README.md # 项目主文档
|
||
│ └── README_exe.md # 可执行文件说明
|
||
│
|
||
├── scripts/ # 示例和演示脚本
|
||
│ ├── example_usage.py # 使用示例
|
||
│ ├── solar_optimization_examples.py # 太阳能优化示例
|
||
│ └── solar_scenarios_demo.py # 太阳能场景演示
|
||
│
|
||
├── images/ # 图片文件
|
||
│ ├── *.png # 所有生成的图表和可视化图片
|
||
│
|
||
├── templates/ # Excel模板文件
|
||
│ ├── data_template_*.xlsx # 数据模板
|
||
│ ├── economic_data_template_*.xlsx # 经济优化模板
|
||
│ └── data_template_*-*.xlsx # 临时和修改的模板
|
||
│
|
||
├── results/ # 优化结果文件
|
||
│ └── storage_optimization_results_*.xlsx # 储能优化结果
|
||
│
|
||
├── reports/ # 报告文件
|
||
│ └── economic_optimization_report_*.xlsx # 经济优化报告
|
||
│
|
||
├── build/ # 构建输出
|
||
├── dist/ # 分发文件
|
||
├── __pycache__/ # Python缓存
|
||
├── .mypy_cache/ # MyPy缓存
|
||
├── .vscode/ # VS Code配置
|
||
├── .gitignore # Git忽略文件
|
||
├── .python-version # Python版本
|
||
└── main.py # 主程序入口
|
||
```
|
||
|
||
## 文件分类说明
|
||
|
||
### 📁 **src/** - 核心源代码
|
||
- **storage_optimization.py**: 储能容量优化的核心算法
|
||
- **excel_reader.py**: Excel文件读取和数据验证
|
||
- **economic_optimization.py**: 经济指标优化模块
|
||
- **solar_optimization.py**: 太阳能系统优化
|
||
- **advanced_visualization.py**: 高级数据可视化
|
||
|
||
### 📁 **tests/** - 测试文件
|
||
- 所有 `test_*.py` 文件：单元测试和集成测试
|
||
- 所有 `test_*.xlsx` 文件：测试用Excel数据
|
||
- `extreme_*.xlsx`：极端场景测试数据
|
||
|
||
### 📁 **config/** - 配置文件
|
||
- **pyproject.toml**: 项目元数据和依赖管理
|
||
- **requirements.txt**: Python依赖包列表
|
||
- **uv.lock**: 依赖版本锁定文件
|
||
- **main.spec**: PyInstaller打包配置
|
||
|
||
### 📁 **docs/** - 文档
|
||
- **README.md**: 项目主文档
|
||
- **README_exe.md**: 可执行文件使用说明
|
||
|
||
### 📁 **scripts/** - 示例和演示
|
||
- **example_usage.py**: 基本使用示例
|
||
- **solar_optimization_examples.py**: 太阳能优化示例
|
||
- **solar_scenarios_demo.py**: 太阳能场景演示
|
||
|
||
### 📁 **images/** - 图片文件
|
||
- 所有 `.png` 文件：系统生成的图表和可视化结果
|
||
|
||
### 📁 **templates/** - Excel模板
|
||
- **data_template_*.xlsx**: 基础数据模板
|
||
- **economic_data_template_*.xlsx**: 经济优化模板
|
||
- 临时和修改的模板文件
|
||
|
||
### 📁 **results/** - 优化结果
|
||
- **storage_optimization_results_*.xlsx**: 储能优化计算结果
|
||
|
||
### 📁 **reports/** - 报告文件
|
||
- **economic_optimization_report_*.xlsx**: 经济优化分析报告
|
||
|
||
## 使用说明
|
||
|
||
### 运行主程序
|
||
```bash
|
||
uv run python main.py --excel templates/data_template_8760.xlsx
|
||
```
|
||
|
||
### 运行测试
|
||
```bash
|
||
uv run python tests/test_excel_data.py
|
||
```
|
||
|
||
### 运行示例
|
||
```bash
|
||
uv run python scripts/example_usage.py
|
||
```
|
||
|
||
### 创建Excel模板
|
||
```bash
|
||
uv run python src/excel_reader.py --economic
|
||
```
|
||
|
||
## 注意事项
|
||
|
||
1. **导入路径**: 由于文件移动，可能需要调整Python导入路径
|
||
2. **相对路径**: 某些脚本中的文件路径可能需要更新
|
||
3. **配置文件**: pyproject.toml等配置文件位置已改变
|
||
4. **可执行文件**: 如果使用了打包的exe，需要检查路径引用
|
||
|
||
## 维护建议
|
||
|
||
- 定期清理 `results/` 和 `reports/` 中的旧文件
|
||
- 保持 `templates/` 中的模板文件更新
|
||
- 及时更新 `config/` 中的依赖配置
|
||
- 维护 `docs/` 中的文档与代码同步 |