Bump tags for Tecnalia models, fix incorrect scaling and improve documentation by Zetison · Pull Request #10 · EnergyModelsX/EnergyModelsLanguageInterfaces.jl

Zetison · 2025-12-19T10:08:54Z

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-to section for the sampling constructors of these nodes.

magnuask

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).

magnuask · 2026-03-18T08:36:25Z

docs/src/nodes/multiplebuildingtypes.md

+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.


“constructors that samples” → “constructors that sample”

magnuask · 2026-03-18T08:37:01Z

docs/src/nodes/pvandcsp.md

+
+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.


“constructors that samples” → “constructors that sample”

magnuask · 2026-03-18T08:37:17Z

docs/src/nodes/windpower.md

+# [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.


“constructors that samples” → “constructors that sample”

magnuask · 2026-03-18T08:37:49Z

docs/src/how-to/utilize.md

+
+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).


have a constructor” → “has a constructor”

magnuask · 2026-03-18T08:38:34Z

docs/src/nodes/multiplebuildingtypes.md

+  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.


“These penalties affect the variable operational expenses.” → “These penalties are added to the variable operational cost.”

Changed, but kept expenses (as we use OPEX).

magnuask · 2026-03-18T09:46:41Z

docs/src/nodes/pvandcsp.md

@@ -0,0 +1,154 @@
+# [PV and CSV source node](@id nodes-CSPandPV)


should be “PV and CSP source node”

magnuask · 2026-03-18T09:47:53Z

docs/src/nodes/pvandcsp.md

It is not entirely clear whether this node represents a combined PV + CSP system, or a generic multi-resource solar source

It is in practice a combined PV+CSP system if the constructor for the model from Tecnalia is used. I updated the documentation.

magnuask · 2026-03-18T09:49:54Z

docs/src/nodes/pvandcsp.md

