code/PROJECT_FILES_DETAILED_GUIDE.md

# SolarChain-Eval 项目文件详细说明

本文档对当前 `SolarChain-Eval` 仓库中的文件进行系统说明。它面向需要快速理解项目结构、实验逻辑、代码职责、数据来源、输出文件和论文流水线的人。

## 1. 项目总体介绍

`SolarChain-Eval` 是一个面向去中心化能源市场的强化学习评估基准项目。它的核心目标不是简单训练一个收益最高的智能体，而是评估自治经济治理 agent 是否能在受物理约束的能源市场中安全、稳定、可审计地做出治理决策。

项目关注的问题可以概括为：

- 能源节点上报的发电量是否符合太阳能物理上限 `P_max`。
- 市场流动性、奖励分配和代币燃烧策略如何影响交易匹配、滑点和价格稳定性。
- PPO、SAC、DQN 等强化学习策略是否会为了收益利用不可信发电报告。
- 固定规则、随机策略、短视贪心策略和 RL 策略之间在收益、安全、稳定、公平上的差异。
- 移除物理惩罚后，agent 是否更容易制造 `artificial_liquidity_MWh` 等不可信行为。

整个项目围绕一个 Gymnasium 环境 `SolarChainBenchmarkEnv` 展开。环境每一步代表一个小时，agent 输出三个经济治理动作：

- `reward_ratio`：有多少背书电量进入奖励分配。
- `liquidity_ratio`：有多少背书电量用于增加市场流动性。
- `burn_rate`：代币燃烧率，影响有效需求和价格动态。

环境会把这些动作放进能源供给、P2P 交易需求、物理约束、城市奖励、流动性池和代币价格模型中，最终计算奖励和一组可信度指标。

## 2. 项目主流程

项目从数据到论文结果的主流程如下：

1. `scripts/generate_monthly_datasets.py` 生成或刷新五城市月度数据。
2. `configs/*.yaml` 定义实验参数、动作边界、奖励惩罚和训练设置。
3. `src/solarchain_eval/data.py` 读取 CSV 数据，生成按城市和绝对小时聚合的物理特征。
4. `src/solarchain_eval/env.py` 构建 Gymnasium 强化学习环境。
5. `src/solarchain_eval/actions.py` 负责连续动作、离散动作和真实动作之间的转换与约束。
6. `src/solarchain_eval/policies.py` 提供内置 baseline 策略。
7. `src/solarchain_eval/train.py` 使用 Stable-Baselines3 训练 PPO、SAC、DQN。
8. `src/solarchain_eval/evaluate.py` 统一评估内置策略和训练好的 RL 模型。
9. `src/solarchain_eval/metrics.py` 汇总每个 episode 的可信度指标。
10. `src/solarchain_eval/figures.py` 生成论文图表。
11. `paper_pipeline/*.sh` 串起 Linux 上的 setup、smoke check、完整论文实验、图表和 manifest。

## 3. 根目录文件

### `.gitignore`

这是 Git 忽略规则文件，主要排除 Python 缓存、虚拟环境、构建产物、测试缓存、日志、数据库、本地环境文件等。它避免把 `__pycache__`、`.venv`、`build/`、`dist/`、`.pytest_cache/` 等临时文件提交到版本库。

### `README.md`

项目入口说明文档。它介绍了项目名称、项目定位、安装方式、快速 smoke run、完整 baseline 运行方式、Linux 论文流水线和主要输出文件。

其中最重要的信息包括：

- 安装方式：`pip install -e .`
- 快速评估：`python scripts/evaluate.py --policies "static,random,myopic" --episodes 1`
- 完整 baseline：`python scripts/run_all_baselines.py --timesteps 2048 --episodes 2`
- 论文流水线：`paper_pipeline/00_setup_linux.sh`、`01_smoke_check.sh`、`02_run_paper_experiments.sh`
- 输出文件：`metrics.csv`、`summary.json`、`actions.csv`、`city_hour_policy.csv`、`config_snapshot.json`
- 关键指标：`physics_violation_rate`、`max_drawdown`、`action_jitter`、`slippage_reduction_vs_static`、`spatial_fairness_index`、`artificial_liquidity_MWh`

### `LICENSE`

项目许可证文件，采用 MIT License。版权归 `GreenComp-ERC`，年份为 2026。MIT 许可证允许用户自由使用、复制、修改、合并、发布、分发、再授权和销售软件，但需要保留版权和许可声明。

