Skip to content

Dimensions#

A dimension is a set of labels that entries are indexed by, such as snapshot or generator. sum reduces over a dimension. A map from one dimension onto another is a relation.

dimensions#

dimensions:
  snapshot: { dtype: int, ordered: true }
  generator: { dtype: str }

Every dimension named anywhere in the file is declared here.

Field
dtype float, int, str or datetime default str
one_of the labels a str dimension allows default null
ordered whether the order of the members is part of the model default false
description free text default null

The members of a dimension arrive with the data, in the order the table gives them. Everything indexed by the dimension is matched to its members by label.

one_of#

one_of: [...] lists the labels a str dimension allows:

dimensions:
  carrier: { dtype: str, one_of: [ccgt, ocgt, wind] }
  generator: { dtype: str }
relations:
  carrier_of: { key: generator, values: carrier }
variables:
  p: { dims: [generator], where: "carrier_of == 'wind'" }

The labels are strings. The list holds at least one label, and each label once. A number such as 2030 is refused, so quote it as '2030'. The dtype is str by default, so carrier: { one_of: [ccgt, ocgt, wind] } is the same dimension. A one_of with any other dtype is refused. The dimension is a str dimension in every other rule.

A condition that compares the dimension, or a relation column over it, against a label that is not in the list is refused at load. carrier_of == 'gnrtr' above is refused:

Variable 'p': 'gnrtr' is not a label of 'carrier', which allows only ['ccgt', 'ocgt', 'wind']. Write one of them, or add 'gnrtr' to the one_of of 'carrier'.

The tool that attaches the data refuses a coordinate that is not in the list, in the table of the dimension and in every relation column over it.

Only a dimension takes one_of. To give a parameter a closed set of labels, declare a dimension with one_of and a relation into it, as carrier_of is above.

Order#

A construct may read the order of a dimension only when the dimension is declared ordered: true. A snapshot comes after the one before it. A generator does not come after another generator, so a file that steps from one generator to the next would read the row order of a data table. Five constructs read the order, and each needs its dimension declared ordered: true:

Construct Reads
shift(x, along=d, offset=n), in an expression or a condition the member n positions back
sum_back(x, along=d, window=n) the last n members
position(d) where a member sits along d
piecewise: with over: d which breakpoints are neighbours
sos: with type: 2 and along: d which members are consecutive

The loader refuses any of them along a dimension that is not ordered:

Constraint 'ramp': shift(along=snapshot) reads the order of 'snapshot', which is not declared ordered, so the order would come from the row order of the data. Declare 'snapshot: {ordered: true}' under dimensions:.

A dtype does not make a dimension ordered: an int dimension may number things that have no order. An sos entry with type: 1 reads no order, and edge='wrap' makes one shift cyclic without changing the dimension.

To decide whether a column of data is a dimension, a relation or a parameter, read declare a column of data.