Logo
latest

快速入门

  • 概述
  • 安装
    • 第 1 步:下载
    • 第 2 步:安装
    • 第 3 步:运行算例
    • 第 4 步:作为 Python 库使用 PREP-SHOT
  • Quickstart (30 minutes)
    • Scenario background
    • Step 1 – Install (5 minutes)
    • Step 2 – Solve the shipped example (5 minutes)
    • Step 3 – Open the results (10 minutes)
    • Step 4 – Change one input and re-solve (5 minutes)
    • Step 5 – Where to next
  • Thailand (single-zone, CEM)
    • Existing fleet (2023)
    • Per-station hydropower characteristics
    • Inspect a solve (after running python run.py)
    • Common plots from a solved baseline
      • Installed capacity
      • Annual generation mix
      • Daily dispatch profile
      • Cost breakdown
    • Where to next
  • Southeast Asia (Lower Mekong, 5 zones, CEM)
    • 1. The scenario
    • 2. Demand profiles by country
    • 3. The existing fleet (2020)
    • 4. Per-station hydropower
    • 5. Inter-country transmission
    • 6. Running a full capacity-expansion solve
    • 7. Post-solve diagnostics: common plots from a solved baseline
      • 7.1 Capacity buildout
      • 7.2 Generation mix
      • 7.3 Emissions vs the carbon cap
      • 7.4 Cost breakdown
    • 8. What this case study shows that aggregated models miss
    • Where to next
  • Thailand (full-nodal, PCM)
    • 1. Source data
    • 2. Conversion: zones, techs, fleet
    • 3. Load + VRE capacity factors + hydro inflow
    • 4. Transmission topology
    • 5. Per-station hydropower
    • 6. Input visualisations
      • 6.1 Bus locations and demand
      • 6.2 Transmission network
      • 6.3 Fleet composition by carrier
      • 6.4 Annual demand profile
      • 6.5 Resource samples: a VRE plant and a hydro station
    • 7. Running the PCM rolling-horizon driver
    • 8. Knobs to flip on for higher fidelity
    • 9. Status
    • 10. Result analysis
      • 10.1 Annual generation by carrier
      • 10.2 Peak-week hourly dispatch
      • 10.3 Load-shedding hotspots
      • 10.4 Top transmission corridors
      • 10.5 Hydro: per-station discharge profiles
      • 10.6 Locational marginal prices (LMP)

Validation Benchmarks

  • PJM 5-bus benchmark
    • 1. Data source and references
    • 2. Topology and merit order
    • 3. Run PCM
    • 4. Validation
    • 5. Notes
    • See also
  • IEEE RTS-79 benchmark (24-bus, full-year)
    • 1. Data sources and references
    • 2. Topology and merit order
    • 3. Annual load profile
    • 4. Run full-year PCM
    • 5. Validation
    • 6. Notes
    • See also
  • IEEE RTS-96 benchmark (3-area, 73-bus, full-year)
    • 1. Data sources and references
    • 2. Topology and inventory
    • 3. Run full-year PCM (3 areas)
    • 4. Validation: dispatch is exactly 3 x RTS-79
    • 5. Notes
    • See also

用户指南

  • 模型输入与输出
    • 输入文件格式
    • 输入
      • 必备输入
      • 水电输入 (在 config.json 中 isinflow=true 时启用)
      • 可选输入 (缺失时跳过)
    • 输出
    • 运行情景
    • 设置全局参数
  • Mathematical Notation
    • Unit List
    • Set List
    • Variable List
    • Parameter List
    • Objective Functions
      • Costs
      • Factors
    • Constraints
      • Retirement
      • Carbon Emission
      • Power Balance
      • Transmission
      • Power Output
      • Power output variation
      • Energy storage
      • Water balance
      • Reservoir outflow
      • Reservoir storage
  • 术语表
    • Terminology
    • Further reading
  • 如何做(How-To)
    • 新增一个技术
      • 步骤
      • 验证
      • 常见陷阱
    • 收紧碳排放上限
      • 步骤
      • 验证
      • 自定义上限区域
      • 常见陷阱
    • 对比两个情景
      • 准备
      • 做法
      • 绘制装机重组
      • 常见陷阱
    • 查看节点边际电价 (LMP)
      • 做法
      • 符号约定
      • 净现值 vs 实际年度价格
      • 常见陷阱
    • 新增梯级水电系统
      • 步骤
      • 验证
      • 常见陷阱

参考

  • API Reference
    • cli
      • main()
    • set_up
      • initialize_environment()
      • parse_cli_arguments()
    • logs
      • log_parameter_info()
      • setup_logging()
      • timer()
    • load_data
      • check_schema()
      • compute_active_lines()
      • compute_active_zone_tech()
      • compute_cost_factors()
      • extract_config_data()
      • extract_sets()
      • load_excel_data()
      • load_json()
      • process_data()
      • read_long_csv()
    • solver
      • get_solver()
      • set_solver_parameters()
      • solve_model()
    • model
      • create_model()
      • define_active_zone_tech()
      • define_basic_sets()
      • define_complex_sets()
      • define_constraints()
      • define_model()
      • define_variables()
    • constraints
      • co2
        • AddCo2EmissionConstraints
      • cost
        • AddCostObjective
      • dc_flow
        • N-1 security-constrained mode (v1.18+)
        • AddDCFlowConstraints
      • demand
        • AddDemandConstraints
      • finance
        • AddFinanceConstraints
      • generation
        • AddGenerationConstraints
      • head_iteration
        • compute_error()
        • initialize_waterhead()
        • process_model_solution()
        • run_model_iteration()
      • heat_rate
        • Inputs
        • Constraints
        • Config
        • AddHeatRateConstraints
        • add_heat_rate_fuel_cost()
        • techs_with_heat_rate_curve()
      • hydro
        • AddHydropowerConstraints
      • investment
        • AddInvestmentConstraints
      • reserve
        • Default product set
        • Constraints
        • Inputs
        • AddReserveConstraints
      • storage
        • AddStorageConstraints
      • transmission
        • AddTransmissionConstraints
      • unit_commitment
        • Configuration
        • Inputs
        • AddUnitCommitmentConstraints
        • add_uc_cost_terms()
    • pcm
      • Why rolling horizon?
      • Capacity source
      • Config
      • Output
      • CLI
      • load_fixed_capacity()
      • main()
      • run_pcm()
    • utils
      • calc_cost_factor()
      • calc_interest_rate()
      • calc_inv_cost_factor()
      • cartesian_product()
      • check_positive()
      • interpolate_z_by_q_or_s()
      • sparse_tupledict()
    • output_data
      • create_data_array()
      • extract_results_hydro()
      • extract_results_non_hydro()
      • save_result()
      • save_to_excel()
      • update_output_filename()
  • Stability policy
    • v1.x -- research / evolving (current)
    • v2.0 -- stable (planned)
  • Changelog
    • Version 1.25.0 - May 8, 2026
      • Added
      • Notes
    • Version 1.24.0 - May 8, 2026
      • Why
      • Added
      • Notes
    • Version 1.23.0 - May 8, 2026
      • Why
      • Added
      • Notes
    • Version 1.22.0 - May 8, 2026
      • Why
      • Added
      • Changed
      • Notes
    • Version 1.21.0 - May 7, 2026
      • Why
      • Added
      • Changed
      • Caveats
    • Version 1.20.0 - May 7, 2026
      • Why
      • Added
      • Changed
      • Performance
      • Notes
    • Version 1.19.1 - May 6, 2026
      • Why
      • Changed
      • Notes
    • Version 1.19.0 - May 6, 2026
      • Added
      • Default heat-rate curves shipped
      • Per-example wiring
      • Regression
    • Version 1.18.0 - May 6, 2026
      • Added
      • Implementation notes
      • Changed
      • Verified
    • Version 1.17.0 - May 6, 2026
      • Added
      • Changed
      • Verified
      • Known limitations
    • Version 1.16.0 - May 6, 2026
      • Default product set
      • Schema change (BREAKING)
      • Constraints
      • Output
      • Eligibility defaults shipped
      • Default requirement values
      • Regression
    • Version 1.15.0 - May 6, 2026
      • Added
      • Changed
      • Performance notes
    • Version 1.14.1 - May 5, 2026
      • Added
      • Known limitations
    • Version 1.14.0 - May 5, 2026
      • Added
      • Changed
      • Known limitations (v1.14.0 alpha)
    • Version 1.13.0 - May 5, 2026
      • Added
      • Changed
    • Version 1.12.0 - May 5, 2026
      • Added
      • Changed
      • Fixed
    • Version 1.11.1 - May 5, 2026
      • Added
      • Changed
      • Removed
      • Notes
    • Version 1.11.0 - May 5, 2026
      • Added
      • Changed
      • Removed
    • Version 1.10.0 - May 5, 2026
      • Added
      • Changed
      • Removed
    • Version 1.9.1 - May 3, 2026
      • Added
      • Notes
    • Version 1.9.0 - May 3, 2026
      • Added
      • Changed
      • Notes
    • Version 1.8.1 - May 3, 2026
      • Fixed
    • Version 1.8.0 - May 3, 2026
      • Added
      • Removed
      • Changed
    • Version 1.7.0 - May 3, 2026
      • Added
      • Removed
      • Changed
    • Version 1.6.0 - May 3, 2026
      • Removed
      • Changed
      • Fixed
    • Version 1.5.0 - May 2, 2026
      • Added
      • Changed (Breaking)
      • Annotation columns
      • Column renames for clarity
      • Group 3 migration
      • Migration notes
    • Version 1.4.0 - May 2, 2026
      • Why long-format
      • Added
      • Changed
      • Migration notes
    • Version 1.3.2 - May 2, 2026
      • Added
    • Version 1.3.1 - May 2, 2026
      • Changed
      • Tested with
      • Migration notes
    • Version 1.3.0 - May 2, 2026
      • Added
      • Changed
      • Removed
    • Version 1.2.0 - May 2, 2026
      • Added
      • Changed
      • Migration notes
    • Version 1.1.2 - May 2, 2026
      • Added
      • Fixed
    • Version 1.1.1 - May 2, 2026
      • Added
      • Changed
      • Fixed
    • Version 1.1.0 - May 2, 2026
      • Added
      • Changed (Breaking)
    • Version 1.0 - Jul 21, 2025
    • Version 0.1.2 - Jul 22, 2024
      • Added
      • Fixed
      • Changed
    • Version 0.1.1 - Jul 11, 2024
      • Added
      • Fixed
      • Changed
      • Deprecated
    • Version 0.1.0 - Jun 24, 2024

社区

  • Discussion
    • GitHub Discussions
    • Private Queries
  • 贡献指南
    • 开发流程
    • 构建文档
    • 贡献规范
    • Translating the Documentation
  • Citation Guide
    • Publications by Topic
  • References
PREP-SHOT
    • 搜索
    Learn how to contribute!


© 版权所有 2023-2025, Zhanwei Liu and Xiaogang He (GPL-3.0).

Built with Sphinx using a theme provided by Read the Docs.
v: latest (zh-CN)
Versions
latest
v1.0
Languages
English
简体中文
On GitHub
Project home
Issues