### `pyproject.toml`

Python 包配置文件。它说明该项目是一个可安装的 Python 包：

- 包名：`solarchain-eval`
- 版本：`0.1.0`
- Python 要求：`>=3.10`
- 包源码位置：`src`
- 构建系统：`setuptools`

主要依赖包括：

- `gymnasium`：强化学习环境接口。
- `stable-baselines3`：PPO、SAC、DQN 算法实现。
- `torch`：深度学习后端。
- `numpy`、`pandas`：数值计算和表格数据处理。
- `matplotlib`：图表生成。
- `pvlib`：太阳能物理模型。
- `requests`：请求 Open-Meteo 历史天气 API。

### `requirements.txt`

传统 pip 依赖列表。它与 `pyproject.toml` 中的依赖基本一致，但额外包含 `pytest>=8.0`，用于运行测试。

## 4. 配置目录 `configs/`

### `configs/default.yaml`

默认实验配置，使用 `data/datasets` 这个 24 小时小数据集。适合快速调试、单日 smoke run 和本地快速验证。

关键配置：

- `seed: 20260511`：全局随机种子。
- `episode_steps: 24`：每个 episode 运行 24 个小时。
- `data_dir: data/datasets`：默认数据目录。
- `output_dir: outputs/runs`：默认实验输出目录。
- `figures_dir: figures`：默认图表输出目录。
- `action_mode: continuous`：默认连续动作空间。
- `discrete_levels: 5`：DQN 离散动作网格每个维度 5 档，总动作数为 `5 x 5 x 5 = 125`。
- `no_physics_penalty: false`：默认保留物理违规惩罚。

`market` 段定义市场和动作边界：

- 初始流动性和代币价格均为 `1.0`。
- `reward_ratio` 范围为 `0.05` 到 `0.65`。
- `liquidity_ratio` 范围为 `0.20` 到 `0.95`。
- `burn_rate` 最大为 `0.20`。
- `reward_ratio + liquidity_ratio` 最大为 `0.98`。
- 静态策略为 `reward_ratio=0.25`、`liquidity_ratio=0.75`、`burn_rate=0.02`。

`reward` 段定义奖励函数惩罚项：

- `drawdown_penalty: 1.50`
- `action_jitter_penalty: 0.25`
- `unmet_demand_penalty: 0.40`
- `physics_penalty: 2.00`
- `fairness_penalty: 0.20`

`training` 段定义训练超参数：

- `timesteps: 10000`
- `learning_rate: 0.0003`
- `batch_size: 64`
- `gamma: 0.98`

`evaluation` 段默认评估 `static`、`random`、`myopic` 三个内置策略。

### `configs/month_2026_04.yaml`

月度论文主配置。它与 `default.yaml` 大体相同，但把 `data_dir` 改为 `data/datasets_2026_04_month`。

这个配置用于 2026 年 4 月整月五城市 benchmark：

- 数据窗口：`2026-04-01T00:00:00+08:00` 到 `2026-04-30T23:00:00+08:00`
- 共 720 个小时。
- 每个 episode 仍然是 24 小时。
- 环境 reset 时从完整日开头采样，即 `0, 24, 48, ..., 696`。

论文实验、完整 baseline、消融实验都应优先使用这个配置。

## 5. 核心源码目录 `src/solarchain_eval/`

### `src/solarchain_eval/__init__.py`

包入口文件。它导出三个最常用对象：

- `BenchmarkConfig`
- `SolarChainBenchmarkEnv`
- `load_config`

这样外部代码可以直接从 `solarchain_eval` 导入配置和环境。

### `src/solarchain_eval/config.py`

配置加载与配置数据结构定义文件。

它定义了以下 dataclass：

- `MarketConfig`：市场初始状态、动作边界、静态策略参数。
- `RewardConfig`：奖励函数中的各类惩罚权重。
- `TrainingConfig`：训练步数、学习率、batch size、折扣因子等。
- `EvaluationConfig`：评估 episode 数和默认策略列表。
- `BenchmarkConfig`：总配置对象，包含 seed、数据目录、输出目录、动作模式和上述子配置。

主要函数：

- `load_config(path, overrides=None)`：读取 YAML 配置文件并合并 override。
- `_deep_update(base, updates)`：递归合并配置覆盖项。
- `_parse_simple_yaml(text)`：当没有安装 PyYAML 时使用的简易 YAML 解析器。
- `_coerce_value(value)`：把字符串转换为 bool、int、float 或普通字符串。

