From 1b7b04ffa3f9a8384d70cbb79bef615be6bbe708 Mon Sep 17 00:00:00 2001 From: Bryn Pickering <17178478+brynpickering@users.noreply.github.com> Date: Fri, 6 Sep 2024 19:36:46 +0100 Subject: [PATCH] Update `flow_cap_min` description (#672) Co-authored-by: Stefan Pfenninger --- CHANGELOG.md | 2 ++ src/calliope/config/model_def_schema.yaml | 13 ++++++++++--- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index bda1f7f8..31b8db17 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,8 @@ ### User-facing changes +|fixed| clarity of `flow_cap_min` description in documentation (#653). + |changed| API/schema documentation is de-ranked in documentation search bar results (#670). |new| Math component cross-references in both directions ("uses" and "used in") in Markdown math documentation (#643). diff --git a/src/calliope/config/model_def_schema.yaml b/src/calliope/config/model_def_schema.yaml index 34b18140..3f536642 100644 --- a/src/calliope/config/model_def_schema.yaml +++ b/src/calliope/config/model_def_schema.yaml @@ -407,9 +407,16 @@ properties: x-type: float title: Minimum rated flow capacity. description: >- - Limits `flow_cap` to a minimum. - NOTE: this will _force_ `flow_cap` to a minimum value unless `cap_method` is set to `integer`. - If `cap_method=integer`, this will be scaled by the number of integer units of a technology purchased. + This acts as lower limit (lower bound) for flow_cap. + If `cap_method` = integer, this will be scaled by the number of integer units of a technology purchased. + + !!! note + If `cap_method` = continuous (which is set by default), then setting `flow_cap_min` to any value greater than 0 forces the model to always respect that limit, which in turn forces investment into the technology. + Use this to enforce given investment plans, or to account for existing technologies that cannot be decommissioned. + + An example: If `cap_method` = continuous and `flow_cap_min` = 100, then flow_cap has to be at least 100. + This means that going to 0 is not possible, unless you switch to `cap_method` = integer (see [cap_method][]). + x-unit: power or $\frac{\text{power}}{\text{unit}}$. flow_cap_min_systemwide: