Next Network

v0.5.2 - next network

API changes

• New bool attribute use_remaining_value of oemof.solph.EnergySystem
• Use list for period definition in multi-period investment optimization.

New features

• Allow for evaluating differences in the remaining vs. the original value
  for multi-period investments.
• Allow to define minimum up- and down-time per time step

Bug fixes

• Fix handling of investment annuities and fixed costs for multi-period models:
  Limit to costs that occur within the optimization horizon to prevent a
  bias towards investments happening earlier in the optimization horizon.
• Fix bugs in multi-period documentation.
• Fix minimum uptime being relevant for initial downtime (and vice versa).
• Fix duplicated discounting of fixed costs for multi-period investment

Other changes

• Improved compatibility with upcoming oemof.network

Known issues

• Documentation, example and API of OffsetConverter are inconsistent
  and might not work as expected.

Contributors

• Patrik Schönfeldt
• Johannes Kochems
• Julian Endres
• Hendrik Huyskens
• Raul Ciria Aylagas

v0.5.1: Compliant Converter

API changes

• The component Transformer is renamed to Converter.
  When people hear "transformer", they think of electrical devices.
  However, the Transformer is neither meant to be (only) electrical
  nor bidirectional (as electrical transformers typically are).
  Thus, the more generic term "converter" is now used.
  (Note that we always had the argument "conversion_factor".)
• Unify API for constant sized objects and sizing of investment. For both, Flow and
  GenericStorage, the argument investment is now deprecated. Instead,
  nominal_value and nominal_storage_capacity accept an Investment object.
• Change investment for experimental :class:oemof.solph.components.experimental._sink_dsm.SinkDSM: Remove
  obsolete parameters flex_share_down and flex_share_up.
• Mainline link component :class:oemof.solph.components._link.Link from experimental.

New features

• Add option to run multi-period (dynamic) investment models with oemof.solph as an experimental feature:
  • You can change from standard model to multi-period model by defining the newly introduced periods
    attribute of your energy system. Be aware that it is experimental as of now. periods is a dictionary
    mapping the periods you want to model (usually years) to pandas.date_range objects.
  • Add attributes periods to :class:oemof.solph._energy_system.EnergySystem.
  • Introduce new Pyomo Sets PERIODS and TIMEINDEX in :class:oemof.solph.models.Model.
  • Index all investment-related variables with PERIODS and flow variable with TIMEINDEX, which
    is a tuple of periods and timesteps.
  • Add lifetime tracking for investment options by introducing the attributes lifetime and age.
  • Add new investment-related variables total holding the total capacity, old holding capacity
    to be decommissioned, old_exo (for exogenous) holding existing capacity to be decommissioned and
    old_end holding model-endogenously installed capacity to be decommissioned after its lifetime.
  • Include discounting and calculating annuities in the objective function terms. Introduce attribute discount_rate
    of :class:oemof.solph.models.Model and interest_rate for individual investment objects (options.Investment).
• Add storage_level_constraint that allows to set flows from/to storage (in)active based on storage content.
• Model now accepts a list of EnergySystem objects, which allows for modelling of cellular energysystems.

Documentation

• See extensive documentation in user guide and API reference for the new (experimental) multi-period feature.
• Be more strict about about oemof (meta package) oemof.solph (this package).
• Improved presentation of examples as part of the documentation.

Bug fixes

• Fixed error when calling oemof_installation_test as console script.
• Corrected several typos in the docs.
• Periods with multiple period lengths are now supported in multi-period investment.
• Add missing 'custom_attributes' for the link component

Testing

• Add tests for experimental SinkDSM component.
• Add tests for multi-period investment.

Contributors

• Johannes Kochems
• Patrik Schönfeldt
• Tobi Rohrer
• Julian Endres
• Jann Launer
• Lennart Schürmann

Compliant Converter

API changes

• The component Transformer is renamed to Converter.
  When people hear "transformer", they think of electrical devices.
  However, the Transformer is neither meant to be (only) electrical
  nor bidirectional (as electrical transformers typically are).
  Thus, the more generic term "converter" is now used.
  (Note that we always had the argument "conversion_factor".)
• Unify API for constant sized objects and sizing of investment. For both, Flow and
  GenericStorage, the argument investment is now deprecated. Instead,
  nominal_value and nominal_storage_capacity accept an Investment object.
• Change investment for experimental :class:oemof.solph.components.experimental._sink_dsm.SinkDSM: Remove
  obsolete parameters flex_share_down and flex_share_up.
• Mainline link component :class:oemof.solph.components._link.Link from experimental.

New features

• Add option to run multi-period (dynamic) investment models with oemof.solph as an experimental feature:
  • You can change from standard model to multi-period model by defining the newly introduced periods
    attribute of your energy system. Be aware that it is experimental as of now. periods is a dictionary
    mapping the periods you want to model (usually years) to pandas.date_range objects.
  • Add attributes periods to :class:oemof.solph._energy_system.EnergySystem.
  • Introduce new Pyomo Sets PERIODS and TIMEINDEX in :class:oemof.solph.models.Model.
  • Index all investment-related variables with PERIODS and flow variable with TIMEINDEX, which
    is a tuple of periods and timesteps.
  • Add lifetime tracking for investment options by introducing the attributes lifetime and age.
  • Add new investment-related variables total holding the total capacity, old holding capacity
    to be decommissioned, old_exo (for exogenous) holding existing capacity to be decommissioned and
    old_end holding model-endogenously installed capacity to be decommissioned after its lifetime.
  • Include discounting and calculating annuities in the objective function terms. Introduce attribute discount_rate
    of :class:oemof.solph.models.Model and interest_rate for individual investment objects (options.Investment).
• Add storage_level_constraint that allows to set flows from/to storage (in)active based on storage content.
• Model now accepts a list of EnergySystem objects, which allows for modelling of cellular energysystems.

Documentation

• See extensive documentation in user guide and API reference for the new (experimental) multi-period feature.
• Be more strict about about oemof (meta package) oemof.solph (this package).
• Improved presentation of examples as part of the documentation.

Bug fixes

• Fixed error when calling oemof_installation_test as console script.
• Corrected several typos in the docs.
• Periods with multiple period lengths are now supported in multi-period investment.
• Add missing 'custom_attributes' for the link component

Testing

• Add tests for experimental SinkDSM component.
• Add tests for multi-period investment.

Contributors

• Johannes Kochems
• Patrik Schönfeldt
• Tobi Rohrer
• Julian Endres
• Jann Launer
• Lennart Schürmann

v0.5.1.dev2

v0.5.1

API changes

• Unify API for constant sized objects and sizing of investment. For both, Flow and
  GenericStorage, the argument investment is now deprecated. Instead,
  nominal_value and nominal_storage_capacity accept an Investment object.
• Change investment for experimental :class:oemof.solph.components.experimental._sink_dsm.SinkDSM: Remove
  obsolete parameters flex_share_down and flex_share_up.
• Mainline link component :class:oemof.solph.components._link.Link from experimental.

New features

• Add option to run multi-period (dynamic) investment models with oemof.solph as an experimental feature:
  • You can change from standard model to multi-period model by defining the newly introduced periods
    attribute of your energy system. Be aware that it is experimental as of now. periods is a dictionary
    mapping the periods you want to model (usually years) to pandas.date_range objects.
  • Add attributes periods to :class:oemof.solph._energy_system.EnergySystem.
  • Introduce new Pyomo Sets PERIODS and TIMEINDEX in :class:oemof.solph.models.Model.
  • Index all investment-related variables with PERIODS and flow variable with TIMEINDEX, which
    is a tuple of periods and timesteps.
  • Add lifetime tracking for investment options by introducing the attributes lifetime and age.
  • Add new investment-related variables total holding the total capacity, old holding capacity
    to be decommissioned, old_exo (for exogenous) holding existing capacity to be decommissioned and
    old_end holding model-endogenously installed capacity to be decommissioned after its lifetime.
  • Include discounting and calculating annuities in the objective function terms. Introduce attribute discount_rate
    of :class:oemof.solph.models.Model and interest_rate for individual investment objects (options.Investment).
• Add storage_level_constraint that allows to set flows from/to storage (in)active based on storage content.

Documentation

• See extensive documentation in user guide and API reference for the new (experimental) multi-period feature.
• Be more strict about about oemof (meta package) oemof.solph (this package).

Bug fixes

• Fixed error when calling oemof_installation_test as console script.
• Corrected several typos in the docs.

Testing

• Add tests for experimental SinkDSM component.

Contributors

• Johannes Kochems
• Patrik Schönfeldt
• Tobi Rohrer
• Julian Endres
• Jann Launer
• Lennart Schürmann

v0.5.0: Rigorous refactoring

v0.5.0 (February 3rd, 2023)

API changes

• Parts of the energy system graph are now clearly structured into buses, components, and flows.
• Public and private API are be more distinguished now. ('_' signifies private, public API is defined in init files.)
• Experimental code is now sitting in submodules called experimental (replaces "custom").
• The flow arguments summed_minand summed_max now have the more descriptive names full_load_time_min and full_load_time_max.
• Keyword arguments are now explicit. Among other things, this will catch typos. Custom attributes can be added using the argument custom_attributes. Those will be passed down the class hierachy and can (possibly) be handled in parent classes.

New features

• Add inactivity_costs as an option for Flows. Inactivity costs is a cost for times where a Flow is not operated.
• It is now possible to optimise the size of Flows that have a status variable. Internally, this is done by the InvestNonConvexFlowBlock which provides the possibility to perform capacity optimization of assets considering their min/max loads, as well as their operation status.

Documentation

• Examples are added to the documentation.

Testing

• Discontinued usage of Nose, as it is deprecated in Pytest <https://docs.pytest.org/en/stable/deprecations.html#support-for-tests-written-for-nose>.

Known issues

• The format of the examples could be improved.

Note

• Tags v0.5.0, v0.5.0a, and v0.5.0b have identical source code.
• The tag has been adjusted to have a working DOI for this code.

Contributors