这个文件的作用是把 YAML 配置转换成强类型 Python 对象，供环境、训练、评估和脚本使用。

### `src/solarchain_eval/actions.py`

动作编码、解码与安全约束文件。

项目中的真实治理动作是三维：

- `reward_ratio`
- `liquidity_ratio`
- `burn_rate`

强化学习模型输出通常是 `[0, 1]` 范围内的 raw action，因此需要转换成真实市场动作。

主要函数：

- `decode_continuous_action(raw_action, config)`：把连续 raw action 转换成真实动作，并处理 NaN、inf、越界值。
- `encode_actual_action(actual_action, config)`：把真实动作反向编码到 `[0, 1]` 范围，供内置策略统一接口使用。
- `sanitize_actual_action(actual_action, config)`：裁剪动作边界，并确保 `reward_ratio + liquidity_ratio <= max_total_allocation`。
- `discrete_action_grid(config)`：生成 DQN 使用的离散动作网格。
- `decode_discrete_action(action_index, config)`：把 DQN 输出的离散动作编号映射为真实动作。

这个文件保证策略不能直接输出违反市场预算约束的动作。

### `src/solarchain_eval/data.py`

数据读取和物理特征构造文件。

主要对象：

- `DEFAULT_CITIES`：固定五城市列表：Beijing、Shanghai、Chengdu、Shenzhen、Hangzhou。
- `BenchmarkData`：数据容器，包含 `nodes`、`generation`、`market`、`trades`、`city_hour`、`cities`、`hour_count`。

主要函数：

- `load_benchmark_data(data_dir)`：读取四个 CSV 文件，并构造环境需要的聚合特征。
- `_add_absolute_hour_columns(...)`：根据 timestamp 生成连续的 `absolute_hour` 和小时-of-day `hour`。

它读取的四个 CSV 文件是：

- `urban_energy_nodes.csv`
- `spatiotemporal_generation.csv`
- `market_liquidity.csv`
- `p2p_trades.csv`

加载后会构造以下关键字段：

- `verified_W`：只有 `verification_status == "verified"` 的上报发电量才计入可信供给。
- `physics_excess_W`：`max(P_reported_W - P_max_W, 0)`。
- `physics_violation`：如果超过 `P_max` 或 `fdia_detected=True`，则认为存在物理/攻击违规。
- `rejected_reported_W`：违规记录中被拒绝的上报发电量。

最后会按 `city + absolute_hour + hour` 聚合出 `city_hour` 表。这个设计非常重要，因为月度数据有 30 天，如果只按 `city + hour` 聚合，会把不同日期同一小时混在一起。当前代码用 `absolute_hour` 保证每个真实小时独立。

### `src/solarchain_eval/env.py`

项目最核心文件，定义 Gymnasium 环境 `SolarChainBenchmarkEnv`。

环境职责：

- 定义 action space。
- 定义 observation space。
- 在 reset 时初始化流动性、价格、峰值、历史动作和城市奖励。
- 在 step 中执行市场状态转移。
- 计算每小时奖励和可信度指标。

动作空间：

- 连续模式：`Box(low=0.0, high=1.0, shape=(3,))`
- 离散模式：`Discrete(125)`，用于 DQN。

观测空间为 12 维：

1. `sin(hour)`
2. `cos(hour)`
3. `verified_mwh`
4. `reported_mwh`
5. `pmax_mwh`
6. `supply-demand gap`
7. 当前流动性
8. 当前代币价格
9. 原始物理违规率
10. 静态市场滑点
11. 上一步 `reward_ratio`
12. 上一步 `liquidity_ratio`

`step()` 的主要逻辑：

1. 解码策略动作。
2. 找到当前 `absolute_hour` 对应的城市发电聚合数据。
3. 汇总 verified、reported、P_max、excess、rejected 等供给信息。
4. 从 P2P trades 中读取需求，若没有交易则用市场 verified supply 作为 fallback demand。
5. 计算 unsafe supply 与 unsafe backed supply。
6. 根据 `liquidity_ratio` 增加市场流动性。
7. 根据 `burn_rate` 调整有效需求。
8. 计算 matched energy、unmet demand、流动性 drawdown、slippage。
9. 根据供需、成交、燃烧、滑点、奖励 token 和噪声更新 token price。
10. 按城市 verified supply 占比分配奖励，并用 violation rate 做 trust discount。
11. 计算最终 reward。
12. 写出 `info`，供评估和指标汇总使用。

