Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
*startup.jl
docs/build/
docs/src/manual/NEWS.md
docs/src/examples/*.md
*.lp
*.mps
dev/
Expand Down
13 changes: 13 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,18 @@
# Release notes

## Version 0.2.10 (2026-01-05)

### Enhancements

* Added the new link `CapacityCostLink`.
* Added the nodes `InflexibleSource` and `FlexibleOutput`.

### Adjustments

* Removed `ext/EMGUIExt/descriptive_names.yml` as this will now be provided directly in `EnergyModelsGUI`.
* Removed `docs/src/example/flexible_demand.md` as the markdown versions of the example files are now generated automatically (and these are thus added to the `.gitignore`-file).


## Version 0.2.9 (2025-07-08)

* Adjusted to [`EnergyModelsBase` v0.9.0](https://github.com/EnergyModelsX/EnergyModelsBase.jl/releases/tag/v0.9.0):
Expand Down
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "EnergyModelsFlex"
uuid = "a81b9388-333d-4b63-81f2-910b060b544c"
authors = ["Sigrid Aunsmo, Sigmund Eggen Holm, Jon Vegard Venås, and Per Åslid"]
version = "0.2.9"
version = "0.2.10"

[deps]
EnergyModelsBase = "5d7e687e-f956-46f3-9045-6f5a5fd49f50"
Expand Down
16 changes: 15 additions & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ DocMeta.setdocmeta!(
news = "docs/src/manual/NEWS.md"
cp("NEWS.md", news; force = true)

inputfile = joinpath("examples", "flexible_demand.jl")
Literate.markdown(inputfile, joinpath("docs", "src", "examples"))

inputfile = joinpath("examples", "capacity_cost_link.jl")
Literate.markdown(inputfile, joinpath("docs", "src", "examples"))

links = InterLinks(
"TimeStruct" => "https://sintefore.github.io/TimeStruct.jl/stable/",
"EnergyModelsBase" => "https://energymodelsx.github.io/EnergyModelsBase.jl/stable/",
Expand All @@ -41,11 +47,15 @@ makedocs(
"Quick Start"=>"manual/quick-start.md",
"Examples"=>Any[
"Flexible demand"=>"examples/flexible_demand.md",
"Capacity cost link"=>"examples/capacity_cost_link.md",
],
"Release notes"=>"manual/NEWS.md",
],
"Nodes" => Any[
"PayAsProducedPPA"=>"nodes/source/payasproducedppa.md",
"Source nodes"=>Any[
"PayAsProducedPPA" => "nodes/source/payasproducedppa.md",
"InflexibleSource" => "nodes/source/inflexiblesource.md",
],
"Sink nodes"=>Any[
"PeriodDemandSink"=>"nodes/sink/perioddemand.md",
"LoadShiftingNode"=>"nodes/sink/loadshiftingnode.md",
Expand All @@ -57,9 +67,13 @@ makedocs(
"ActivationCostNode"=>"nodes/network/activationcostnode.md",
"LimitedFlexibleInput"=>"nodes/network/limitedflexibleinput.md",
"Combustion"=>"nodes/network/combustion.md",
"FlexibleOutput"=>"nodes/network/flexibleoutput.md",
],
"StorageEfficiency"=>"nodes/storage/storageefficiency.md",
],
"Links" => Any[
"CapacityCostLink"=>"links/capacitycostlink.md",
],
"How-to" =>
Any["Contribute"=>"how-to/contribute.md"],
"Library" => Any[
Expand Down
160 changes: 0 additions & 160 deletions docs/src/examples/flexible_demand.md

This file was deleted.

28 changes: 20 additions & 8 deletions docs/src/library/internals/methods-EMB.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# [Methods - `EnergyModelsBase`](@id lib-int-met_emb)
# [Methods - `EMB`](@id lib-int-met_emb)

## [Index](@id lib-int-met_emb-idx)

Expand All @@ -9,21 +9,33 @@ Pages = ["methods-EMB.md"]
## [Extension methods](@id lib-int-met_emb-ext)

```@docs
EnergyModelsBase.variables_element
EMB.variables_element
EMB.create_link
EMB.has_capacity
EMB.has_opex
```

## [Constraint methods](@id lib-int-met_emb-con)

```@docs
EnergyModelsBase.constraints_capacity
EnergyModelsBase.constraints_flow_in
EnergyModelsBase.constraints_flow_out
EnergyModelsBase.constraints_opex_var
EnergyModelsBase.constraints_level_aux
EMB.constraints_capacity
EMB.constraints_flow_in
EMB.constraints_flow_out
EMB.constraints_opex_var
EMB.constraints_level_aux
```

## [Check methods](@id lib-int-met_emb-check)

```@docs
EnergyModelsBase.check_node
EMB.check_node
EMB.check_link
```

## [Field extraction methods](@id lib-int-met_emb-field)

```@docs
EMB.capacity
EMB.inputs
EMB.outputs
```
8 changes: 8 additions & 0 deletions docs/src/library/internals/methods-EMF.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,12 @@ Pages = ["methods-EMF.md"]
```@docs
EnergyModelsFlex.check_period_ts
EnergyModelsFlex.check_limits_default
EnergyModelsFlex.check_input
```

## [Utility functions](@id lib-int-links-fun_utils)

```@docs
EnergyModelsFlex.avg_cap_price
EnergyModelsFlex.create_sub_periods
```
15 changes: 15 additions & 0 deletions docs/src/library/internals/methods-fields.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,18 @@ EnergyModelsFlex.number_of_periods
```@docs
EnergyModelsFlex.activation_consumption
```

## [`CapacityCostLink` types](@id lib-int-met_field-CapacityCostLink)

```@docs
EnergyModelsFlex.cap_price_periods
EnergyModelsFlex.cap_resource
EnergyModelsFlex.cap_price
```

## [`Combustion` types](@id lib-int-met_field-Combustion)

```@docs
EnergyModelsFlex.limits
EnergyModelsFlex.heat_resource
```
20 changes: 15 additions & 5 deletions docs/src/library/public.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Pages = ["public.md"]

## [Sink `Node` types](@id lib-pub-sink-node)

The following sink node types are implemented in the `EnergyModelsFlex`.
The following sink node types are implemented in the `EnergyModelsFlex`:

```@docs
PeriodDemandSink
Expand All @@ -20,28 +20,38 @@ LoadShiftingNode

## [Source `Node` types](@id lib-pub-source-node)

The following source node type is implemented in the `EnergyModelsFlex`.
The following source node type is implemented in the `EnergyModelsFlex`:

```@docs
PayAsProducedPPA
InflexibleSource
```

## [Network `Node` types](@id lib-pub-network-node)

The following network node types are implemented in the `EnergyModelsFlex`.
The following network node types are implemented in the `EnergyModelsFlex`:

```@docs
MinUpDownTimeNode
ActivationCostNode
LimitedFlexibleInput
Combustion
FlexibleOutput
```

## [Storage `Node` types](@id lib-pub-storage-node)

The following storage node types are implemented in the `EnergyModelsFlex`.
The following storage node types are implemented in the `EnergyModelsFlex`:

```@docs
ElectricBattery
StorageEfficiency
```
```

## [`Link` types](@id lib-pub-link)

The following link types are implemented in the `EnergyModelsFlex`:

```@docs
CapacityCostLink
```
Loading