Reference

Reference material for Calliope: the YAML syntax and command-line interface, the built-in math formulations, the Python API, and the schemas that validate model definitions.

These pages are intended for looking up specifics. For a guided introduction, see getting started and the building blocks section.

• Syntax & CLI

  ---

  • YAML as used in Calliope: the YAML conventions used throughout Calliope.
  • Command line interface: reference for the calliope command-line tools.

• Built-in math

  ---

  • Built-in base math: the base mathematical formulation, always applied to a model.
  • Other built-in math: pre-defined mode and extra math.

• Python API

  ---

  • Model: the core calliope.Model class.
  • Backend: the optimisation backend interface.
  • Helper functions: math helper functions.
  • Example models: loading the built-in example models.
  • AttrDict: the nested-dictionary utility.
  • Exceptions: Calliope's errors and warnings.
  • Logging: configuring Calliope's logging.

• Schemas

  ---

  • Configuration schema: the config validation schema.
  • Data table schema: the data_tables validation schema.
  • Model definition schema: the model definition validation schema.
  • Math schema: the math validation schema.