重要输出指标包括：

- `verified_supply_MWh`
- `reported_supply_MWh`
- `physics_excess_MWh`
- `unsafe_backed_MWh`
- `artificial_liquidity_MWh`
- `physics_violation_rate`
- `raw_physics_record_rate`
- `demand_MWh`
- `matched_energy_MWh`
- `unmet_demand_MWh`
- `liquidity`
- `liquidity_depth`
- `token_price`
- `max_drawdown`
- `token_drawdown`
- `action_jitter`
- `slippage`
- `city_rewards`

### `src/solarchain_eval/metrics.py`

指标计算文件。它把每个 episode 的小时级日志压缩成 episode 级指标。

主要函数：

- `max_drawdown(values)`：计算序列从历史峰值回撤的最大比例。
- `action_jitter(actions)`：计算连续动作之间的平均 L1 变化，衡量策略是否抖动。
- `spatial_fairness_index(city_rewards)`：用城市奖励方差相对平均绝对奖励衡量空间公平性。
- `summarize_episode(rows)`：汇总一个 episode 的全部指标。

`summarize_episode` 输出：

- `cumulative_reward`
- `episode_volume`
- `physics_violation_rate`
- `max_drawdown`
- `max_token_drawdown`
- `action_jitter`
- `mean_slippage`
- `spatial_fairness_index`
- `artificial_liquidity_MWh`
- `final_liquidity`
- `final_token_price`

这些指标最终会进入 `metrics.csv` 和 `summary.json`。

### `src/solarchain_eval/policies.py`

内置 baseline 策略文件。

它定义了一个 `Policy` 协议，要求策略至少有：

- `name`
- `predict(obs, deterministic=True)`

内置策略：

- `StaticPolicy`：固定使用配置中的 `static_reward_ratio`、`static_liquidity_ratio`、`static_burn_rate`，对应 Static 1:3 baseline。
- `RandomPolicy`：在三维动作空间中均匀随机采样。
- `MyopicGreedyPolicy`：根据当前供需 gap、流动性和违规情况做短视规则决策。

辅助函数：

- `make_builtin_policy(name, config, seed=None)`：根据名称构造内置策略。

这个文件让项目即使不训练 RL 模型，也能进行基础 benchmark。

### `src/solarchain_eval/train.py`

Stable-Baselines3 训练逻辑文件。

主要函数：

- `make_env(config)`：加载数据并返回一个被 `Monitor` 包装的环境 factory。
- `train_model(algo, config, timesteps, output_dir)`：训练指定算法并保存模型。

支持算法：

- `ppo`：连续动作，使用 PPO。
- `sac`：连续动作，使用 SAC。
- `dqn`：离散动作，使用 DQN，并自动把 `action_mode` 切到 `discrete`。

模型输出路径形如：

- `outputs/runs/<run_id>/models/ppo/ppo_model.zip`
- `outputs/runs/<run_id>/models/sac/sac_model.zip`
- `outputs/runs/<run_id>/models/dqn/dqn_model.zip`

### `src/solarchain_eval/evaluate.py`

策略评估逻辑文件。它统一评估内置策略和训练好的 Stable-Baselines3 模型。

主要函数：

- `run_episode(policy, config, seed, episode, policy_name=None)`：运行一个策略的单个 episode，返回 episode 指标和小时级日志。
- `evaluate_policies(policies, config, episodes, output_dir)`：评估多个策略多个 episode，并写出 CSV/JSON。
- `_json_dumps_dataclass(config)`：把配置对象写成 JSON。

主要类：

- `SB3Policy`：包装 Stable-Baselines3 模型，使 PPO/SAC/DQN 和内置策略拥有统一的 `predict()` 接口。

输出文件：

- `metrics.csv`：policy x episode 级指标。
- `actions.csv`：每小时动作和环境 info。
- `city_hour_policy.csv`：每小时每城市奖励和动作信息。
- `summary.json`：按 policy 聚合的平均指标，并计算相对 static 的滑点改善。
- `config_snapshot.json`：保存本次运行使用的配置快照。

### `src/solarchain_eval/figures.py`

图表生成文件。

主要函数：

