Removal of legacy constructor (#53)

Author: JulStraus

NEWS.md

@@ -12,6 +12,7 @@
 ### Minor updates
 
 * Improved the documentation and unified the docstrings.
+* Removed error when `RegHydroStor` was still used as legacy constructor.
 
 ## Version 0.6.8 (2026-03-18)
 

docs/src/how-to/update-models.md

@@ -5,7 +5,7 @@ Hence, there are frequently breaking changes occuring, although we plan to keep
 This document is designed to provide users with information regarding how they have to adjust their models to keep compatibility to the latest changes.
 We will as well implement information regarding the adjustment of extension packages, although this is more difficult due to the vast majority of potential changes.
 
-## Adjustments from 0.4.2
+## Adjustments from 0.5.x
 
 ### Key changes for nodal descriptions
 
@@ -94,7 +94,7 @@ PumpedHydroStor{CyclicStrategic}(
 )
 ```
 
-## Adjustments from 0.4.0 to 0.6.x
+## Adjustments from 0.4.x to 0.6.x
 
 ### Key changes for nodal descriptions
 

docs/src/library/public.md

@@ -30,12 +30,6 @@ HydroPump
 HydroGate
 ```
 
-### [Legacy constructors](@id lib-pub-node-legacy)
-
-```@docs
-RegHydroStor
-```
-
 ## [Additional types](@id lib-pub-add)
 
 ### [Providing a battery lifetime](@id lib-pub-add-bat_life)

src/EnergyModelsRenewableProducers.jl

@@ -40,7 +40,7 @@ include("legacy_constructor.jl")
 export AbstractNonDisRES, NonDisRES
 
 # Simple hydro power types
-export HydroStorage, RegHydroStor, HydroStor, PumpedHydroStor
+export HydroStorage, HydroStor, PumpedHydroStor
 
 # Detailed hydro power types
 export HydroReservoir, HydroGenerator, HydroPump, HydroGate

src/legacy_constructor.jl

@@ -1,71 +1,4 @@
-"""
-    RegHydroStor(
-        id::Any,
-        rate_cap::TimeProfile,
-        stor_cap::TimeProfile,
-        has_pump::Bool,
-        level_init::TimeProfile,
-        level_inflow::TimeProfile,
-        level_min::TimeProfile,
-        opex_var::TimeProfile,
-        opex_fixed::TimeProfile,
-        stor_res::ResourceCarrier,
-        input,
-        output,
-        Data,
-    )
-
-Original Legacy constructor for a regulated hydropower storage, with or without pumping capabilities.
-This version is discontinued starting with Version 0.6.0. resulting in an error
-It is replaced with the two new types [`HydroStor`](@ref) and [`PumpedHydroStor`](@ref)
-to utilize the concept of multiple dispatch instead of logic.
-
-See the *[documentation](https://energymodelsx.github.io/EnergyModelsRenewableProducers.jl/stable/how-to/update-models/#Adjustments-from-0.4.0-to-0.6.x)*
-for further information regarding how you can translate your existing model to the new model.
-
-## Fields
-- **`id`** is the name/identifyer of the node.
-- **`rate_cap::TimeProfile`** is the installed installed rate capacity.
-- **`stor_cap::TimeProfile`** is the installed storage capacity in the dam.
-- **`has_pump::Bool`** states wheter the stored resource can flow in.
-- **`level_init::TimeProfile`** is the initial stored energy in the dam.
-- **`level_inflow::TimeProfile`** is the inflow of power per operational period.
-- **`level_min::TimeProfile`** is the minimum fraction of the reservoir capacity that
-  has to remain in the `HydroStorage` node.
-- **`opex_var::TimeProfile`** are the variable operating expenses per GWh produced.
-- **`opex_fixed::TimeProfile`** are the fixed operational costs of the storage caacity.
-- **`stor_res::ResourceCarrier`** is the stored `Resource`.
-- **`input::Dict{Resource, Real}`** are the stored and used resources. The values in the Dict
-  are ratios describing the energy loss when using the pumps.
-- **`output::Dict{Resource, Real}`** can only contain one entry, the stored resource.
-- **`data::Array{Data}`** additional data (e.g. for investments). This value is conditional
-  through the application of a constructor.
-"""
-function RegHydroStor(
-    id::Any,
-    rate_cap::TimeProfile,
-    stor_cap::TimeProfile,
-    has_pump::Bool,
-    level_init::TimeProfile,
-    level_inflow::TimeProfile,
-    level_min::TimeProfile,
-    opex_var::TimeProfile,
-    opex_fixed::TimeProfile,
-    stor_res::ResourceCarrier,
-    input,
-    output,
-    Data,
-)
-    @error(
-        "This implementation of a `RegHydroStor` will be discontinued in the near future.
-        It is replaced with the type
-            - `PumpedHydroStor` when considering a pumped hydro storage node or
-            - `HydroStor` for a standard regulated hydro power plant.
-        You can find the individual fields of these types in the documentation."
-    )
-end
-
-"""
+    """
     HydroStor(
         id::Any,
         rate_cap::TimeProfile,