Bump tags for Tecnalia models, fix incorrect scaling and improve documentation#10
Open
Bump tags for Tecnalia models, fix incorrect scaling and improve documentation#10
Conversation
added 14 commits
December 27, 2025 19:52
Zetison
changed the title
magnuask
reviewed
Mar 18, 2026
Collaborator
magnuask
left a comment
magnuask
left a comment
There was a problem hiding this comment.
The structure is better with these additions. I left a number of inline comments with suggested fixes and clarifications (mainly related to a few inconsistencies, minor errors, and some places where the wording could be clearer).
| The [`MultipleBuildingTypes`](@ref) node creates sinks for all demand resources with penalties for both surplus and deficit. | ||
| The implementation uses `Dict` structures for the fields `cap`, `penalty_surplus`, and `penalty_deficit` to facilitate multiple [Resource](@extref EnergyModelsBase.Resource)s. | ||
| This approach allows modeling building demands with flexible penalty mechanisms for over- and under-supply. | ||
| The type is also used to enable specialized constructors that samples the [`Tecnalia_Building-Stock-Energy-Model`](https://github.com/iDesignRES/Tecnalia_Building-Stock-Energy-Model) module. |
Collaborator
There was a problem hiding this comment.
“constructors that samples” → “constructors that sample”
|
|
||
| PV and CSP source generate, respectively, electricity and heat from solar power. | ||
| The implementation of the node is similar to that of [NonDisRES](@extref EnergyModelsRenewableProducers nodes-nondisres) but uses `Dict` structures for the fields `cap`, `profile`, `opex_var` and `opex_fixed` to facilitate multiple [Resource](@extref EnergyModelsBase.Resource)s (both electricity and heat outputs). | ||
| The type is also used to enable specialized constructors that samples the [Tecnalia_Solar-Energy-Model](https://github.com/iDesignRES/Tecnalia_Solar-Energy-Model) module. |
Collaborator
There was a problem hiding this comment.
“constructors that samples” → “constructors that sample”
| # [Wind power source node](@id nodes-WindPower) | ||
|
|
||
| Wind power source generate electricity from wind sources. | ||
| The implementation of the node is identical to that of [NonDisRES](@extref EnergyModelsRenewableProducers nodes-nondisres) and is here used to enable specialized constructors that samples the [`wind_power_timeseries`](https://gitlab.sintef.no/harald.svendsen/wind_power_timeseries) module. |
Collaborator
There was a problem hiding this comment.
“constructors that samples” → “constructors that sample”
|
|
||
| The nodes [`WindPower`](@ref WindPower), [`CSPandPV`](@ref CSPandPV) and [`MultipleBuildingTypes`](@ref MultipleBuildingTypes) have [constructors](@ref lib-pub-sampling_constructors) that samples [`wind_power_timeseries`](https://gitlab.sintef.no/harald.svendsen/wind_power_timeseries), [`Tecnalia_Solar-Energy-Model`](https://github.com/iDesignRES/Tecnalia_Solar-Energy-Model) and [`Tecnalia_Building-Stock-Energy-Model`](https://github.com/iDesignRES/Tecnalia_Building-Stock-Energy-Model), respectively. These modules are python based and the usage of these [constructors](@ref lib-pub-sampling_constructors) requires installation of these as documented [below](@ref how_to-utilize-use_nodes-python_modules). | ||
|
|
||
| Additionally, the node [`BioCHP`](@ref BioCHP) have a [constructor](@ref lib-pub-sampling_constructors) that samples the [CHP_modelling](https://github.com/iDesignRES/CHP_modelling) module. This module is `C++` based and the [constructor](@ref lib-pub-sampling_constructors) then requires compilation and build before usage as described further [below](@ref how_to-utilize-use_nodes-cpp_modules). |
Collaborator
There was a problem hiding this comment.
have a constructor” → “has a constructor”
| All values have to be non-negative. | ||
| - **`penalty_surplus::Dict{<:Resource,<:TimeProfile}`**:\ | ||
| The penalties applied for surplus (over-supply) for each of the input resources. | ||
| These penalties affect the variable operational expenses. |
Collaborator
There was a problem hiding this comment.
“These penalties affect the variable operational expenses.” → “These penalties are added to the variable operational cost.”
| @@ -0,0 +1,154 @@ | |||
| # [PV and CSV source node](@id nodes-CSPandPV) | |||
Collaborator
There was a problem hiding this comment.
should be “PV and CSP source node”
Collaborator
There was a problem hiding this comment.
It is not entirely clear whether this node represents a combined PV + CSP system, or a generic multi-resource solar source
| - [``\texttt{cap\_inst}``](@extref EnergyModelsBase man-opt_var-cap) | ||
| - [``\texttt{flow\_out}``](@extref EnergyModelsBase man-opt_var-flow) | ||
| - [``\texttt{emissions\_node}``](@extref EnergyModelsBase man-opt_var-emissions) if `EmissionsData` is added to the field `data`. | ||
| - [``\texttt{curtailment}[n, t]``](@extref EnergyModelsRenewableProducers nodes-nondisres-math-add): For [`CSPandPV`](@ref), this variable is the sum of curtailed capacity of source ``n`` in operational period ``t``.\ |
Collaborator
There was a problem hiding this comment.
“curtailed capacity” is misleading. Curtailment usually refers to unused generation (energy) rather than capacity.
| @@ -0,0 +1,161 @@ | |||
| # [Wind power source node](@id nodes-WindPower) | |||
|
|
|||
| Wind power source generate electricity from wind sources. | |||
Collaborator
There was a problem hiding this comment.
Consider simplifying to “Wind power sources generate electricity from wind.”
| - [``\texttt{cap\_inst}``](@extref EnergyModelsBase man-opt_var-cap) | ||
| - [``\texttt{flow\_out}``](@extref EnergyModelsBase man-opt_var-flow) | ||
| - [``\texttt{emissions\_node}``](@extref EnergyModelsBase man-opt_var-emissions) if `EmissionsData` is added to the field `data`. | ||
| - [``\texttt{curtailment}[n, t]``](@extref EnergyModelsRenewableProducers nodes-nondisres-math-add): Curtailed capacity of source ``n`` in operational period ``t`` with a typical unit of MW.\ |
Collaborator
There was a problem hiding this comment.
Curtailment usually refers to unused generation (energy/output) rather than capacity.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Based on the output of the Tecnalia_Building-Stock-Energy-Model the 1e6 scaling is removed and test updated accordingly. The submodules SHA are also updated. Also, added documentation for the nodes and a
how-tosection for the sampling constructors of these nodes.