Table of contents

Getting Started

• Getting Started
• • How can I use Macro?
  • Helpful packages
  • How are real-world systems represented in Macro?
• Installation
• • Requirements
  • Installation steps
  • Editing the installation
• Running Macro
• • Running Macro with user-defined cases

User Guides

• User Guide
• • Introduction: Energy System in Macro
• Macro Input Data
• • Settings folder
  • System folder
  • Assets folder
  • system_data.json
• Macro Constraint Library
• • Balance constraint
  • Capacity constraint
  • CO2 capacity constraint
  • Long-duration storage constraints
  • Maximum capacity constraint
  • Maximum non-served demand constraint
  • Maximum non-served demand per segment constraint
  • Maximum storage level constraint
  • Minimum capacity constraint
  • Minimum flow constraint
  • Minimum storage level constraint
  • Minimum storage outflow constraint
  • Minimum up and down time constraint
  • Must-run constraint
  • Ramping limits constraint
  • Storage capacity constraint
  • Storage discharge limit constraint
  • Storage symmetric capacity constraint
  • Storage charge discharge ratio constraint
  • Storage max duration constraint
  • Storage min duration constraint

Modeler Guides

Developer Guides

• Developer Guides
• Macro type hierarchy

References

• Reading input functions
• • add_default_system_data!
  • clean_up_keys
  • eager_load_json_inputs
  • fetch_data
  • load_csv
  • load_default_system_data
  • load_json_inputs
  • load_system
  • load_system_data
  • prep_system_data
  • load_benders_settings
  • try_load_benders_settings
• Macro Objects
• • Edge (with and without UC)
  • EdgeWithUC
  • Node
  • Storage
  • Transformation
  • @AbstractVertexBaseAttributes
• Output functions
• • collect_results
  • get_optimal_capacity
  • get_optimal_discounted_costs
  • get_optimal_flow
  • get_optimal_new_capacity
  • get_optimal_retired_capacity
  • write_capacity
  • write_costs
  • write_flow
  • write_dataframe
  • write_results
  • MacroEnergy.write_outputs
• Utility functions
• • all_constraints
  • all_constraints_types
  • asset_ids
  • balance_ids
  • balance_data
  • create_output_path
  • get_asset_by_id
  • get_assets_sametype
  • get_asset_types
  • get_balance
  • get_constraint_by_type
  • get_component_by_fieldname
  • get_component_ids
  • get_component_by_id
  • get_edges
  • get_output_layout
  • get_value
  • get_value_and_keys
  • filter_edges_by_asset_type!
  • filter_edges_by_commodity!
  • find_available_path
  • find_node
  • id
  • json_to_csv
  • location_ids
  • print_struct_info
  • reshape_wide
  • reshape_long
  • search_assets
  • search_commodities
  • set_value
  • struct_info
  • timestepbefore
  • collect_flow_results
  • collect_local_flows
  • collect_distributed_flows
  • evaluate_vtheta_in_expression