Skip to content

Conversation

@ssolson
Copy link
Contributor

@ssolson ssolson commented Feb 1, 2023

This PR supersedes #166 by @ryancoe to incorporate his suggested changes:

Update the wave.io.hindcast.request_wpto_directional_spectrum function to:

  1. added gid to the metadata and added a description of gid to the docstring
  2. General linting

ssolson and others added 30 commits July 12, 2022 09:46
* Include last day of year (MHKiT-Software#160)

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

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

* Bug fix: remove timezone replace for astimezone

* add pytz to required packages

* Fix: Pandas latest (MHKiT-Software#159)

* Plot each col in DataFrame individually

* Remove numpy and pandas version requirements

* WDRT (MHKiT-Software#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 MHKiT-Software#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 <[email protected]>
Co-authored-by: ssolson <[email protected]>
Co-authored-by: rpauly18 <[email protected]>
Co-authored-by: hivanov-nrel <[email protected]>

* DOLfYN IO (MHKiT-Software#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 <[email protected]>
Co-authored-by: ssolson <[email protected]>
Co-authored-by: Michelen <[email protected]>
Co-authored-by: jmcvey3 <[email protected]>
Co-authored-by: rpauly18 <[email protected]>

* regenerate WDRT examples (MHKiT-Software#163)

* updating version number in package

* fixing dolfyn imports from pip

* updating version number for bug fix

* NDBC Metocean data (MHKiT-Software#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 <[email protected]>
Co-authored-by: rpauly18 <[email protected]>
Co-authored-by: hivanov-nrel <[email protected]>
Co-authored-by: jmcvey3 <[email protected]>
Co-authored-by: jmcvey3 <[email protected]>
Co-authored-by: jmcvey3 <[email protected]>
Co-authored-by: rpauly18 <[email protected]>
Co-authored-by: Adam Keester <[email protected]>
* 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
* 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 <[email protected]>
* 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 <[email protected]>
Co-authored-by: ssolson <[email protected]>
* Use conda TEST env on Py 3.7, 3.8, 3.9

* Use pip install with Py 3.8 and 3.9.
* 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
* 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
* 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 <[email protected]>
* 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 <[email protected]>
* working on directional NDBC

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

* docstring and asserts for plotting function
* Fix averaging bug
* Add outline to bin counts text for better contrast
* Update plotting function and plot in example notebook
…MHKiT-Software#208)

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

Co-authored-by: Graham Penrose <[email protected]>
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 <[email protected]>
…HKiT-Software#210)

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

* Apply suggestions from code review

Co-authored-by: Adam Keester <[email protected]>
* 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 <[email protected]>
* RDI reader, logging, duty cycle motion correction

* Updates

* Force float32 datatype

* Docstring formatting

* Change 'default' docstring default

* Remove old comments
@ssolson ssolson self-assigned this May 2, 2023
@ssolson
Copy link
Contributor Author

ssolson commented May 5, 2023

Address #146 by allowing custom hsds path.

@ssolson ssolson linked an issue May 8, 2023 that may be closed by this pull request
Copy link
Contributor

@akeeste akeeste left a comment

Choose a reason for hiding this comment

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

Thanks @ssolson! No major comments from me on top of my previous review. I have a couple minor documentation suggestions. I'll commit those en batch on GitHub and then merge this PR

assert isinstance(str_decode, bool), 'str_decode must be bool type'
assert isinstance(hsds, bool), 'hsds must be bool type'
assert isinstance(path, (str, type(None))), 'path must be a string'
assert is instance(as_xarray, bool), 'as_xarray must be bool type'
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Looks like an indention error is causing the tests to fail.

Copy link
Contributor

@akeeste akeeste May 9, 2023

Choose a reason for hiding this comment

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

@ssolson My bad, my GitHub suggestion wasn't robust. I fixed this and double checked the others. Should work now

@ssolson ssolson merged commit c2d2b0e into MHKiT-Software:develop May 10, 2023
@ssolson ssolson deleted the better_dir_spect_xarray branch May 11, 2023 16:02
@ssolson ssolson mentioned this pull request Aug 11, 2023
ssolson added a commit that referenced this pull request Aug 11, 2023
**MHKiT 0.7.0 Release Notes**

This release introduces exciting new features and improvements to the MHKiT package:

- **Mooring Module**: We are pleased to introduce the new mooring module. This addition primarily supports outputs from MoorDyn. Within this module, users can:
  - Import data
  - Calculate lay length
  - Visualize mooring line movements in 2D and 3D with graphical animations.
  
  Accompanying this module is an example notebook to guide users on its functionalities.

- **Dolfyn Module Revamp**: The Dolfyn module has been overhauled. Enhancements include:
  - Turbulence calculation capability
  - Performance measures for tidal power as outlined in IEC/TS 6200-200.

- **New Contributions**: A big shoutout to our community member, @mbruggs, for adding the ability to compute surface elevation using IFFT.

- **NDBC Buoy Metadata**: Users can now fetch NDBC buoy metadata directly through MHKiT.

- **Delft3D Module Update**: Stay up to date with support for the latest Delft3D NetCDF format.

**Additions**
- #235
- #232 
- #236 
- #250
- #239
- #248

**Bug Fixes**
- #226 
- #238

**Meta/Minor Changes**
- #220
- #243
- #225 
- #231
- #224

Thank you to all of the contributers who helpped with this release:
@mbruggs @Graham-EGI @castillocesar @jmcvey3 @hivanov-nrel  @browniea @cmichelenstrofer @akeeste  @maxwelllevin @rpauly18 @ssolson
@akeeste akeeste mentioned this pull request May 17, 2024
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Hindcast Module – Loading Data

7 participants