From e6e3d447ce9f24e345070b4da7921625aff379f7 Mon Sep 17 00:00:00 2001 From: Ivan Ruiz Manuel <72193617+irm-codebase@users.noreply.github.com> Date: Wed, 19 Jun 2024 11:22:10 +0200 Subject: [PATCH] add new values to config_schema --- src/calliope/config/config_schema.yaml | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/src/calliope/config/config_schema.yaml b/src/calliope/config/config_schema.yaml index ca8749b0..55eb7aeb 100644 --- a/src/calliope/config/config_schema.yaml +++ b/src/calliope/config/config_schema.yaml @@ -51,6 +51,13 @@ properties: type: string default: "ISO8601" description: Timestamp format of all time series data when read from file. "ISO8601" means "%Y-%m-%d %H:%M:%S". + base_math: + type: boolean + default: true + description: >- + Whether or not to use the base Calliope math and schema when building models. + If "true", the model will use the base Calliope math. Values in "add_math" and "add_schema" will be appended to these. + If "false", users must fully define the model math and schema via "add_math" and "add_schema". Use with caution! add_math: type: array default: [] @@ -62,6 +69,16 @@ properties: If referring to an pre-defined Calliope math file (see documentation for available files), do not append the reference with ".yaml". If referring to your own math file, ensure the file type is given as a suffix (".yaml" or ".yml"). Relative paths will be assumed to be relative to the model definition file given when creating a calliope Model (`calliope.Model(model_definition=...)`) + add_schema: + type: array + default: [] + description: List of references to files which contain schema definitions for model parameters, including their default value. + uniqueItems: true + items: + type: string + description: > + Ensure the file type is given as a suffix (".yaml" or ".yml"). + Relative paths will be assumed to be relative to the model definition file given when creating a calliope Model (`calliope.Model(model_definition=...)`) distance_unit: type: string default: km