Pre-defined math

As of Calliope version 0.7, the math used to build optimisation problems is stored in YAML files. The pre-defined math is a re-implementation of the formerly hardcoded math formulation in this YAML format.

The base math is always applied to your model when you build the optimisation problem. We have also pre-defined some additional math, which you can optionally load into your model. For instance, the inter-cluster storage math allows you to track storage levels in technologies more accurately when you are using timeseries clustering in your model.

To load optional, pre-defined math on top of the base math, you can reference it by name (without the file extension) in your model configuration:

config:
  init:
    add_math: [storage_inter_cluster]

When solving the model in a run mode other than plan, some pre-defined additional math will be applied automatically from a file of the same name (e.g., spores mode math is stored in math/spores.yaml).

Note

Additional math is applied in the order it appears in the config.init.add_math list. By default, any run mode math will be applied as the final step. If you want to apply your own math after the run mode math, you should add the name of the run mode explicitly to the config.init.add_math list, e.g., config.init.add_math: [operate, user_defined_math.yaml].

If you want to introduce new constraints, decision variables, or objectives, you can do so as part of the collection of YAML files describing your model. See the user-defined math section for an in-depth guide to applying your own math.

The pre-defined math can be explored in this section by selecting one of the options in the left-hand-side table of contents.