Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WDRT - Missing contours functionalities #157

Open
cmichelenstrofer opened this issue Feb 24, 2022 · 2 comments
Open

WDRT - Missing contours functionalities #157

cmichelenstrofer opened this issue Feb 24, 2022 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@cmichelenstrofer
Copy link
Contributor

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).

@cmichelenstrofer cmichelenstrofer added the enhancement New feature or request label Feb 24, 2022
@cmichelenstrofer cmichelenstrofer changed the title WDRT - missing contours functionalities WDRT - Missing contours functionalities Feb 24, 2022
@hivanov-nrel
Copy link
Contributor

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
Copy link
Contributor Author

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()

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants