Logo
latest
  • Overview
  • Installation
    • Step 1: Download PREP-SHOT
    • Step 2: Install dependencies
    • Step 3: Run an example (Optional)
    • Step 4: Run your own model
  • Model Inputs/Outputs
    • Inputs
    • Outputs
    • Execute various scenarios
    • Setting global parameters
  • Tutorial
    • Scenario Background
  • 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
  • Discussion
    • GitHub Discussions
    • Private Queries
  • Contribution
    • Development Process
    • Building Documentation
    • Contributing Guidelines
  • Changelog
    • Version 0.1.0 - Jun 24, 2024
    • Version 0.1.1 - Jul 11, 2024
      • Added
      • Fixed
      • Changed
      • Deprecated
    • Version 0.1.2 - Jul 22, 2024
      • Added
      • Fixed
      • Changed
  • API Reference
    • set_up
      • initialize_environment()
      • parse_cli_arguments()
    • logs
      • log_parameter_info()
      • setup_logging()
      • timer()
    • load_data
      • compute_cost_factors()
      • extract_config_data()
      • extract_sets()
      • load_excel_data()
      • load_json()
      • process_data()
      • read_excel()
    • solver
      • get_solver()
      • set_solver_parameters()
      • solve_model()
    • model
      • create_model()
      • define_basic_sets()
      • define_complex_sets()
      • define_constraints()
      • define_model()
      • define_variables()
    • constraints
      • co2
        • AddCo2EmissionConstraints
      • cost
        • AddCostObjective
      • demand
        • AddDemandConstraints
      • generation
        • AddGenerationConstraints
      • head_iteration
        • compute_error()
        • initialize_waterhead()
        • process_model_solution()
        • run_model_iteration()
      • hydro
        • AddHydropowerConstraints
      • investment
        • AddInvestmentConstraints
      • nondispatchable
        • AddNondispatchableConstraints
      • storage
        • AddStorageConstraints
      • transmission
        • AddTransmissionConstraints
    • utils
      • calc_cost_factor()
      • calc_inv_cost_factor()
      • cartesian_product()
      • check_positive()
      • interpolate_z_by_q_or_s()
    • output_data
      • create_data_array()
      • extract_results_hydro()
      • extract_results_non_hydro()
      • save_result()
      • save_to_excel()
      • update_output_filename()
  • References
PREP-SHOT
    • Overview: module code
    Learn how to contribute!

All modules for which code is available

  • prepshot._model.co2
  • prepshot._model.cost
  • prepshot._model.demand
  • prepshot._model.generation
  • prepshot._model.head_iteration
  • prepshot._model.hydro
  • prepshot._model.investment
  • prepshot._model.nondispatchable
  • prepshot._model.storage
  • prepshot._model.transmission
  • prepshot.load_data
  • prepshot.logs
  • prepshot.model
  • prepshot.output_data
  • prepshot.set_up
  • prepshot.solver
  • prepshot.utils

© Copyright 2023, Zhanwei Liu and Xiaogang He (CC BY 3.0).

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs latest
Languages
en
On Read the Docs
Project Home
PDF
Hosted by Read the Docs ยท Privacy Policy