search

MHKiT-Software / MHKiT-Python

MHKiT-Python provides the marine renewable energy (MRE) community tools for data processing, visualization, quality control, resource assessment, and device performance.
https://mhkit-software.github.io/MHKiT/
BSD 3-Clause "New" or "Revised" License
47 stars 45 forks source link

WDRT - Missing contours functionalities #157

Open cmichelenstrofer opened 2 years ago

cmichelenstrofer commented 2 years ago

There are some functions in WDRT left to migrate into MHKiT.

Task: Migrate missing functionalities from WDRT Contours. I added place holder functions for these in waves.contours. This include calculating steepness curve and modifying contours appropriately, adding confidence intervals on the calculated contours using bootstrap, etc. These would need tests and examples too (e.g. the existing environmental contours example).

hivanov-nrel commented 2 years ago

Below are the functions that need to be migrated from WDRT:

def steepness():
    """Calculate the breaking wave steepness curve to be plotted in a
    Hs-Tp plot.

    Can be used to modify calculated contours by setting the contour
    Hs values to the breaking value if the contour Hs is larger than
    the breaking Hs for any given period.
    """
    raise NotImplementedError()

def outside_points():
    """Return the (buoy) points outside a specific contour. """
    raise NotImplementedError()

def contour_integrator():
    """Calculate the area enclosed by a contour. """
    raise NotImplementedError()

def bootstrap():
    """Add confidence intervals (e.g. 95%) to calculated contours. """
    raise NotImplementedError()

def data_contour():
    """Create a contour around the data. """
    raise NotImplementedError()
cmichelenstrofer commented 2 years ago 
def steepness():
    """Calculate the breaking wave steepness curve to be plotted in a
    Hs-Tp plot.

    Can be used to modify calculated contours by setting the contour
    Hs values to the breaking value if the contour Hs is larger than
    the breaking Hs for any given period.
    """
    raise NotImplementedError()

def outside_points():
    """Return the (buoy) points outside a specific contour. """
    raise NotImplementedError()

def contour_integrator():
    """Calculate the area enclosed by a contour. """
    raise NotImplementedError()

def bootstrap():
    """Add confidence intervals (e.g. 95%) to calculated contours. """
    raise NotImplementedError()

def data_contour():
    """Create a contour around the data. """
    raise NotImplementedError()