- `setup_style()`：设置 matplotlib 风格。
- `make_figures(run_dir, figures_dir)`：读取运行结果并生成三张图。
- `_policy_heat(heat_source, policy)`：生成城市 x 小时的 liquidity heatmap 数据。

输出图表：

- `learning_curves.png`：不同策略的累计奖励随 episode 变化。
- `safety_utility_frontier.png`：物理违规率与累计奖励的 tradeoff。
- `city_hour_liquidity_heatmap.png`：城市-小时流动性分配热力图，对比 Static 1:3 和优先选择的 agent 策略。

### `src/solarchain_eval/run_metadata.py`

实验元数据记录文件。

主要函数：

- `write_run_metadata(output_dir, run_type, args, config, extra=None)`：写出 `run_metadata.json`。

元数据包括：

- 运行类型。
- UTC 创建时间。
- 命令行参数。
- Python 解释器路径。
- 操作系统平台。
- Git commit。
- Git status。
- 解析后的配置。
- 额外信息，例如模型路径和策略列表。

这个文件保证实验可追踪、可复现、可审计。

## 6. 命令行脚本目录 `scripts/`

### `scripts/evaluate.py`

命令行评估入口。

常见用法：

```bash
python scripts/evaluate.py --policies "static,random,myopic" --episodes 1
```

支持参数：

- `--config`：配置文件路径。
- `--policies`：逗号分隔的策略名。
- `--episodes`：评估 episode 数。
- `--output-dir`：输出根目录。
- `--ppo-model`、`--sac-model`、`--dqn-model`：加载训练好的 RL 模型。
- `--run-name`：运行名称。
- `--no-timestamp`：不加时间戳，使用稳定输出路径。
- `--no-physics-penalty`：开启物理惩罚消融。

它会加载策略，调用 `evaluate_policies`，并写出 `run_metadata.json`。

### `scripts/train.py`

命令行训练入口。

常见用法：

```bash
python scripts/train.py --algo ppo --timesteps 10000
```

支持算法：

- `ppo`
- `sac`
- `dqn`

它会读取配置、解析训练步数、创建输出目录、调用 `train_model` 保存模型，并写出运行元数据。

### `scripts/run_all_baselines.py`

完整 baseline 运行脚本。它是项目最常用的 benchmark 入口。

主要流程：

1. 加载配置。
2. 可选训练 PPO、SAC、DQN。
3. 构造 Static、Random、Myopic 三个内置策略。
4. 加载训练好的 PPO、SAC、DQN 模型。
5. 统一评估全部策略。
6. 写出运行元数据。

常见用法：

```bash
python scripts/run_all_baselines.py --timesteps 2048 --episodes 2
```

如果只想跑内置策略，可以使用：

```bash
python scripts/run_all_baselines.py --skip-rl
```

### `scripts/generate_monthly_datasets.py`

月度数据生成脚本。它把天气、太阳物理模型、节点属性、攻击注入、市场流动性和 P2P 交易合成为四个 CSV 数据集。

默认设置：

- 时间窗口：`2026-04-01` 到 `2026-05-01`，右开区间。
- 时区：`Asia/Shanghai`
- 输出目录：`data/datasets_2026_04_month`
- 缓存目录：`data/cache`
- 随机种子：`20260511`
- 每个城市节点数：10
- 城市：Beijing、Shanghai、Chengdu、Shenzhen、Hangzhou

关键函数：

- `fetch_weather_cache()`：从 Open-Meteo Historical Weather API 拉取历史天气，或读取本地缓存。
- `make_nodes()`：生成城市能源节点，包括经纬度、面板面积、效率、温度系数、安装日期。
- `city_weather_frame()`：结合天气、pvlib clear-sky 和太阳位置计算辐照度。
- `make_generation()`：生成每个节点每小时的 `P_max_W` 和 `P_reported_W`，并注入约 5% FDIA 攻击。
- `make_market_liquidity()`：根据 verified generation 生成 SolarChain 和 baseline 流动性、滑点。
- `make_trades()`：生成工厂 P2P 购电记录。
- `write_datasets()`：写出四个 CSV，并打印数据规模。

生成的核心数据量：

- `urban_energy_nodes.csv`：50 行。
- `spatiotemporal_generation.csv`：36000 行。
- `market_liquidity.csv`：720 行。
- `p2p_trades.csv`：约 1185 行。
- FDIA 行数：1800 行。

### `scripts/make_figures.py`

命令行图表生成入口。

常见用法：

