Calliope Model Definition¶

Calliope model definition.

data_definitions (object): Calliope data definition dictionary.
- ^[^_^\d][\w]*$
  - Any of
    - string
    - boolean
    - integer
    - number
    - object: Indexed data schema. Cannot contain additional properties.
      - data: Parameter / lookup value(s). If data is one value, will be applied to all dimension members. If a list, must be same length as the index array.
        
        Any of
        
        string
        
        boolean
        
        integer
        
        number
        
        array: Length must be at least 1.
        
        Items
        
        Any of
        
        string
        
        boolean
        
        integer
        
        number
        
        null
        
        null
      - dims: Model dimension(s) over which the data is indexed. Must be same length as the sub-arrays of index. I.e., if index does not have any sub-arrays or is simply a single value, dims must be of length 1.
        
        Any of
        
        string: Must match pattern: ^[^_^\d][\w]*$ (Test).
        
        array: Length must be at least 1. Items must be unique.
        
        Items (string): Must match pattern: ^[^_^\d][\w]*$ (Test).
      - index: Model dimension members to apply the data value(s) to. If an array of arrays, sub-arrays must have same length as number of dims.
        
        Any of
        
        string
        
        integer
        
        number
        
        array: Length must be at least 1. Items must be unique.
        
        Items
        
        Any of
        
        string
        
        integer
        
        number
        
        array: Length must be at least 1. Items must be unique.
        
        Items
        
        Any of
        
        string
        
        integer
        
        number
    - null
data_tables (object): Calliope input data table dictionary.
- ^[^_^\d][\w]*$ (object): Data table schema. Cannot contain additional properties.
  - table (string, required): Absolute or relative filepath. Relative paths are based on the model config file used to initialise the model.
  - rows: Names of dimensions defined row-wise. Each name should correspond to a column in your data that contains index items. These columns must be to the left of the columns containing your data. Default: null.
    - Any of
      - string: Must match pattern: ^[^_^\d][\w]*$ (Test).
      - array: Items must be unique.
        
        Items (string): Must match pattern: ^[^_^\d][\w]*$ (Test).
      - null
  - columns: Names of dimensions defined column-wise. Each name should correspond to a row in your data that contains index items. These rows must be above the rows containing your data. Default: null.
    - Any of
      - string: Must match pattern: ^[^_^\d][\w]*$ (Test).
      - array: Items must be unique.
        
        Items (string): Must match pattern: ^[^_^\d][\w]*$ (Test).
      - null
  - select: Select one or more index item from a dimension. Selection takes place before drop and add_dims, so you can select a single value from a data dimension and then drop the dimension so it doesn't find its way through to the final dataset. Default: null.
    - Any of
      - object
        
        ^[^_^\d][\w]*$
        
        Any of
        
        string: Must match pattern: ^[^_^\d][\w]*$ (Test).
        
        array: Items must be unique.
        
        Items (string): Must match pattern: ^[^_^\d][\w]*$ (Test).
      - null
  - drop: Enables removing rows and/or columns that contain irrelevant data/metadata. These could include comments on the source of the data, the data license, or the parameter units. You can also drop a dimension and then reintroduce it in add_dims, but with different index items. Default: null.
    - Any of
      - string: Must match pattern: ^[^_^\d][\w]*$ (Test).
      - array: Items must be unique.
        
        Items (string): Must match pattern: ^[^_^\d][\w]*$ (Test).
      - null
  - add_dims: Data dimensions to add after loading in the array. These allow you to use the same file to assign values to different input/dimension index items (e.g., setting flow_cap_min and flow_cap_max to the same value), or to add a dimension which would otherwise be a column containing the same information in each row (e.g., assigning the cost class to monetary for a file containing cost data). Default: null.
    - Any of
      - object
        
        ^[^_^\d][\w]*$
        
        Any of
        
        string: Must match pattern: ^[^_^\d][\w]*$ (Test).
        
        array
        
        Items (string): Must match pattern: ^[^_^\d][\w]*$ (Test).
      - null
  - rename_dims: Mapping between dimension names in the data table being loaded to equivalent Calliope dimension names. For instance, the "time" column in the data table would need to be mapped to "timesteps": {"time": "timesteps"}. Default: null.
    - Any of
      - object
        
        ^[^_^\d][\w]*$ (string): Must match pattern: ^[^_^\d][\w]*$ (Test).
      - null