+- [``\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``.\


“curtailed capacity” is misleading. Curtailment usually refers to unused generation (energy) rather than capacity.

magnuask · 2026-03-18T09:51:35Z

docs/src/nodes/windpower.md

@@ -0,0 +1,161 @@
+# [Wind power source node](@id nodes-WindPower)
+
+Wind power source generate electricity from wind sources. 


Consider simplifying to “Wind power sources generate electricity from wind.”

magnuask · 2026-03-18T09:54:10Z

docs/src/nodes/windpower.md

+- [``\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.\


Curtailment usually refers to unused generation (energy/output) rather than capacity.

JulStraus

Implemented the changes within 7e24573. Can you please resolve all comments that I answered?

JulStraus · 2026-03-19T06:39:07Z

docs/src/how-to/utilize.md

While I agree with this, I would leave it to another PR.

JulStraus · 2026-03-19T06:50:51Z

docs/src/nodes/biochp.md

+    To use the [constructor](@ref lib-pub-sampling_constructors) that samples the [CHP_modelling](https://github.com/iDesignRES/CHP_modelling) module, follow the installation in the [Use nodes](@ref how_to-utilize-use_nodes) section.
+
+The `BioCHP` utilizes linear, time-independent conversion rates from the `input` [`Resource`](@extref EnergyModelsBase.Resource)s to the `output` [`Resource`](@extref EnergyModelsBase.Resource)s, subject to the available capacity.
+The capacity is normalized such that a conversion value of 1 corresponds to the nominal capacity in the fields `input` and `output`.


I removed it, as it is the same as it is the case for the standard EMB nodes.

JulStraus · 2026-03-19T06:52:18Z

docs/src/nodes/biochp.md

+The capacity is normalized such that a conversion value of 1 corresponds to the nominal capacity in the fields `input` and `output`.
+
+Compared to a standard [`NetworkNode`](@extref EnergyModelsBase.NetworkNode), `BioCHP` differs in its outlet-flow constraints:
+the produced heat does not have to be used (e.g., heat outputs are allowed to be zero), while electric output is enforced according to the given conversion factor.


I did a rework on this. Let me know what you think

JulStraus · 2026-03-19T06:54:09Z

docs/src/nodes/biochp.md

+  This is similar to the approach utilized in `EnergyModelsBase`.
+
+- **`cap::TimeProfile`**:\
+  Specifies the installed capacity, that is the heat the heat pump can deliver.\


That is not entirely correct. It is for the standard node not defined in heat as the conversion factors may impact the system. I extended the description.

JulStraus · 2026-03-19T06:57:04Z

docs/src/nodes/biochp.md

+
+- **`output::Dict{<:Resource, <:Real}`**:\
+  The field `output` includes the output [`Resource`](@extref EnergyModelsBase.Resource)s with their corresponding conversion factors as dictionaries.
+  It is also possible to include other resources which are produced with a given correlation with the heat.\


JulStraus · 2026-03-24T10:44:02Z

docs/src/how-to/utilize.md

+
+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).


JulStraus · 2026-03-24T10:44:07Z

docs/src/how-to/utilize.md

+git clone --recurse-submodules git@github.com:EnergyModelsX/EnergyModelsLanguageInterfaces.jl.git
+```
+
+You should now be enabled to enter the main folder in which the other modules are located (under the submodules folder)


JulStraus · 2026-03-24T10:44:16Z

docs/src/how-to/utilize.md

+
+### [Test modules](@id how_to-utilize-use_nodes-test)
+
+All the mentioned [constructors](@ref lib-pub-sampling_constructors) have been included in the tests of the repository and you may therefore check if everyting is properly setup by running these in julia.


JulStraus · 2026-03-24T10:44:47Z

docs/src/nodes/multiplebuildingtypes.md

+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.


JulStraus · 2026-03-24T10:45:50Z

docs/src/nodes/pvandcsp.md

It is in practice a combined PV+CSP system if the constructor for the model from Tecnalia is used. I updated the documentation.

Bump tags for Tecnalia models and fix incorrect scaling

b2145d0

Zetison self-assigned this Dec 19, 2025

Zetison added the bug Something isn't working label Dec 19, 2025

Remove old comment

d620e26

Zetison requested a review from magnuask December 19, 2025 11:13

Jon Vegard Venås added 14 commits December 27, 2025 19:52

Improve documentation

498717d

Add CI windows run

4c8313a

Fix CI conan error

bf9aa24

Try to fix CI for windows

7a16129

Try to fix CI for windows

2a7d0b1

Try to fix laking highs installation

9439618

Reintroduce mistakenly conan removal

c5772a5

Try to use appsi_highs

f6c0bc3

Resolve highs issue for both Linux and Windows

1cdda2e

Run all jobs

4d0109e

Fix miscellaneous issues

83e1197

Fix bug

4e3f0cc

Fix missing highs on linux

908120a

Add conan profile detect

a433a6e

Zetison changed the title ~~Bump tags for Tecnalia models and fix incorrect scaling~~ Bump tags for Tecnalia models, fix incorrect scaling and improve documentation Dec 28, 2025

Run full CI

a146db2

Zetison assigned JulStraus and unassigned Zetison Dec 28, 2025

magnuask reviewed Mar 18, 2026

View reviewed changes

Incorporated changes from PR

7e24573

JulStraus reviewed Mar 24, 2026

View reviewed changes


		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).

		@@ -0,0 +1,154 @@
		# [PV and CSV source node](@id nodes-CSPandPV)

		@@ -0,0 +1,161 @@
		# [Wind power source node](@id nodes-WindPower)

		Wind power source generate electricity from wind sources.


		### [Test modules](@id how_to-utilize-use_nodes-test)

		All the mentioned [constructors](@ref lib-pub-sampling_constructors) have been included in the tests of the repository and you may therefore check if everyting is properly setup by running these in julia.

Conversation

Zetison commented Dec 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

magnuask left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JulStraus left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Zetison commented Dec 19, 2025 •

edited

Loading