Table of contents
Getting Started
User Guides
- Creating a new System
- Adding a Commodity to a System
- Adding a Node to a System
- Adding a Location to a System
- Adding an Asset to a System
- Adding Policy Constraints to a System
- Adding Asset Constraints to a System
- Balance Constraint
- Capacity Constraint
- Maximum Capacity
- Minimum Capacity
- Minimum Flow Constraint
- Minimum Up/Down Time (Unit Commitment)
- Must Run Constraint
- Ramping Limit Constraint (RampUp/RampDown)
- Storage Capacity Constraint
- Maximum Storage Level
- Minimum Storage Level
- Storage Charge/Discharge Ratio
- Storage Discharge Limit Constraint
- Storage Maximum/Minimum Duration Constraint
- Storage Symmetric Capacity Constraint
- Minimum Storage Outflow
- Long Duration Storage Implicit Min/Max Constraint
- Configuring Settings
- Run a Macro Model
- Writing Results to Files
Modeler Guides
- Modeler Guides
- Creating a New Sector
- Creating a New Asset
- Adding Documentation for a New Asset
- Creating a New Example Case
- Debugging and Testing a Macro Model
- Energy System Graph-Based Representation
- Suggested Development Workflow
Developer Guides
Asset Documentation
References
- References
- Reading input functions
- Macro Objects
- Output functions
collect_resultsget_optimal_capacityget_optimal_discounted_costsget_optimal_flowget_optimal_new_capacityget_optimal_retired_capacitywrite_balance_dualswrite_capacitywrite_co2_cap_dualswrite_costswrite_dualswrite_duals_benderswrite_flowwrite_settingswrite_dataframewrite_resultsMacroEnergy.write_outputsMacroEnergy.write_period_outputs
- Non-Benders Utility Functions
all_constraintsall_constraints_typesasset_idsbalance_idsbalance_datacreate_output_pathensure_duals_available!get_asset_by_idget_assets_sametypeget_asset_typesget_balanceget_constraint_by_typeget_component_by_fieldnameget_component_idsget_component_by_idget_edgesget_output_layoutget_valueget_value_and_keysfilter_edges_by_asset_type!filter_edges_by_commodity!find_available_pathfind_nodeidjson_to_csvlocation_idsprint_struct_inforeshape_widereshape_longsearch_assetssearch_commoditiesset_valueset_constraint_dual!struct_infotimestepbeforecollect_flow_resultscollect_local_flowscollect_distributed_flowsevaluate_vtheta_in_expression
- Benders Utility Functions
populate_slack_vars_from_subproblems!collect_distributed_policy_slack_varscollect_local_slack_varsmerge_distributed_slack_vars_dictspopulate_constraint_duals_from_subproblems!collect_distributed_constraint_dualscollect_local_constraint_dualsmerge_distributed_balance_dualsdensearray_to_dictdict_to_densearray