nodes (object): Calliope Nodes dictionary.
- ^[^_^\d][\w]*$ (object): Calliope's node dimension schema. Can contain additional properties.
  - Additional properties
    - Any of
      - object: Tech-specific data schema. Cannot contain additional properties.
        
        data: Parameter / lookup value(s). If data is one value, will be applied to all dimension members. If a list, must be same length as the index array.
        
        Any of
        
        string
        
        boolean
        
        integer
        
        number
        
        array: Length must be at least 1.
        
        Items
        
        Any of
        
        string
        
        boolean
        
        integer
        
        number
        
        null
        
        null
        
        dims: Model dimension(s) over which the data is indexed. Must be same length as the sub-arrays of index. I.e., if index does not have any sub-arrays or is simply a single value, dims must be of length 1.
        
        Any of
        
        string: Must match pattern: ^[^_^\d][\w]*$ (Test).
        
        array: Length must be at least 1. Items must be unique.
        
        Items (string): Must match pattern: ^[^_^\d][\w]*$ (Test).
        
        index: Model dimension members to apply the data value(s) to. If an array of arrays, sub-arrays must have same length as number of dims.
        
        Any of
        
        string
        
        integer
        
        number
        
        array: Length must be at least 1. Items must be unique.
        
        Items
        
        Any of
        
        string
        
        integer
        
        number
        
        array: Length must be at least 1. Items must be unique.
        
        Items
        
        Any of
        
        string
        
        integer
        
        number
      - string
      - boolean
      - integer
      - number
      - array: Length must be at least 1.
        
        Items
        
        Any of
        
        string
        
        boolean
        
        integer
        
        number
        
        null
      - null
  - active (boolean): Default: true.
  - latitude: Latitude (WGS84 / EPSG4326). Default: null.
    - Any of
      - Any of
        
        integer
        
        number
      - null
  - longitude: Longitude (WGS84 / EPSG4326). Default: null.
    - Any of
      - Any of
        
        integer
        
        number
      - null
  - techs: Technologies present at this node. Also allows to override technology data.
    - Any of
      - object
        
        ^[^_^\d][\w]*$
        
        Any of
        
        object
        
        ^[^_^\d][\w]*$
        
        Any of
        
        string
        
        boolean
        
        integer
        
        number
        
        object: Can contain additional properties.
        
        null
        
        null
      - null
techs (object): Calliope Techs dictionary.
- ^[^_^\d][\w]*$
  - Any of
    - object: Calliope's technology dimension schema. Can contain additional properties.
      - Additional properties
        
        Any of
        
        object: Tech-specific data schema. Cannot contain additional properties.
        
        data: Parameter / lookup value(s). If data is one value, will be applied to all dimension members. If a list, must be same length as the index array.
        
        Any of
        
        string
        
        boolean
        
        integer
        
        number
        
        array: Length must be at least 1.
        
        Items
        
        Any of
        
        string
        
        boolean
        
        integer
        
        number
        
        null
        
        null
        
        dims: Model dimension(s) over which the data is indexed. Must be same length as the sub-arrays of index. I.e., if index does not have any sub-arrays or is simply a single value, dims must be of length 1.
        
        Any of
        
        string: Must match pattern: ^[^_^\d][\w]*$ (Test).
        
        array: Length must be at least 1. Items must be unique.
        
        Items (string): Must match pattern: ^[^_^\d][\w]*$ (Test).
        
        index: Model dimension members to apply the data value(s) to. If an array of arrays, sub-arrays must have same length as number of dims.
        
        Any of
        
        string
        
        integer
        
        number
        
        array: Length must be at least 1. Items must be unique.
        
        Items
        
        Any of
        
        string
        
        integer
        
        number
        
        array: Length must be at least 1. Items must be unique.
        
        Items
        
        Any of
        
        string
        
        integer
        
        number
        
        string
        
        boolean
        
        integer
        
        number
        
        array: Length must be at least 1.
        
        Items
        
        Any of
        
        string
        
        boolean
        
        integer
        
        number
        
        null
        
        null
      - active (boolean): Default: true.
      - base_tech: One of the abstract base classes, used to derive specific defaults and to activate technology-specific constraints. Default: null.
        
        Any of
        
        string: Must be one of: "conversion", "demand", "storage", "supply", or "transmission".
        
        null
    - null