```bash
python scripts/make_figures.py --run-dir outputs/runs/<run_id>
```

它读取配置，调用 `solarchain_eval.figures.make_figures()`，并打印生成的图片路径。

## 7. 论文流水线目录 `paper_pipeline/`

### `paper_pipeline/README.md`

论文实验流水线说明文件。它描述 Linux 环境下如何 setup、生成数据、运行 smoke check、运行完整论文实验、理解输出结构、做超参数测试、重生成图表和整理论文表格。

它明确指出论文主实验应使用：

- `configs/month_2026_04.yaml`
- `data/datasets_2026_04_month`
- `[2026-04-01, 2026-05-01)` 五城市月度数据
- 720 个小时
- 每个 episode 24 步

### `paper_pipeline/IMPLEMENTATION_PLAN.md`

中文实现方案和实验范围说明。它解释项目为什么要做这个 benchmark、当前实现到什么程度、baseline 和指标有哪些、主运行方式是什么、输出结构是什么、验收标准是什么。

它也是项目最清晰的研究设计文档之一。

### `paper_pipeline/00_setup_linux.sh`

Linux 环境准备脚本。

主要步骤：

1. 定位仓库根目录。
2. 检查 conda 是否存在。
3. 激活 `SolarChain-rl` 环境。
4. 安装 `requirements.txt`。
5. 以 editable 模式安装当前包。
6. 打印 Python、Gymnasium、pvlib、Stable-Baselines3 版本。

### `paper_pipeline/01_smoke_check.sh`

完整实验前的快速健康检查脚本。

主要步骤：

1. 确保 2026-04 五城市月度数据存在，不存在则生成。
2. 校验数据规模：50 个节点、36000 条 generation、720 个小时、720 条 market。
3. 编译 `src`、`scripts`、`tests`。
4. 评估 `static,random,myopic` 一个 episode。
5. 训练一个 5 timestep 的 DQN 小模型。
6. 生成 smoke figures。

这个脚本用于在长实验前确认代码、数据、依赖和图表路径都能跑通。

### `paper_pipeline/02_run_paper_experiments.sh`

完整论文实验主脚本。

默认参数：

- `CONFIG=configs/month_2026_04.yaml`
- `DATA_DIR=data/datasets_2026_04_month`
- `DATA_START_DATE=2026-04-01`
- `DATA_END_DATE=2026-05-01`
- `TIMESTEPS=100000`
- `EPISODES=10`
- `PAPER_RUN_ID=<utc_timestamp>_paper`

主要流程：

1. 确保并校验月度数据。
2. 写出 `dataset_summary.json`。
3. 写出 `paper_run_metadata.json`。
4. 运行主六 baseline 实验。
5. 运行 `--no-physics-penalty` 消融实验。
6. 为主实验和消融实验分别生成图表。
7. 调用 `04_write_results_manifest.sh` 写论文结果 manifest。

推荐最终论文运行：

```bash
PAPER_RUN_ID=paper_final TIMESTEPS=300000 EPISODES=30 bash paper_pipeline/02_run_paper_experiments.sh
```

### `paper_pipeline/03_make_figures_for_run.sh`

对已有 run 重新生成图表的脚本。

用法：

```bash
bash paper_pipeline/03_make_figures_for_run.sh outputs/runs/<run_id> outputs/paper_runs/<paper_run_id>/figures/custom
```

默认使用 `configs/month_2026_04.yaml`。

### `paper_pipeline/04_write_results_manifest.sh`

生成 `PAPER_RESULTS.md` 的脚本。

它把主实验、消融实验、模型文件、指标文件、图表文件和论文表格字段之间的关系写清楚。

输出文件：

- `outputs/paper_runs/<paper_run_id>/PAPER_RESULTS.md`

这个 manifest 是论文结果归档和审稿材料整理的索引。

## 8. 数据目录 `data/`

数据目录包含两个数据集和一个天气缓存。

### `data/datasets/`

默认小数据集，适合快速调试。它覆盖 2026-05-01 一天，共 24 小时。

#### `data/datasets/urban_energy_nodes.csv`

城市能源节点表。

规模：

- 50 行数据。
- 5 个城市，每个城市 10 个节点。

字段：

- `node_id`：节点编号，例如 `BEI-001`。
- `city`：城市名称。
- `latitude`：节点纬度。
- `longitude`：节点经度。
- `panel_area_m2`：太阳能板面积。
- `efficiency`：光伏转换效率。
- `temp_coefficient`：温度系数。
- `install_date`：安装日期。