• Patrik Schönfeldt
• Uwe Krien
• Saeed Sayadi
• Pierre-François Duc
• Johannes Kochems
• Johannes Röder
• David Fuhrländer
• "lensum"
• Jan Launner
• Hendrik Huyskens
• Ekaterina Zolotarevskaia
• Sarah Berendes
• Francesco Witte

v0.5.1.dev1

v0.5.1

API changes

• Unify API for constant sized objects and sizing of investment. For both, Flow and
  GenericStorage, the argument investment is now deprecated. Instead,
  nominal_value and nominal_storage_capacity accept an Investment object.
• Change investment for experimental :class:oemof.solph.components.experimental._sink_dsm.SinkDSM: Remove
  obsolete parameters flex_share_down and flex_share_up.

New features

• Add option to run multi-period (dynamic) investment models with oemof.solph as an experimental feature:
  • You can change from standard model to multi-period model by defining the newly introduced periods
    attribute of your energy system. Be aware that it is experimental as of now. periods is a dictionary
    mapping the periods you want to model (usually years) to pandas.date_range objects.
  • Add attributes periods to :class:oemof.solph._energy_system.EnergySystem.
  • Introduce new Pyomo Sets PERIODS and TIMEINDEX in :class:oemof.solph.models.Model.
  • Index all investment-related variables with PERIODS and flow variable with TIMEINDEX, which
    is a tuple of periods and timesteps.
  • Add lifetime tracking for investment options by introducing the attributes lifetime and age.
  • Add new investment-related variables total holding the total capacity, old holding capacity
    to be decommissioned, old_exo (for exogenous) holding existing capacity to be decommissioned and
    old_end holding model-endogenously installed capacity to be decommissioned after its lifetime.
  • Include discounting and calculating annuities in the objective function terms. Introduce attribute discount_rate
    of :class:oemof.solph.models.Model and interest_rate for individual investment objects (options.Investment).
• Add storage_level_constraint that allows to set flows from/to storage (in)active based on storage content.

Documentation

• See extensive documentation in user guide and API reference for the new (experimental) multi-period feature.

Bug fixes

• Fixed error when calling oemof_installation_test as console script.
• Corrected several typos in the docs.

Testing

• Add tests for experimental SinkDSM component.

Contributors

• Patrik Schönfeldt
• Johannes Kochems
• Tobi Rohrer
• Patrik Schönfeldt
• Julian Endres
• Jann Launer

v0.4.5

Reliable refresh (January 23rd, 2023)

New features

• Allow to exclude attrs from parameter_as_dict
  #825

Bug fixes

• Remove not working gradient_cost from Flow
• Exclude attrs from parameter_as_dict #824
• Fixed check for callables in processing.parameter_as_dict #823
• Refactored assertion error in Link component into suspicious warning #834
• Remove Link limit direction #896
• Fix links in setup.py #803

Testing

• Node.registry has been removed from oemof.network. All nodes have to be
  added to the energysystem explicitely. The tests have been adapted.

Contributors

• Hendrik Huyskens
• Uwe Krien
• Jann Launer
• Patrik Schönfeld
• Francesco Witte

Capable Custom Components

API changes

• Allow conversion factor of zero for GenericTransformer
• Python 3.6 is no longer officially supported. It may still work for a while though.

New components/constraints

• Custom component: oemof.solph.custom.PiecewiseLinearTransformer. A transformer model with one input and one output and an arbitrary piecewise linear conversion function. On how to use the component, refer to the test script <https://github.com/oemof/oemof-solph/blob/dev/tests/test_scripts/test_solph/test_piecewiselineartransformer/test_piecewiselineartransformer.py>_ and example <https://github.com/oemof/oemof-examples/blob/master/oemof_examples/oemof.solph/v0.4.x/piecewise/piecewise_linear_transformer.py>_.
• Enhanced custom SinkDSM:
  • Renamed keyword argument method to approach
  • Renamed approaches interval to oemof and delay to DIW
  • Added modeling approach DLR (PhD thesis of Hans Christian Gils 2015)
  • Included load shedding
  • Introduced recovery_time in DIW approach
  • Introduced shift_time and other parameters for DLR approach
  • Included investments in DSM
  • Normalized keyword arguments demand, capapcity_up and capacity_down

Bug fixes

• Check number of Flow s in GenericStorage

Other changes

• Split code into submodules
• Move CI-Tests from Travis to github (see PR #746 <https://github.com/oemof/oemof-solph/pull/746>_)

Contributors

• Jann Launer
• Johannes Kochems
• Patrik Schönfeldt
• Stefan Schirmeister
• Uwe Krien

Hotfix - Pyomo update II

Oemof-solph does not work with the latest version of Pyomo (5.7.3). In fact it does work but it takes hours.

If this problem affects you just downgrade Pyomo to 5.7.2 or lower.

pip install pyomo==5.7.2

This hotfix is released to allow installation without manually downgrading Pyomo. Instead of downgrading Pyomo you can just use:

pip install oemof.solph --upgrade

Hotfix - Pyomo update

The latest release of Pyomo broke API compatibility, though it was only a point release. This hotfix is released to allow installation without manually selecting the versions of solph's dependencies.

pip install oemof.solph --upgrade