Skip to content

Commit

Permalink
update to outcomes documentation
Browse files Browse the repository at this point in the history
resolves the documentation part of #168
  • Loading branch information
quaquel committed Sep 24, 2022
1 parent 6c1b55c commit 61c4aa0
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions ema_workbench/em_framework/outcomes.py
Original file line number Diff line number Diff line change
Expand Up @@ -343,7 +343,7 @@ def from_disk(cls, filename, archive):


class ArrayOutcome(AbstractOutcome):
"""Array Outcome class for n-dimensional collections
"""Array Outcome class for n-dimensional arrays
Parameters
----------
Expand Down Expand Up @@ -433,7 +433,7 @@ def from_disk(cls, filename, archive):

class TimeSeriesOutcome(ArrayOutcome):
"""
TimeSeries Outcome class
TimeSeries Outcome class for 1D arrays
Parameters
----------
Expand Down Expand Up @@ -461,6 +461,12 @@ class TimeSeriesOutcome(ArrayOutcome):
shape : tuple
expected_range : tuple
Notes
-----
Time series outcomes are currently assumed to be 1D arrays. If you
are dealing with higher dimensional outputs (e.g., multiple replications
resulting in 2D arrays), use ArrayOutcome instead.
"""

def __init__(self, name, variable_name=None, function=None, expected_range=None, shape=None):
Expand Down

0 comments on commit 61c4aa0

Please sign in to comment.