API Reference

Description: PREP-SHOT package metadata.

• set_up
  • initialize_environment()
  • parse_cli_arguments()
• logs
  • log_parameter_info()
  • setup_logging()
  • timer()
• load_data
  • check_schema()
  • 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_basic_sets()
  • define_complex_sets()
  • define_constraints()
  • define_model()
  • define_variables()
• constraints
  • co2
  • cost
  • demand
  • generation
  • head_iteration
  • hydro
  • investment
  • nondispatchable
  • storage
  • transmission
• utils
  • calc_cost_factor()
  • calc_interest_rate()
  • 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()