.. _release_notes: Release Notes ============= MHKiT-Python v0.7.0 ------------------- MHKiT-Python v0.7.0 adds the following modules and capabilities to MHKiT-Python: * 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. * Provide a function to convert from Te to Tp using ITTC approximation * General upkeep and compatibility maintenance * General Bug Fixes MHKiT-Python v0.6.0 ------------------- MHKiT-Python v0.6.0 adds the following modules and capabilities to MHKiT-Python: * Test Suite Restructure: improved the ability to run and edit tests by breaking them out from single files into folders containing tests for specific parts of each submodule * Added a metocean module which can pull data from the wind_toolkit with 4 regions and 1-hr or 5-min data * Two DOLfYN updates address bug fixes, clean up, and some feature expansion: - ADV skipped timesteps, max gap, and attributes - error in integral length scale calculation - error in despiking function - move Reynolds stress and cross-spectral density calculations to ADV folder - prevent inaccurate TKE calculation from ADCP velocity input * Delft3D z-calculation, timestep, and new example notebook comparing ADV, and D3D river transect data * WEC-Sim v5.0 support * Return period added for contours * Provide a function to convert from Te to Tp using ITTC approximation * General upkeep and compatibility maintenance * General Bug Fixes MHKiT-Python v0.5.0 & MHKiT-Matlab v0.4.0 ----------------------------------------- MHKiT-Python v0.5.0 adds the following modules and capabilities to MHKiT-Python: * Organization: grouped io specific functions in wave, tidal, and river into io folder * Updated Jonswap spectrum to match IEC guidance * `dolfyn `_ Added DOLfYN module to analyze and process ADV and ADCP data * `wave.contours `_ Incorporated the remaining WDRT functionality * `river.io.d3d `_ Added Delft3D case post-processing in the river/ tidal models * Fixed a bug in the wave elevation function * Include the last day in CDIP requests and file timezone issues with CDIP * Upgrades to processing numpy and pandas version to maintain compatability MHKiT-Matlab v0.4.0 adds the following modules and capabilities to MHKiT-MATLAB: * Updated Jonswap spectrum to match IEC guidance * `cdip `_ Module: functions for downloading and converting CDiP data into MHKIT formats. * `WPTO hindcast `_ Module: functions for downloading and converting WPTO Hindcast data into MHKIT formats * Fixed a bug in the wave elevation function MHKiT v0.4.0 ------------- MHKiT v0.4.0 adds the following modules and capabilities to MHKiT: * `wave.io.cdip `_ Module: functions for downloading and converting CDiP data into MHKIT formats (MHKiT-Python Only). * `wave.io.hindcast `_ Module: functions for downloading and converting WPTO Hindcast data into MHKIT formats (MHKiT-Python Only). * `wave.io.swan `_ Module: functions for importing and converting SWAN data into MHKIT formats. * `wave.resource `_ Module: Deep water approximations for wave resource characterization (MHKiT-Python Only). * `utils `_ Module: Vector averaging capabilities in statistics calculations. * `wave.performance `_ Module: Wave power performance workflow functions. MHKiT v0.3.1 ------------- * Ensures compatibility with dependency PECOS v0.1.9 MHKiT v0.3.0 ------------- MHKiT v0.3.0 adds the following modules to MHKiT: * `wave.io.ndbc `_ Module: functions for downloading and converting NDBC data into MHKIT formats. * `wave.io.wecsim `_ Module: functions for converting WEC-Sim data into MHKiT formats. * `river.performance `_ and `tidal.performance `_ Module: new functionality to assess device performance from blade/rotor type devices. * `Loads Module `_: new function for computing blade moments; new submodule structure `loads.general `_ and `loads.graphics `_. Refer to the following GitHub repositories to access the MHKiT v0.3.0 tagged release: MHKiT-Python v0.3.0 ^^^^^^^^^^^^^^^^^^^^^ * `MHKiT-Python v0.3.0 Release `_ * .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4063895.svg :target: https://doi.org/10.5281/zenodo.4063895 MHKiT-MATLAB v0.3.0 ^^^^^^^^^^^^^^^^^^^^^ * `MHKiT-MATLAB v0.3.0 Release `_ * .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4063920.svg :target: https://doi.org/10.5281/zenodo.4063920 MHKiT v0.2.0 ------------- MHKiT v0.2.0 adds the following modules to MHKiT: * :ref:`power`: Calculate quantities of interest for power production and power quality * :ref:`loads`: Calculate quantities of interest for mechanical loads assessments This release also includes minor updates to the wave module to improve the versatility of the module. Refer to the following GitHub repositories to access the MHKiT v0.2.0 tagged release: MHKiT-Python v0.2.0 ^^^^^^^^^^^^^^^^^^^^^ * `MHKiT-Python v0.2.0 Release `_ * .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3924684.svg :target: https://doi.org/10.5281/zenodo.3924684 MHKiT-MATLAB v0.2.0 ^^^^^^^^^^^^^^^^^^^^^ * `MHKiT-MATLAB v0.2.0 Release `_ * .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3928406.svg :target: https://doi.org/10.5281/zenodo.3928406 MHKiT v0.1.0 ------------- The first official release of MHKiT, developed in Python and MATLAB, includes the following modules: * :ref:`qc`: Perform quality control analysis * :ref:`wave`: Calculate quantities of interest for wave energy converters (WEC) * :ref:`river`: Calculate quantities of interest for river energy converters (REC) * :ref:`tidal`: Calculate quantities of interest for tidal energy converters (TEC) * :ref:`utils`: Includes helper functions The v0.1.0 release includes methods for resource assessment, device performance, graphics, io and quality control. Refer to the following GitHub repositories to access the MHKiT v0.1.0 tagged release: MHKiT-Python v0.1.0 ^^^^^^^^^^^^^^^^^^^^^ * `MHKiT-Python v0.1.0 Release `_ MHKiT-MATLAB v0.1.0 ^^^^^^^^^^^^^^^^^^^^^ * `MHKiT-MATLAB v0.1.0 Release `_ Future Releases ---------------- The next releases, planned in 2021, will include: * Additional QC functionality and data transformation functions * Additional power quality functions for flicker analysis * Data ingestion functions from instrumentation and public datasets * Mooring module