From fe2a8c4708a3b9c08854ee5026ef48722fffcd01 Mon Sep 17 00:00:00 2001 From: Johannes Kochems Date: Fri, 6 Oct 2023 19:05:26 +0200 Subject: [PATCH] Fix erroneous return values in docs --- src/oemof/solph/_energy_system.py | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/src/oemof/solph/_energy_system.py b/src/oemof/solph/_energy_system.py index 5b177b433..29177edfa 100644 --- a/src/oemof/solph/_energy_system.py +++ b/src/oemof/solph/_energy_system.py @@ -178,11 +178,9 @@ def __init__( def _extract_periods_years(self): """Map years in optimization to respective period based on time indices - Returns - ------- - periods_years: dict - year of the start of each period, - relative to the start of the optimization run and starting with 0 + Attribute `periods_years` of type list is set. It contains + the year of the start of each period, relative to the + start of the optimization run and starting with 0. """ periods_years = [0] if self.periods is not None: @@ -195,14 +193,11 @@ def _extract_periods_years(self): def _extract_periods_matrix(self): """Determines a matrix describing the temporal distance to each period. + + Attribute `periods_matrix` of type list np.array is set. Rows represent investment/commissioning periods, columns represent decommissioning periods. The values describe the temporal distance between each investment period to each decommissioning period. - - Returns - ------- - period_distance_matrix: np.array - """ periods_matrix = [] if self.periods is not None: