Data table schema¶

Data table schema.

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