Skip to content

Commit

Permalink
Update flow_cap_min description (#672)
Browse files Browse the repository at this point in the history
Co-authored-by: Stefan Pfenninger <[email protected]>
  • Loading branch information
brynpickering and sjpfenninger authored Sep 6, 2024
1 parent 389e9f2 commit 1b7b04f
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
13 changes: 10 additions & 3 deletions src/calliope/config/model_def_schema.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 1b7b04f

Please sign in to comment.