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

DOLfYN source code #169

Merged
merged 20 commits into from
Jul 26, 2022
Merged

DOLfYN source code #169

merged 20 commits into from
Jul 26, 2022

Conversation

jmcvey3
Copy link
Contributor

@jmcvey3 jmcvey3 commented May 4, 2022

Integrated source code with latest bugfixes.
Will need to update jupyter notebook documentation links once docs are completed.

Copy link
Contributor

@ssolson ssolson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

James thank you for putting this together. I feel like I have a quarter of the knowledge and time required to understand and test the many capabilities that DOLfYN brings to MHKiT. I have done my best to provide feedback and questions where it felt appropriate. I have some questions around the documentation and what some the formatting in the docstring looks like in our API documentation outstanding. Let us have a chat soon and get this PR wrapped up. Thanks again!

Comment on lines 70 to 71
# def test_motion_adcp(self):
# # Correction for ADCPs not completed yet
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is going on with this test?

@@ -35,7 +35,7 @@
"outputs": [],
"source": [
"from mhkit import dolfyn as dlfn\n",
"from dolfyn.adp import api"
"from mhkit.dolfyn.adp import api"
]
},
{
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After this section there is a part that says:

The instruments that DOLfYN supports are listed in the docs.

Which links to the old dolfyn docs. Can we get these docs into MHKiT and link internally to the MHKiT docs?

def calc_velacc(self, ):
"""
Calculates the translational velocity from the high-pass
filtered acceleration sigal.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

signal

dat = np.concatenate((np.zeros(list(hp.shape[:-1]) + [1]),
cumtrapz(hp, dx=1 / samp_freq)), axis=-1)

# Filter again?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this asking if we need to filter again bc L125 states to filter twice?

It seems that at this point accelvel_filtfreq = vel_filtfreq so I believe this is the second filtering.

Comment on lines 189 to 193
Currently this only works for Nortek Vectors!

In the future, we could use the transformation matrix (and a
probe-length lookup-table?)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let us make the standard docstring including a brief description and parameter and returns and leave the current docstrings as a note perhaps.


return out_ds

def do_var(self, raw_ds, out_ds=None, names=None, suffix='_var'):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have tried to ignore most of the names in this pr but "do_var" and "do_avg" seem pretty bad 😆 . Up to you if you want to keep but I would suggest changing.


return out_ds

def _check_ds(self, raw_ds, out_ds):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we could add a quick docstring to summarize what this function is checking for?

else:
return np.arange(npt, dtype=np.float32) - int(npt // 2)

def calc_coh(self, veldat1, veldat2, window='hann', debias=True,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Its okay if you think we should keep the traditional DOLfYN naming convention but I think coherence spelled out would be more clear and easier to find.

fft = np.fft.fft


def psd_freq(nfft, fs, full=False):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I typically try to avoid repetitive naming like tools.psd.psd_freq but again if you prefer to keep it this way for DOLFyN I am okay with that.

# This defines how cross-spectra and stresses are computed.
_cross_pairs = [(0, 1), (0, 2), (1, 2)]

def do_tke(self, ds, out_ds=None):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again I am not a fan of functions starting with "do"

@jmcvey3
Copy link
Contributor Author

jmcvey3 commented Jun 22, 2022

@ssolson Did some renaming and reorganization to hopefully make the analysis functions easier to understand. Top level functions are located in velocity.py, mid-level in binned.py, and base-level in the "tools" folder. I would expect most users to utilize the top-level functions, but the public functions in the lower two levels are useful for python-knowledgeable users.

We had also discussed creating an issue to reassign functions that exist in other packages (like scipy) as I was under the impression that generic statistical calculations like coherence, phase-angle and auto/cross-covariance would exist in other packages. Apparently they do not.

@jmcvey3
Copy link
Contributor Author

jmcvey3 commented Jun 28, 2022

Failures appears to be new bugs in the netCDF4 1.6.0 release

@ssolson
Copy link
Contributor

ssolson commented Jul 18, 2022

Hey James I documented the netcdf issue in #177. As far as I can tell this is not a Dolfyn issue. Can you merge the latest development branch in this PR as a temporary fix. I will follow up on the netCDF issue in a separate PR.

Also can you edit the merge to occur to the Develop branch instead of the master?

@ssolson ssolson added the enhancement New feature or request label Jul 20, 2022
@ssolson
Copy link
Contributor

ssolson commented Jul 25, 2022

Hey James I have been looking into this more and it appears that it is actually the Dolfyn xarray .to_netcdf method which is breaking the UNIX tests for MHKiT which you can checkout on #181. I am going to be poking around to see if I can fix it but if you get a chance to take a quick stab at it I would appreciate your thoughts on the problem and could run with any ideas you may have to fix it.

Based on our last conversation/ review of Dolfyn is this PR ready to go?

@jmcvey3
Copy link
Contributor Author

jmcvey3 commented Jul 25, 2022

Hey James I have been looking into this more and it appears that it is actually the Dolfyn xarray .to_netcdf method which is breaking the UNIX tests for MHKiT which you can checkout on #181. I am going to be poking around to see if I can fix it but if you get a chance to take a quick stab at it I would appreciate your thoughts on the problem and could run with any ideas you may have to fix it.

Based on our last conversation/ review of Dolfyn is this PR ready to go?

It is ready to go. I haven't been able to replicate this error yet, but I'll keep searching for a solution

@jmcvey3
Copy link
Contributor Author

jmcvey3 commented Jul 25, 2022

Hey James I have been looking into this more and it appears that it is actually the Dolfyn xarray .to_netcdf method which is breaking the UNIX tests for MHKiT which you can checkout on #181. I am going to be poking around to see if I can fix it but if you get a chance to take a quick stab at it I would appreciate your thoughts on the problem and could run with any ideas you may have to fix it.
Based on our last conversation/ review of Dolfyn is this PR ready to go?

It is ready to go. I haven't been able to replicate this error yet, but I'll keep searching for a solution

@ssolson Apparently recreating the test file fixes that issue #181

@ssolson ssolson changed the base branch from master to Develop July 26, 2022 14:11
@ssolson ssolson mentioned this pull request Jul 26, 2022
@ssolson ssolson merged commit 2537c2d into MHKiT-Software:Develop Jul 26, 2022
@ssolson ssolson mentioned this pull request Feb 10, 2023
ssolson added a commit that referenced this pull request Feb 10, 2023
* Merge Master into Develop (#179)

* Include last day of year (#160)

Include the last day of the year when using years parameter. Fixes #154.

* Timezone Bug fix: remove `.replace()` for `.astimezone()` (#161)

* Bug fix: remove timezone replace for astimezone

* add pytz to required packages

* Fix: Pandas latest (#159)

* Plot each col in DataFrame individually

* Remove numpy and pandas version requirements

* WDRT (#141)

* Working version of Gaussian Copula

* Create dedicated function for iso probs and quantiles

* Contour plots worsk for single and multiple contours

* Gumbel Copula.

* Clayton Copula

* Rosenblatt Copula

* Guass and gumbel general copula

* Add support for nonparametric gaussian, clayton, and gumbel copulas

* Require statsmodel for nonparametric KDE copulas

* Small changes

* Fix bug in KDE log transformation

* Adding docstrings

* All doc strings updated

* Add markers option to contours plotting

* Add Copula tests comparing to WDRTresults

* Fix x1, x2 pts bug in KDE contour, clean up

* Example showing the calculation of all copla methods and comparing to WDRT results

* Simplifications and lanuguage cleanup

* Add statsmodel

* Add testing data files

* In plot envrionmental contors convert x1,x2 to values if a Series is passed

* Docstring typo corrections

* Corrected notebook description typos.

* module and example for short-term extreme distributions

* docstrings for short-term extreme functions

* fixes #140 Speedup surface elevation calculation.

* correction to surface_elevation

* elevation

* minor fixes based on review comments

* add environmental_contours to init

* Remove WDRT functionality

* All WDRT contour functionality can be called from one function

* Rework tests for new contour functions setup and location

* Move all contour example into this file

* Update to work with new structure.

* Remove all commented out wdrt functions from resource

* No changes made. Reverting back.

* Have PCA method use general fit. Adds PCAmethod to fit method but can also accept the PCA dictionary. General Docstring Cleanup

* Update discussion around the use of the copula method.

* Remove copula stand alone notebook

* minor formmating changes

* Remove test bugs created from merge with origin

* Import env contours into resource module and adjust test, examples, ect to function with tthe new structure

* Uncommented tests

* Remove reference to import the env contours module

* fixing minor typo

* Move env contours to _file and adjust package to handle new structure

* Minor formatting cleanup

* Cleanup unsed packages and variables

* intial mler upload

* formalize functions

* add tests and example

* sampling rate to averaging period

* rename MLER example

* working

* merging

* WDRT functions and examples finalized. Missing tests.

* integrate mler into extreme

* fixes tests?

* fix tests

* fix tests

* fix full sea state example?

* test contour samples

* test sample full seastate

* random seed

* test long term extreme

* expand MLER functionality

* test short-term extremes

* fix mler tests

* MLER test error

* mler fix 2

* update formats and asserts

* further cleanup of countours.py for consistency, typos, and pep8

* run tests?

* fix test?

* change lists to np.array so they pass the assert statements

* clean extreme.py for consistency, pep8

* points_per_interval should be int

* typing in examples

* full sea state example: make it easier to follow, add more explanation, and use consistent naming

* contour example: make it easier to follow, add more explanation, and use consistent naming

* Alias ste function and minor formatting.

* naming convention

* rename example

* ste example

* allow weights to be np.array

* allow weights to be np.ndarray

Co-authored-by: ssolson <ssolson@sandia.gov>
Co-authored-by: ssolson <ssolson@users.noreply.github.com>
Co-authored-by: rpauly18 <rpauly@nrel.gov>
Co-authored-by: hivanov-nrel <53838851+hivanov-nrel@users.noreply.github.com>

* DOLfYN IO (#126)

* input output files
+ testing

* Code update

* Test reformatting

* Testing paths

* dependency switch from h5netcdf to netcdf4

* Code cleanup

* Test import fix

* Minor docstring edits

* Add dolfyn test data

* Test fixes for mhkit

* Removing uneeded test files, improving consistency

* Not sure why these files didn't upload

* Organizational changes and clarifications. Request for additional clarification

* Dolfyn codebase updates

* Dolfyn example notebooks update

* Testing updates

* Update example datafile

* Latest dolfyn v0.13.0 updates

* Name change

* input output files
+ testing

* Code update

* Organizational changes and clarifications. Request for additional clarification

* Dolfyn codebase updates

* fix bug and make faster. Un-hard-code default seed/phase.

* fix tests

* delete commented out tests

* retrigger checks

* Checkpoint push

* New dolfyn data files

* Reorganize dolfyn testing

* pytest install for warnings tests

* Final update for IO

* Remove future updates

* Ensure file compression runs

* Update numpy dependency

* trying numpy v1.22

* changing numpy requirements

* Remake unittest test cases

* Save format options

* Add dolfyn view to notebooks

* Decode remaining binary ad2cp variables

* DOLfYN 1.0.0 dependency

Co-authored-by: jmcvey3 <james13rmh@gmail.com>
Co-authored-by: ssolson <ssolson@sandia.gov>
Co-authored-by: Michelen <cmichel@sandia.gov>
Co-authored-by: jmcvey3 <jmcvey3@users.noreply.github.com>
Co-authored-by: rpauly18 <rpauly@nrel.gov>

* regenerate WDRT examples (#163)

* updating version number in package

* fixing dolfyn imports from pip

* updating version number for bug fix

* NDBC Metocean data (#152)

* catch extra header in ndbc data

* NDBC cwind example

* update unit catch in request_data

* update gust plot to show more data

* add tests to read cwind with and without units

* move graphics import to ndbc module and fix capitalization

* use resample, add gridlines, rename variables, replace NDBC nans up front

* rename wind_example to metocean_example

* adding "Develop" branch to PR

Co-authored-by: Carlos A. Michelén Ströfer <cmichel@sandia.gov>
Co-authored-by: rpauly18 <rpauly@nrel.gov>
Co-authored-by: hivanov-nrel <53838851+hivanov-nrel@users.noreply.github.com>
Co-authored-by: jmcvey3 <53623232+jmcvey3@users.noreply.github.com>
Co-authored-by: jmcvey3 <james13rmh@gmail.com>
Co-authored-by: jmcvey3 <jmcvey3@users.noreply.github.com>
Co-authored-by: rpauly18 <50752018+rpauly18@users.noreply.github.com>
Co-authored-by: Adam Keester <72414466+akeeste@users.noreply.github.com>

* Test Suite Restructure (#174)

* test_wave file to folder with individual feature files

* Move io tests into io folder

* Send plots to a plots folder

* Move resource characterizations plot tests into resource metrics file

* move load tests to folder

* move power tests to folder

* move river tests to folder

* move tidal tests to folder

* move utils tests to folder

* add inits so that tests pick up the tests in subfolders

* Require previous netCDF4 release.

* FIx data directory path

* Fix data directory path

* Fix load data directory path

* Remove relpath call to see if it fixes Windows test suite issues

* Remove relpath from the rest of io tests in wave

* DOLfYN source code (#169)

* Initial push

* Latest bugfixes

* Remove phase-in text

* Update docstrings

* Readability, imports

* Make functions public

* Docstring updates

* Fix test oversight

* Fix docstring

* Missing timestamp fix for classic Nortek

* Docstring updates

* Renaming functions per mhkit standards

* Single array vs binned array functions

* Reorganizing analysis code

* Update invalid orientation matrix warning

* Add config details to dataset attributes

* dolfyn bugfixes

Co-authored-by: jmcvey3 <jmcvey3@users.noreply.github.com>

* Delft 3D Timestep to Seconds Function (#168)

* fixing file history

* fixing file history

* fixing file history

* made revisions from ssolson review

* changed time_stamp to timestamp

* updated varible names

* updated variable names

* fixed syntax line 63

* umdated variable name

* fixed typos in doc strings

* ssolson review 5-26-2022

* deleted excessive code in get_all_data

* chaged TI to a % from a fraction

* adjusted TI test to be a %

* fixed doc string for TI function

* Docstring adjustments

* updated doc strings

* Make convert_time a hidden func, make 2 functions to access it

* Minor changes to get_lay_data docstring and formatting

* small changes

* remove print from create_points

* example notebook clean up

* fixed merge confilics

* updated after merge

* final developmet barnach merge updates

* deleated space

* Delete test_river.py

* added coverage to test

* updated min and max plot labels

Co-authored-by: Browning <eabrow@sandia.gov>
Co-authored-by: ssolson <ssolson@sandia.gov>

* NetCDF4 (#181)

* Use conda TEST env on Py 3.7, 3.8, 3.9

* Use pip install with Py 3.8 and 3.9.

* Updates for WEC-Sim v5.0 (#185)

* update read_wecsim for WEC-Sim v5.0

* add cable class

* update notebook with results

* add try-except for Morrison (v4.1) vs Morison (v4.2+)

* add cable check and dataset to wave tests

* update cable dataset

* Fix pip install tests (#194)

* Require previous version of NetCDF4.

* Use original pre install for environemnt in pip tests

* Only test pip

* No loading shell PATH

* Do not upgrade h5py

* Set NETCDF to 1.5.8

* pytest and coverage

* yaml syntax fix

* Change need to pip-build

* Control coverage and test via rc files

* Move configuration file to workflows directory

* Move configuration file to workflows directory

* Specify the location of configuration files in coverage/pytest call

* run conda & pip, pass both to coveralls

* conda bash -l {0}

* Add hindcast build which runs serial

* configuration files for hindcast run

* Specify hindcast configuration for hindcast build

* Remove version specification from hindcast calls

* Specify configuration files to include/omit hindcast accordingly

* Change job name

* Fix configuration to hindcast file not test

* Use all OS and py versions in tests

* pandas <=1.5.0

* xarray <=2022.9.0

* Only hindcast

* Clean up package install

* Fixing hypy and h5pyd to previous versions

* Run limited other tests

* No hindcast tests

* remove hindcast comments and coveralls call

* remove py3.8 from pip build

* requirements.txt netCDF <= 1.5.8

* Add function to compute value at a given return period (#193)

* Run CI on push to Develop (#200)

* Dolfyn general updates (#186)

* Initial push

* Latest bugfixes

* Remove phase-in text

* Update docstrings

* Readability, imports

* Make functions public

* Docstring updates

* Fix test oversight

* Fix docstring

* Missing timestamp fix for classic Nortek

* Docstring updates

* Renaming functions per mhkit standards

* Single array vs binned array functions

* Reorganizing analysis code

* Update invalid orientation matrix warning

* Add config details to dataset attributes

* dolfyn bugfixes

* ADV updates
:

* Update compression option for netcdf4

* Remove compression options

* Fix clean function

* Set functions as private

* Move stress functions to ADV dir

* Add bottleneck to reqs

* Minor changes

* Remove old functions

* Code simplification

* Update examples

* Make functions public

* Add bottleneck to dependencies

* Fix notebook

* Bugfix for beam vars

Co-authored-by: jmcvey3 <jmcvey3@users.noreply.github.com>

* Delft3D z calculation (#190)

* updated variable names

* updated variable names

* updated variable names

* fixed a few docstring typos

* updated s1 to water level

* updated s1 to waterlevel

* updated s1 to waterlevel

* updated s1 to water level

* updated s1 to waterlever

* fixed typo depth to waterdepth

* added edges = nearest example

* added edges = nearest option in variable interpolate

* updated z to waterdepth

* added edges= nearest example

Co-authored-by: Browning <eabrow@sandia.gov>

* Directional NDBC  (#197)

* working on directional NDBC

* clean up functions. Write docstrings. Write assert statements. Write tests. Create Tutorial.

* docstring and asserts for plotting function

* Bug Fix: Averaging histogram bin and wave energy (#205)

* Fix averaging bug
* Add outline to bin counts text for better contrast
* Update plotting function and plot in example notebook

* Fix: update variable name to remove reference before assignment error (#208)

* update wave.contours.samples_contour to not get variable referenced before assignment error

Co-authored-by: Graham Penrose <graham@evergreeninnovations.co>

* HSDS (#211)

Adds hindcast tests back into the test suite. The NREL HSDS API issues were resolved by creating multiple calls to the API for direction wave spectrum requests. Additionally, an exponential back-off time was implemented to retry calls with an increased wait time between calls.

Co-authored-by: Adam Keester <72414466+akeeste@users.noreply.github.com>

* Provide function to convert from Te to Tp using ITTC approximation (#210)

* Provide function to convert from Te to Tp using ITTC approximation

* Apply suggestions from code review

Co-authored-by: Adam Keester <72414466+akeeste@users.noreply.github.com>

* Metocean module - WIND Toolkit (#187)

* initial script

* update wind_toolkit with 4 regions and 1-hr or 5-min data

* update parameters of wind_toolkit functions

* compare NDBC and WIND metocean data

* fix typo in wpto hindcast example

* finish metocean example and add results

* add wind_toolkit to wave/io/__init__.py

* update WIND Toolkit parameter list

* initial test structure for WIND toolkit

* finish metocean example

* add function to plot each region

* wind toolkit tests and test data

* add tests for misc wind_toolkit MHKiT functions and cases

* fix wind toolkit tests

* add elevation_to_string utility function

* misc cleanup

* clarify available parameters

* add users lat_lon to plot_region visualization

* update example with new functions

* add numpy dependency back in

* Ingnore the new hindcast folder

* Include only the new hindcast folder

* Move hindcast tests to hindcast folder

* Specify exclusion of hindcast from standard coverage

* update hindcast coverage

* remove unnecessary header

* move hindcast and wind_toolkit to wave/io/hindcast

* update .coveragerc files

* update paths for new wave.io.hindcast directory

Co-authored-by: ssolson <ssolson@sandia.gov>

* Dolfyn updates (#212)

* RDI reader, logging, duty cycle motion correction

* Updates

* Force float32 datatype

* Docstring formatting

* Change 'default' docstring default

* Remove old comments

* Trasect comparison (#199)

* Require previous version of NetCDF4.

* updated variable names

* updated variable names

* updated variable names

* fixed a few docstring typos

* updated s1 to water level

* updated s1 to waterlevel

* updated s1 to waterlevel

* updated s1 to water level

* updated s1 to waterlever

* fixed typo depth to waterdepth

* D3d Tanana Transect Example

* added optional edge interpolation with nearest

* updated z to water depth

* RDI reader, logging, duty cycle motion correction

* add dolfyn, currenly will not run on the branch need jmcvey3 trdi_5beam

* found river bottom and removed data below

* Updates

* Force float32 datatype

* added downsampelind comparison and tried contourf

* D3D tanana data

* tanana transect 2

* tanana transect 3

* Docstring formatting

* Change 'default' docstring default

* Remove old comments

* updated code to match Energies paper

* Review

* Boat transect image

* updated variable names

* updated variable names

* updated variable names added to discriptions

* Clean up and suggestions

* added to the examples

* TRTS study edits

* code and discription updates

* Edits and TODOs

* moved files, updated discriptions

* readding Delft3D_example notebook

* added USGS discharge

* updated doc strings

* example updates and move data files

* updated doc strings and Error equations

* updated doc strings

* pulled down development branch

---------

Co-authored-by: ssolson <ssolson@sandia.gov>
Co-authored-by: Browning <eabrow@sandia.gov>
Co-authored-by: jmcvey3 <53623232+jmcvey3@users.noreply.github.com>

---------

Co-authored-by: Carlos A. Michelén Ströfer <cmichel@sandia.gov>
Co-authored-by: rpauly18 <rpauly@nrel.gov>
Co-authored-by: hivanov-nrel <53838851+hivanov-nrel@users.noreply.github.com>
Co-authored-by: jmcvey3 <53623232+jmcvey3@users.noreply.github.com>
Co-authored-by: jmcvey3 <james13rmh@gmail.com>
Co-authored-by: jmcvey3 <jmcvey3@users.noreply.github.com>
Co-authored-by: rpauly18 <50752018+rpauly18@users.noreply.github.com>
Co-authored-by: Adam Keester <72414466+akeeste@users.noreply.github.com>
Co-authored-by: Emily Browning <63879572+browniea@users.noreply.github.com>
Co-authored-by: Browning <eabrow@sandia.gov>
Co-authored-by: Mark Bruggemann <mark@bruggemann.co.uk>
Co-authored-by: Graham Penrose <graham@evergreeninnovations.co>
ssolson added a commit that referenced this pull request May 8, 2023
* Require previous version of NetCDF4.

* Merge Master into Develop (#179)

* Include last day of year (#160)

Include the last day of the year when using years parameter. Fixes #154.

* Timezone Bug fix: remove `.replace()` for `.astimezone()` (#161)

* Bug fix: remove timezone replace for astimezone

* add pytz to required packages

* Fix: Pandas latest (#159)

* Plot each col in DataFrame individually

* Remove numpy and pandas version requirements

* WDRT (#141)

* Working version of Gaussian Copula

* Create dedicated function for iso probs and quantiles

* Contour plots worsk for single and multiple contours

* Gumbel Copula.

* Clayton Copula

* Rosenblatt Copula

* Guass and gumbel general copula

* Add support for nonparametric gaussian, clayton, and gumbel copulas

* Require statsmodel for nonparametric KDE copulas

* Small changes

* Fix bug in KDE log transformation

* Adding docstrings

* All doc strings updated

* Add markers option to contours plotting

* Add Copula tests comparing to WDRTresults

* Fix x1, x2 pts bug in KDE contour, clean up

* Example showing the calculation of all copla methods and comparing to WDRT results

* Simplifications and lanuguage cleanup

* Add statsmodel

* Add testing data files

* In plot envrionmental contors convert x1,x2 to values if a Series is passed

* Docstring typo corrections

* Corrected notebook description typos.

* module and example for short-term extreme distributions

* docstrings for short-term extreme functions

* fixes #140 Speedup surface elevation calculation.

* correction to surface_elevation

* elevation

* minor fixes based on review comments

* add environmental_contours to init

* Remove WDRT functionality

* All WDRT contour functionality can be called from one function

* Rework tests for new contour functions setup and location

* Move all contour example into this file

* Update to work with new structure.

* Remove all commented out wdrt functions from resource

* No changes made. Reverting back.

* Have PCA method use general fit. Adds PCAmethod to fit method but can also accept the PCA dictionary. General Docstring Cleanup

* Update discussion around the use of the copula method.

* Remove copula stand alone notebook

* minor formmating changes

* Remove test bugs created from merge with origin

* Import env contours into resource module and adjust test, examples, ect to function with tthe new structure

* Uncommented tests

* Remove reference to import the env contours module

* fixing minor typo

* Move env contours to _file and adjust package to handle new structure

* Minor formatting cleanup

* Cleanup unsed packages and variables

* intial mler upload

* formalize functions

* add tests and example

* sampling rate to averaging period

* rename MLER example

* working

* merging

* WDRT functions and examples finalized. Missing tests.

* integrate mler into extreme

* fixes tests?

* fix tests

* fix tests

* fix full sea state example?

* test contour samples

* test sample full seastate

* random seed

* test long term extreme

* expand MLER functionality

* test short-term extremes

* fix mler tests

* MLER test error

* mler fix 2

* update formats and asserts

* further cleanup of countours.py for consistency, typos, and pep8

* run tests?

* fix test?

* change lists to np.array so they pass the assert statements

* clean extreme.py for consistency, pep8

* points_per_interval should be int

* typing in examples

* full sea state example: make it easier to follow, add more explanation, and use consistent naming

* contour example: make it easier to follow, add more explanation, and use consistent naming

* Alias ste function and minor formatting.

* naming convention

* rename example

* ste example

* allow weights to be np.array

* allow weights to be np.ndarray

Co-authored-by: ssolson <ssolson@sandia.gov>
Co-authored-by: ssolson <ssolson@users.noreply.github.com>
Co-authored-by: rpauly18 <rpauly@nrel.gov>
Co-authored-by: hivanov-nrel <53838851+hivanov-nrel@users.noreply.github.com>

* DOLfYN IO (#126)

* input output files
+ testing

* Code update

* Test reformatting

* Testing paths

* dependency switch from h5netcdf to netcdf4

* Code cleanup

* Test import fix

* Minor docstring edits

* Add dolfyn test data

* Test fixes for mhkit

* Removing uneeded test files, improving consistency

* Not sure why these files didn't upload

* Organizational changes and clarifications. Request for additional clarification

* Dolfyn codebase updates

* Dolfyn example notebooks update

* Testing updates

* Update example datafile

* Latest dolfyn v0.13.0 updates

* Name change

* input output files
+ testing

* Code update

* Organizational changes and clarifications. Request for additional clarification

* Dolfyn codebase updates

* fix bug and make faster. Un-hard-code default seed/phase.

* fix tests

* delete commented out tests

* retrigger checks

* Checkpoint push

* New dolfyn data files

* Reorganize dolfyn testing

* pytest install for warnings tests

* Final update for IO

* Remove future updates

* Ensure file compression runs

* Update numpy dependency

* trying numpy v1.22

* changing numpy requirements

* Remake unittest test cases

* Save format options

* Add dolfyn view to notebooks

* Decode remaining binary ad2cp variables

* DOLfYN 1.0.0 dependency

Co-authored-by: jmcvey3 <james13rmh@gmail.com>
Co-authored-by: ssolson <ssolson@sandia.gov>
Co-authored-by: Michelen <cmichel@sandia.gov>
Co-authored-by: jmcvey3 <jmcvey3@users.noreply.github.com>
Co-authored-by: rpauly18 <rpauly@nrel.gov>

* regenerate WDRT examples (#163)

* updating version number in package

* fixing dolfyn imports from pip

* updating version number for bug fix

* NDBC Metocean data (#152)

* catch extra header in ndbc data

* NDBC cwind example

* update unit catch in request_data

* update gust plot to show more data

* add tests to read cwind with and without units

* move graphics import to ndbc module and fix capitalization

* use resample, add gridlines, rename variables, replace NDBC nans up front

* rename wind_example to metocean_example

* adding "Develop" branch to PR

Co-authored-by: Carlos A. Michelén Ströfer <cmichel@sandia.gov>
Co-authored-by: rpauly18 <rpauly@nrel.gov>
Co-authored-by: hivanov-nrel <53838851+hivanov-nrel@users.noreply.github.com>
Co-authored-by: jmcvey3 <53623232+jmcvey3@users.noreply.github.com>
Co-authored-by: jmcvey3 <james13rmh@gmail.com>
Co-authored-by: jmcvey3 <jmcvey3@users.noreply.github.com>
Co-authored-by: rpauly18 <50752018+rpauly18@users.noreply.github.com>
Co-authored-by: Adam Keester <72414466+akeeste@users.noreply.github.com>

* Test Suite Restructure (#174)

* test_wave file to folder with individual feature files

* Move io tests into io folder

* Send plots to a plots folder

* Move resource characterizations plot tests into resource metrics file

* move load tests to folder

* move power tests to folder

* move river tests to folder

* move tidal tests to folder

* move utils tests to folder

* add inits so that tests pick up the tests in subfolders

* Require previous netCDF4 release.

* FIx data directory path

* Fix data directory path

* Fix load data directory path

* Remove relpath call to see if it fixes Windows test suite issues

* Remove relpath from the rest of io tests in wave

* DOLfYN source code (#169)

* Initial push

* Latest bugfixes

* Remove phase-in text

* Update docstrings

* Readability, imports

* Make functions public

* Docstring updates

* Fix test oversight

* Fix docstring

* Missing timestamp fix for classic Nortek

* Docstring updates

* Renaming functions per mhkit standards

* Single array vs binned array functions

* Reorganizing analysis code

* Update invalid orientation matrix warning

* Add config details to dataset attributes

* dolfyn bugfixes

Co-authored-by: jmcvey3 <jmcvey3@users.noreply.github.com>

* Delft 3D Timestep to Seconds Function (#168)

* fixing file history

* fixing file history

* fixing file history

* made revisions from ssolson review

* changed time_stamp to timestamp

* updated varible names

* updated variable names

* fixed syntax line 63

* umdated variable name

* fixed typos in doc strings

* ssolson review 5-26-2022

* deleted excessive code in get_all_data

* chaged TI to a % from a fraction

* adjusted TI test to be a %

* fixed doc string for TI function

* Docstring adjustments

* updated doc strings

* Make convert_time a hidden func, make 2 functions to access it

* Minor changes to get_lay_data docstring and formatting

* small changes

* remove print from create_points

* example notebook clean up

* fixed merge confilics

* updated after merge

* final developmet barnach merge updates

* deleated space

* Delete test_river.py

* added coverage to test

* updated min and max plot labels

Co-authored-by: Browning <eabrow@sandia.gov>
Co-authored-by: ssolson <ssolson@sandia.gov>

* NetCDF4 (#181)

* Use conda TEST env on Py 3.7, 3.8, 3.9

* Use pip install with Py 3.8 and 3.9.

* Updates for WEC-Sim v5.0 (#185)

* update read_wecsim for WEC-Sim v5.0

* add cable class

* update notebook with results

* add try-except for Morrison (v4.1) vs Morison (v4.2+)

* add cable check and dataset to wave tests

* update cable dataset

* updated variable names

* updated variable names

* updated variable names

* fixed a few docstring typos

* updated s1 to water level

* updated s1 to waterlevel

* updated s1 to waterlevel

* updated s1 to water level

* updated s1 to waterlever

* fixed typo depth to waterdepth

* D3d Tanana Transect Example

* Fix pip install tests (#194)

* Require previous version of NetCDF4.

* Use original pre install for environemnt in pip tests

* Only test pip

* No loading shell PATH

* Do not upgrade h5py

* Set NETCDF to 1.5.8

* pytest and coverage

* yaml syntax fix

* Change need to pip-build

* Control coverage and test via rc files

* Move configuration file to workflows directory

* Move configuration file to workflows directory

* Specify the location of configuration files in coverage/pytest call

* run conda & pip, pass both to coveralls

* conda bash -l {0}

* Add hindcast build which runs serial

* configuration files for hindcast run

* Specify hindcast configuration for hindcast build

* Remove version specification from hindcast calls

* Specify configuration files to include/omit hindcast accordingly

* Change job name

* Fix configuration to hindcast file not test

* Use all OS and py versions in tests

* pandas <=1.5.0

* xarray <=2022.9.0

* Only hindcast

* Clean up package install

* Fixing hypy and h5pyd to previous versions

* Run limited other tests

* No hindcast tests

* remove hindcast comments and coveralls call

* remove py3.8 from pip build

* requirements.txt netCDF <= 1.5.8

* Add function to compute value at a given return period (#193)

* Run CI on push to Develop (#200)

* added optional edge interpolation with nearest

* updated z to water depth

* Dolfyn general updates (#186)

* Initial push

* Latest bugfixes

* Remove phase-in text

* Update docstrings

* Readability, imports

* Make functions public

* Docstring updates

* Fix test oversight

* Fix docstring

* Missing timestamp fix for classic Nortek

* Docstring updates

* Renaming functions per mhkit standards

* Single array vs binned array functions

* Reorganizing analysis code

* Update invalid orientation matrix warning

* Add config details to dataset attributes

* dolfyn bugfixes

* ADV updates
:

* Update compression option for netcdf4

* Remove compression options

* Fix clean function

* Set functions as private

* Move stress functions to ADV dir

* Add bottleneck to reqs

* Minor changes

* Remove old functions

* Code simplification

* Update examples

* Make functions public

* Add bottleneck to dependencies

* Fix notebook

* Bugfix for beam vars

Co-authored-by: jmcvey3 <jmcvey3@users.noreply.github.com>

* RDI reader, logging, duty cycle motion correction

* Delft3D z calculation (#190)

* updated variable names

* updated variable names

* updated variable names

* fixed a few docstring typos

* updated s1 to water level

* updated s1 to waterlevel

* updated s1 to waterlevel

* updated s1 to water level

* updated s1 to waterlever

* fixed typo depth to waterdepth

* added edges = nearest example

* added edges = nearest option in variable interpolate

* updated z to waterdepth

* added edges= nearest example

Co-authored-by: Browning <eabrow@sandia.gov>

* Directional NDBC  (#197)

* working on directional NDBC

* clean up functions. Write docstrings. Write assert statements. Write tests. Create Tutorial.

* docstring and asserts for plotting function

* add dolfyn, currenly will not run on the branch need jmcvey3 trdi_5beam

* found river bottom and removed data below

* Bug Fix: Averaging histogram bin and wave energy (#205)

* Fix averaging bug
* Add outline to bin counts text for better contrast
* Update plotting function and plot in example notebook

* Fix: update variable name to remove reference before assignment error (#208)

* update wave.contours.samples_contour to not get variable referenced before assignment error

Co-authored-by: Graham Penrose <graham@evergreeninnovations.co>

* HSDS (#211)

Adds hindcast tests back into the test suite. The NREL HSDS API issues were resolved by creating multiple calls to the API for direction wave spectrum requests. Additionally, an exponential back-off time was implemented to retry calls with an increased wait time between calls.

Co-authored-by: Adam Keester <72414466+akeeste@users.noreply.github.com>

* Provide function to convert from Te to Tp using ITTC approximation (#210)

* Provide function to convert from Te to Tp using ITTC approximation

* Apply suggestions from code review

Co-authored-by: Adam Keester <72414466+akeeste@users.noreply.github.com>

* Updates

* Force float32 datatype

* added downsampelind comparison and tried contourf

* D3D tanana data

* tanana transect 2

* tanana transect 3

* Docstring formatting

* Metocean module - WIND Toolkit (#187)

* initial script

* update wind_toolkit with 4 regions and 1-hr or 5-min data

* update parameters of wind_toolkit functions

* compare NDBC and WIND metocean data

* fix typo in wpto hindcast example

* finish metocean example and add results

* add wind_toolkit to wave/io/__init__.py

* update WIND Toolkit parameter list

* initial test structure for WIND toolkit

* finish metocean example

* add function to plot each region

* wind toolkit tests and test data

* add tests for misc wind_toolkit MHKiT functions and cases

* fix wind toolkit tests

* add elevation_to_string utility function

* misc cleanup

* clarify available parameters

* add users lat_lon to plot_region visualization

* update example with new functions

* add numpy dependency back in

* Ingnore the new hindcast folder

* Include only the new hindcast folder

* Move hindcast tests to hindcast folder

* Specify exclusion of hindcast from standard coverage

* update hindcast coverage

* remove unnecessary header

* move hindcast and wind_toolkit to wave/io/hindcast

* update .coveragerc files

* update paths for new wave.io.hindcast directory

Co-authored-by: ssolson <ssolson@sandia.gov>

* Change 'default' docstring default

* Remove old comments

* updated code to match Energies paper

* Review

* Boat transect image

* updated variable names

* Dolfyn updates (#212)

* RDI reader, logging, duty cycle motion correction

* Updates

* Force float32 datatype

* Docstring formatting

* Change 'default' docstring default

* Remove old comments

* updated variable names

* updated variable names added to discriptions

* Clean up and suggestions

* added to the examples

* TRTS study edits

* code and discription updates

* Edits and TODOs

* moved files, updated discriptions

* readding Delft3D_example notebook

* added USGS discharge

* updated doc strings

* example updates and move data files

* updated doc strings and Error equations

* updated doc strings

* pulled down development branch

* updated figure visibility

* updated figure at L2 equation

* restor old version

* updated L2 eqation and intro fig

* updated L2 eqation and intro fig

* updated L2 equation

* pulled in Develope branch

* updated figure formate

---------

Co-authored-by: ssolson <ssolson@sandia.gov>
Co-authored-by: ssolson <ssolson@users.noreply.github.com>
Co-authored-by: Carlos A. Michelén Ströfer <cmichel@sandia.gov>
Co-authored-by: rpauly18 <rpauly@nrel.gov>
Co-authored-by: hivanov-nrel <53838851+hivanov-nrel@users.noreply.github.com>
Co-authored-by: jmcvey3 <53623232+jmcvey3@users.noreply.github.com>
Co-authored-by: jmcvey3 <james13rmh@gmail.com>
Co-authored-by: jmcvey3 <jmcvey3@users.noreply.github.com>
Co-authored-by: rpauly18 <50752018+rpauly18@users.noreply.github.com>
Co-authored-by: Adam Keester <72414466+akeeste@users.noreply.github.com>
Co-authored-by: Browning <eabrow@sandia.gov>
Co-authored-by: Mark Bruggemann <mark@bruggemann.co.uk>
Co-authored-by: Graham Penrose <graham@evergreeninnovations.co>
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

Successfully merging this pull request may close these issues.

None yet

2 participants