Skip to content

Model parameters

These pages list the entity classes of a FlexTool model and the parameters you can give them, one page per topic.

  • Entities and time structure — the main entities, the timeline, periods, timesets, solves and the units of measure.
  • Nodes — balance and storage nodes: inflow, penalties, storage and investment parameters.
  • Units — conversion units, their inputs and outputs, investment, retirement and profile limits.
  • Connections — transfers between nodes, their transfer methods and investment parameters.
  • Commodities — fuels and other commodities bought or sold at a price.
  • Groups — capacity, investment and emission limits, stochastics, decomposition and outputs for a set of entities.
  • Flow groups — cumulative and instant limits on summed flows.
  • Reserves — reserve requirements and the units and connections that provide them.
  • User constraints — linear constraints you write yourself over flows, states and capacities.
  • Parameter groups and conventions — the parameter group labels, the behaviour-change notices of upgraded databases and the input checks a run makes before it starts.
  • Parameter catalogue (web docs) — every parameter in one table per entity class: unit, allowed shapes, default, allowed values and group, generated from the schema of this FlexTool version. python -m flextool.docs_build --xlsx catalogue.xlsx writes it as an Excel data dictionary (see How to make a data dictionary for your model).