Replace ItemInfo with fmskill.Quantity

[ecomodeller]

No description provided.

[ecomodeller]

fmskill aims to be a general purpose model skill assessment library, not limited to MIKE by DHI models.

This PR aims to loosen up the connection to the EUM system. The EUM information available in {Dfs0, Dfsu} files are still read, but for other model types, you are free to supply this information as strings for the name of the quantity and unit.

>>> from fmskill import Quantity
>>> wl = Quantity(name="Water level", unit="m")
>>> wl
Quantity(name='Water level', unit='m')
>>> uq = Quantity.undefined()
>>> uq
Quantity(name='Undefined', unit='Undefined')
>>> wl2 = Quantity(name="Water level", unit="m")
>>> wl == wl2
True
>>> wl == uq
False
>>> wl.is_compatible(uq)
True

[ecomodeller]

And the addition of a new TimeSeries class

classDiagram
    Observation <|-- PointObservation
    Observation <|-- TrackObservation
    TimeSeries <|-- Observation
   TimeSeries <|-- PointModelResult

class TimeSeries{
+  str name
+  dataframe data
+  Quantity quantity
+ plot()
+ hist()
}

class PointModelResult{
+ float x
+ float y
}

class Observation{
+ float weight
+ str color
}

class PointObservation{
+ float x
+ float y
}

class TrackObservation{
+ float[] x
+ float[] y
}

class Quantity{
+ str name
+ str unit
}

Loading

[jsmariegaard]

I like it 😍

[jsmariegaard]

not used?

[jsmariegaard]

Optional[Quantity]

[jsmariegaard]

Thanks a lot. This looks great. A few things to consider:

• Generally I think it's great to have a class "Quantity" that we can use when the source is not dfs, but I was also thinking that we maybe should support providing a str also and then potentially use mikeio.ItemInfo to try to pass that string to get a default unit or otherwise just leave the unit blank? I just think it is nice to allow simple inputs for new users.
• I guess we could also allow for ItemInfo as input to quantity... because a user may have a mix of csv and dfs´s and the ItemInfo may therefore be nearby...
• Some places the docstring still says that the type is str: quantity : Optional[str] (and the text below says "A string to identify the quantity") - try to search for it.
• So far the Quantity disappears when the comparison is made (it's stored in the attrs) - should we keep it this way?
• Would it make sense in the future (not this PR) to extend the Quantity with short_name etc?
• I think it would be nice somehow to be able to restore the origin of the data (filename and item_name where applicable) - could that be stored in attrs?
• I like the .plot etc a lot. But please note that the .plot.timeseries for track observations will give 3 red series (x,y and values).