#### `data/datasets/spatiotemporal_generation.csv`

节点级时空发电表。

规模：

- 1200 行。
- 24 个小时 x 50 个节点。
- 时间范围：`2026-05-01T00:00:00+08:00` 到 `2026-05-01T23:00:00+08:00`。
- FDIA 行数：60。

字段：

- `timestamp`：带时区时间戳。
- `hour`：小时-of-day。
- `node_id`：能源节点编号。
- `city`：城市。
- `latitude`、`longitude`：节点位置。
- `irradiance_Wm2`：辐照度。
- `air_temp_C`：气温。
- `P_max_W`：基于物理模型估算的最大发电功率。
- `P_reported_W`：节点上报发电功率。
- `fdia_detected`：是否检测到虚假数据注入攻击。
- `verification_status`：`verified` 或 `rejected`。

#### `data/datasets/market_liquidity.csv`

小时级市场流动性表。

规模：

- 24 行。
- 时间范围与小数据集一致。

字段：

- `timestamp`
- `hour`
- `total_verified_MW`：总 verified 发电量。
- `solarchain_liquidity_MW`：SolarChain 市场流动性。
- `baseline_liquidity_MW`：baseline 市场流动性。
- `slippage_solarchain_pct`：SolarChain 滑点。
- `slippage_baseline_pct`：baseline 滑点。

#### `data/datasets/p2p_trades.csv`

P2P 交易表。

规模：

- 42 行。
- 涉及 14 个有交易的小时。
- 时间范围：`2026-05-01T06:00:00+08:00` 到 `2026-05-01T19:00:00+08:00`。

字段：

- `trade_id`：交易编号。
- `timestamp`
- `hour`
- `factory_id`：购电工厂编号。
- `city`
- `energy_purchased_MW`：购买电量。
- `tokens_burned`：燃烧 token 数量。
- `exergy_dissipated_MJ`：耗散 exergy。

### `data/datasets_2026_04_month/`

论文主月度数据集，覆盖 2026 年 4 月整月。

#### `data/datasets_2026_04_month/urban_energy_nodes.csv`

与小数据集字段相同。

规模：

- 50 行。
- 5 城市 x 每城 10 节点。

#### `data/datasets_2026_04_month/spatiotemporal_generation.csv`

月度节点级时空发电表。

规模：

- 36000 行。
- 720 个小时 x 50 个节点。
- 时间范围：`2026-04-01T00:00:00+08:00` 到 `2026-04-30T23:00:00+08:00`。
- FDIA 行数：1800。

字段与小数据集的 `spatiotemporal_generation.csv` 相同。

#### `data/datasets_2026_04_month/market_liquidity.csv`

月度市场流动性表。

规模：

- 720 行。
- 每个小时一行。

字段与小数据集的 `market_liquidity.csv` 相同。

#### `data/datasets_2026_04_month/p2p_trades.csv`

月度 P2P 交易表。

规模：

- 1185 行。
- 涉及 395 个有交易的小时。
- 时间范围：`2026-04-01T07:00:00+08:00` 到 `2026-04-30T19:00:00+08:00`。

字段与小数据集的 `p2p_trades.csv` 相同。

### `data/cache/open_meteo_weather_2026-04-01_2026-05-01.json`

Open-Meteo 历史天气缓存文件。它避免每次重新生成月度数据时都请求网络 API。

内容结构：

- 顶层 key 是城市名。
- 每个城市包含：
  - `source`
  - `latitude`
  - `longitude`
  - `timezone`
  - `time`
  - `temperature_2m_C`
  - `shortwave_radiation_Wm2`

该缓存覆盖五个城市，每个城市 720 个小时，时间范围为 2026-04-01 00:00 到 2026-04-30 23:00。

## 9. 图表目录 `figures/`

### `figures/.gitkeep`

占位文件。Git 默认不提交空目录，所以用 `.gitkeep` 保留 `figures/` 目录结构。

### `figures/solarchain_rl_method_framework.xml`

diagrams.net/draw.io 图源文件。它描述 SolarChain-Eval 的 RL 方法框架，包括：

- RL interaction loop。
- energy data、market data、physics labels。
- hourly encoder 和状态构造。
- policy 或 Q network。
- action selector 和 action sanitizer。
- physics gate、market clearing、ledger update、reward allocation。
- PPO、SAC、DQN 的学习更新。
- trustworthiness evaluation。
- paper-ready evidence。

这是方法图的源文件，不是程序运行依赖。

### `figures/solarchain_rl_trustworthiness_pipeline.xml`

diagrams.net/draw.io 图源文件。它描述可信度评估流水线，包括：

- 数据和物理特征构建。
- 配置与实验控制。
- Gymnasium 环境。
- 策略、训练和 baseline。
- 指标、输出文件和图表。
- 论文流水线与 KDD trustworthiness framing。

这个文件适合导出为论文或汇报中的系统 pipeline 图。

## 10. 输出目录 `outputs/`

### `outputs/runs/.gitkeep`

保留 `outputs/runs/` 目录。实际运行时，训练和评估结果会写入这里。

典型输出结构：

```text
outputs/runs/<run_id>/
  metrics.csv
  summary.json
  actions.csv
  city_hour_policy.csv
  config_snapshot.json
  run_metadata.json
  models/
    ppo/ppo_model.zip
    sac/sac_model.zip
    dqn/dqn_model.zip
```

### `outputs/paper_runs/.gitkeep`

保留 `outputs/paper_runs/` 目录。论文批量实验的 manifest、图表和 run 指针会写入这里。

典型输出结构：

```text
outputs/paper_runs/<paper_run_id>/
  paper_run_metadata.json
  dataset_summary.json
  main_run.txt
  ablation_run.txt
  PAPER_RESULTS.md
  figures/
    main/
    ablation_no_physics_penalty/
```

## 11. 测试目录 `tests/`

### `tests/test_actions_metrics_env.py`

单元测试和 smoke test 文件。

覆盖内容：

- 连续动作解码后维度正确。
- `reward_ratio + liquidity_ratio` 不超过 `max_total_allocation`。
- DQN 离散动作网格大小等于 `discrete_levels ** 3`。
- `max_drawdown`、`action_jitter`、`spatial_fairness_index` 的基本正确性。
- `static`、`random`、`myopic` 三种内置策略都能在环境中 step。
- 默认数据集能得到 24 个 `absolute_hour`。
- 多日数据环境 reset 只采样完整日开头。
- 指定 `start_hour=24` 时，环境会依次走过 24 到 47 小时。
- 高 backing 动作会带来不低于低 backing 动作的物理违规率。
- `artificial_liquidity_MWh` 会出现在 info 中。

这个测试文件对动作约束、指标函数、环境基础运行和月度数据索引逻辑提供了基本保障。

## 12. 项目运行建议

### 快速检查

```bash
python -m pytest
python scripts/evaluate.py --policies "static,random,myopic" --episodes 1
```

### 训练单个 RL 模型

```bash
python scripts/train.py --algo ppo --timesteps 10000
python scripts/train.py --algo sac --timesteps 10000
python scripts/train.py --algo dqn --timesteps 10000
```

### 跑完整 baseline

```bash
python scripts/run_all_baselines.py --timesteps 2048 --episodes 2
```

### 使用月度论文配置

```bash
python scripts/run_all_baselines.py \
  --config configs/month_2026_04.yaml \
  --timesteps 100000 \
  --episodes 10
```

### 跑物理惩罚消融

```bash
python scripts/run_all_baselines.py \
  --config configs/month_2026_04.yaml \
  --timesteps 100000 \
  --episodes 10 \
  --no-physics-penalty
```

### Linux 论文流水线

```bash
bash paper_pipeline/00_setup_linux.sh
bash paper_pipeline/01_smoke_check.sh
PAPER_RUN_ID=paper_final TIMESTEPS=300000 EPISODES=30 bash paper_pipeline/02_run_paper_experiments.sh
```

## 13. 关键设计点总结

这个项目的关键价值在于它把普通 RL benchmark 变成了一个可信度评估 benchmark。

普通 RL 项目通常只看 reward，而这里还同时记录：

- 物理违规率。
- 人造流动性。
- 市场流动性回撤。
- 代币价格回撤。
- 动作抖动。
- 城市奖励公平性。
- 相对静态策略的滑点改善。
- 完整动作轨迹和运行元数据。

因此，一个策略即使累计 reward 较高，也可能因为 `physics_violation_rate` 或 `artificial_liquidity_MWh` 过高而被判定为不可信。这个设计正是项目服务 KDD Agentic AI trustworthiness 方向的核心。