diff --git a/.github/workflows/run-tests-dev.yml b/.github/workflows/run-tests-dev.yml index 8a7cf29a60..3a77a7811e 100644 --- a/.github/workflows/run-tests-dev.yml +++ b/.github/workflows/run-tests-dev.yml @@ -18,7 +18,7 @@ jobs: strategy: fail-fast: false matrix: - release: [R2020b, R2023a] + release: [R2020b, R2021a, R2021b, R2022a, R2022b, R2023a] name: MATLAB ${{ matrix.release }} on Windows steps: - name: Check out repository @@ -51,8 +51,8 @@ jobs: strategy: fail-fast: false matrix: - release: [R2020b, latest] - name: MATLAB ${{ matrix.release }} on LINUX + release: [R2020b, R2021a, R2021b, R2022a, R2022b, R2023a, latest] + name: MATLAB ${{ matrix.release }} on Linux steps: - name: Check out repository uses: actions/checkout@v3 diff --git a/.github/workflows/run-tests-master.yml b/.github/workflows/run-tests-master.yml index e01b3a7dca..ca0094c589 100644 --- a/.github/workflows/run-tests-master.yml +++ b/.github/workflows/run-tests-master.yml @@ -2,6 +2,7 @@ name: Run MATLAB tests on master branch on: # Trigger the workflow on push or pull request, # but only for the master branch + workflow_dispatch: {} push: branches: - master @@ -12,29 +13,69 @@ concurrency: group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} cancel-in-progress: true jobs: - run_tests: + run_windows_tests: + runs-on: windows-latest + strategy: + fail-fast: false + matrix: + release: [R2020b, R2021a, R2021b, R2022a, R2022b, R2023a] + name: MATLAB ${{ matrix.release }} on Windows + steps: + - name: Check out repository + uses: actions/checkout@v3 + with: + lfs: true + - name: Check out LFS objects + run: git lfs checkout + - name: Install MATLAB + uses: matlab-actions/setup-matlab@v2-beta + with: + release: ${{ matrix.release }} + products: Simulink Simscape Simscape_Multibody + - name: Install WEC-Sim + uses: matlab-actions/run-command@v1 + with: + command: | + addpath(genpath('source')), + savepath pathdef.m; + - name: Run tests and generate artifacts + uses: matlab-actions/run-command@v1 + with: + command: | + set_param(0, 'ErrorIfLoadNewModel', 'off'), + results = wecSimTest, + assertSuccess(results); + startup-options: -noFigureWindows + run_linux_tests: runs-on: ubuntu-latest strategy: fail-fast: false matrix: - release: [R2020b, R2021a, R2021b, latest] - name: MATLAB ${{ matrix.release }} + release: [R2020b, R2021a, R2021b, R2022a, R2022b, R2023a, latest] + name: MATLAB ${{ matrix.release }} on Linux steps: - name: Check out repository - uses: actions/checkout@v2 + uses: actions/checkout@v3 with: lfs: true - name: Check out LFS objects run: git lfs checkout - name: Install MATLAB - uses: matlab-actions/setup-matlab@v1 + uses: matlab-actions/setup-matlab@v2-beta with: - release: ${{ matrix.release }} + release: ${{ matrix.release }} + products: Simulink Simscape Simscape_Multibody - name: Install WEC-Sim uses: matlab-actions/run-command@v1 with: - command: addpath(genpath('source'));, savepath pathdef.m; + command: | + addpath(genpath('source')), + savepath pathdef.m; - name: Run tests and generate artifacts uses: matlab-actions/run-command@v1 with: - command: results = wecSimTest, assertSuccess(results); + command: | + set_param(0, 'ErrorIfLoadNewModel', 'off'), + results = wecSimTest, + assertSuccess(results); + startup-options: -noFigureWindows \ No newline at end of file diff --git a/README.md b/README.md index 7e731e651e..a87e0197da 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,8 @@ # Refer to [WEC-Sim documentation](http://wec-sim.github.io/WEC-Sim) for more information. [![DOI](https://zenodo.org/badge/20451353.svg)](https://zenodo.org/badge/latestdoi/20451353) -[![Doc Build Status](https://github.com/WEC-Sim/WEC-Sim/actions/workflows/docs.yml/badge.svg)](https://github.com/WEC-Sim/WEC-Sim/actions/workflows/docs.yml) -[![MATLAB Build Status](https://github.com/WEC-Sim/WEC-Sim/actions/workflows/run-tests-master.yml/badge.svg)](https://github.com/WEC-Sim/WEC-Sim/actions/workflows/run-tests-master.yml) -[![MATLAB Build Status](https://github.com/WEC-Sim/WEC-Sim/actions/workflows/run-tests-dev.yml/badge.svg)](https://github.com/WEC-Sim/WEC-Sim/actions/workflows/run-tests-dev.yml) - +[![Documentation](https://github.com/WEC-Sim/WEC-Sim/actions/workflows/docs.yml/badge.svg)](https://github.com/WEC-Sim/WEC-Sim/actions/workflows/docs.yml) +[![Run MATLAB tests on master branch](https://github.com/WEC-Sim/WEC-Sim/actions/workflows/run-tests-master.yml/badge.svg?branch=master)](https://github.com/WEC-Sim/WEC-Sim/actions/workflows/run-tests-master.yml) +[![Run MATLAB tests on dev branch](https://github.com/WEC-Sim/WEC-Sim/actions/workflows/run-tests-dev.yml/badge.svg?branch=dev)](https://github.com/WEC-Sim/WEC-Sim/actions/workflows/run-tests-dev.yml) ## WEC-Sim Repository diff --git a/docs/conf.py b/docs/conf.py index 76fa7e302a..e97841d0bc 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -102,7 +102,7 @@ # built documents. # # The short X.Y version. -version = 'v5.0.1' +version = 'v6.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/introduction/release_notes.rst b/docs/introduction/release_notes.rst index 7c8d11825e..81878bbf13 100644 --- a/docs/introduction/release_notes.rst +++ b/docs/introduction/release_notes.rst @@ -3,53 +3,6 @@ Release Notes ============= -`WEC-Sim v5.0.1 `_ --------------------------------------------------------------------------------- - -**New Features** - -This is a bug fix release. New features since the previous release are not included. - -**Bug Fixes** - -* Fix saveViz by @jtgrasb in `#866 `_ - -* Fix typo in docs. by @mancellin in `#898 `_ - -* Update documentation tutorials to fix OSWEC inertia by @jtgrasb in `#894 `_ - -* CI: Split docs jobs | Add color to docs logs | Cancel runs on new push | Add 2021b to MATLAB versions by @H0R5E in `#862 `_ - -* Mac path fixes and make outputDir public by @ahmedmetin in `#874 `_ - -* wecSimPCT Fix (Master) by @yuyihsiang in `#870 `_ - -* Fix image bug in PTO-Sim in Library Browser by @jleonqu in `#896 `_ - -* update to v5.0 citation by @akeeste in `#911 `_ - -* fix non-linear hydro by @dforbush2 in `#910 `_ - -* Pull dev bugfixes into master by @akeeste @jtgrasb in `#950 `_ (includes `#929 `_ `#917 `_ `#884 `_ by @jtgrasb) - -**New Contributors** - -* @mancellin made their first contribution in `#898 `_ - -* @ahmedmetin made their first contribution in `#874 `_ - -**Issues and Pull Requests** - -* \>52 issues closed since v5.0 - -* \>23 PRs merged since v5.0 - -`**Full Changelog** `_ - -.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.7121186.svg - :target: https://doi.org/10.5281/zenodo.7121186 - - .. _intro-citation: Citing WEC-Sim @@ -58,7 +11,7 @@ Citing WEC-Sim To cite WEC-Sim, please use the citation for WEC-Sim software release and/or cite the following WEC-Sim publication. -`WEC-Sim v5.0.1 `_ +`WEC-Sim v6.0 `_ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. NOTE: this citation needs to be revised for each release @@ -69,20 +22,19 @@ To cite WEC-Sim, please use the citation for WEC-Sim software release and/or cit .. code-block:: none @software{wecsim, - author = {Kelley Ruehl, - David Ogden, - Yi-Hsiang Yu, + author = {Kelley Ruehl, + Nathan Tom, Adam Keester, - Nathan Tom, Dominic Forbush, Jorge Leon, + David Ogden, Jeff Grasberger, Salman Husain}, - title = {WEC-Sim v5.0.1}, + title = {WEC-Sim v6.0}, month = September, year = 2022, publisher = {Zenodo}, - version = {v5.0.1}, + version = {v6.0}, doi = {10.5281/zenodo.7121186}, url = {https://zenodo.org/badge/latestdoi/20451353} } @@ -99,79 +51,165 @@ Publication [1] D. Ogden, K. Ruehl, Y.H. Yu, A. Keester, D. Forbush, J. Leon, N. Tom, "Review of WEC-Sim Development and Applications" in Proceedings of the 14th European Wave and Tidal Energy Conference, EWTEC 2021, Plymouth, UK, 2021. +`WEC-Sim v6.0 `_ +-------------------------------------------------------------------------------- + +**New Features** +* initial commit largeXYDispOption by @dforbush2 in https://github.com/WEC-Sim/WEC-Sim/pull/877 +* Update coordinate system figure by @JiaMiGit in https://github.com/WEC-Sim/WEC-Sim/pull/931 +* Property validation for WEC-Sim objects by @jtgrasb in https://github.com/WEC-Sim/WEC-Sim/pull/904 +* Dev: adding ampSpectraForWS function by @dforbush2 in https://github.com/WEC-Sim/WEC-Sim/pull/907 +* Customizable DOFs for plotBEMIO by @akeeste in https://github.com/WEC-Sim/WEC-Sim/pull/944 +* Calculation_of_Ainf_using_radiationIRF.m by @salhus in https://github.com/WEC-Sim/WEC-Sim/pull/946 +* Update citation names by @akeeste in https://github.com/WEC-Sim/WEC-Sim/pull/954 +* Update getDofNames() by @akeeste in https://github.com/WEC-Sim/WEC-Sim/pull/957 +* included readCAPYTAINE() argument to explicitly define KH.dat & Hydro… by @dav-og in https://github.com/WEC-Sim/WEC-Sim/pull/962 +* Extract mask variable by @salhus in https://github.com/WEC-Sim/WEC-Sim/pull/958 +* Add tests to check that SLX file versions do not exceed R2020b by @H0R5E in https://github.com/WEC-Sim/WEC-Sim/pull/919 +* Products of Inertia in WEC-Sim by @akeeste in https://github.com/WEC-Sim/WEC-Sim/pull/981 +* Pull bug fixes #954, #999, #1002 from master into dev by @akeeste in https://github.com/WEC-Sim/WEC-Sim/pull/1011 +* updating readNEMOH based on #983 by @kmruehl in https://github.com/WEC-Sim/WEC-Sim/pull/990 +* Remove 'fixed' mass option from OSWEC input file by @jtgrasb in https://github.com/WEC-Sim/WEC-Sim/pull/1022 and https://github.com/WEC-Sim/WEC-Sim/pull/1024 +* Save the applied added mass time series by @akeeste in https://github.com/WEC-Sim/WEC-Sim/pull/1023 +* Update tutorials by @kmruehl in https://github.com/WEC-Sim/WEC-Sim/pull/1030 +* Control applications docs by @jtgrasb in https://github.com/WEC-Sim/WEC-Sim/pull/1018 +* Update read- and writeBEMIOH5 to allow for pressure integration for mean drift by @nathanmtom in https://github.com/WEC-Sim/WEC-Sim/pull/1046 +* Add function to read h5 file to hydro data structure by @jtgrasb in https://github.com/WEC-Sim/WEC-Sim/pull/1048 +* Update radiationIRF.m by @nathanmtom in https://github.com/WEC-Sim/WEC-Sim/pull/1045 +* Normalize quaternion to increase simulation robustness by @akeeste in https://github.com/WEC-Sim/WEC-Sim/pull/1049 +* Plot bemio features by @jtgrasb in https://github.com/WEC-Sim/WEC-Sim/pull/1034 +* Updates to Morison Element Implementation by @nathanmtom in https://github.com/WEC-Sim/WEC-Sim/pull/1052 +* Moving PTO-Sim to main WEC-Sim library by @jleonqu in https://github.com/WEC-Sim/WEC-Sim/pull/1057 +* Add windows runner to dev branch unit test workflow by @H0R5E in https://github.com/WEC-Sim/WEC-Sim/pull/1061 +* Update docs dependencies by @H0R5E in https://github.com/WEC-Sim/WEC-Sim/pull/1080 +* Type property pto sim by @jleonqu in https://github.com/WEC-Sim/WEC-Sim/pull/1064 +* Added mass updates by @akeeste in https://github.com/WEC-Sim/WEC-Sim/pull/1058 +* Feature paraview by @agmoore4 in https://github.com/WEC-Sim/WEC-Sim/pull/1081 +* Paraview documentation hyperlink fix by @agmoore4 in https://github.com/WEC-Sim/WEC-Sim/pull/1093 +* use capytaine v2 to compute hydrostatics by @dav-og in https://github.com/WEC-Sim/WEC-Sim/pull/1092 +* Update paraview doc images by @jtgrasb in https://github.com/WEC-Sim/WEC-Sim/pull/1098 +* readNEMOH update to be compatible with v3.0.0 release (but not QTF) by @nathanmtom in https://github.com/WEC-Sim/WEC-Sim/pull/1087 +* Add simple direct drive PTO model by @jtgrasb in https://github.com/WEC-Sim/WEC-Sim/pull/1106 +* Control+pto docs by @jtgrasb in https://github.com/WEC-Sim/WEC-Sim/pull/1108 +* MOST Capabilities - Continuation by @jtgrasb in https://github.com/WEC-Sim/WEC-Sim/pull/1127 +* Implement an FIR filter to calculate radiation forces by @salhus in https://github.com/WEC-Sim/WEC-Sim/pull/1071 +* Updating documentation to include links for the Advanced Features Web… by @jleonqu in https://github.com/WEC-Sim/WEC-Sim/pull/1126 +* Multiple Wave Spectra by @salhus in https://github.com/WEC-Sim/WEC-Sim/pull/1130 +* Update WECSim_Lib_Body_Elements.slx for N Waves Applications by @salhus in https://github.com/WEC-Sim/WEC-Sim/pull/1133 +* Update to MoorDyn v2 by @RyanDavies19 in https://github.com/WEC-Sim/WEC-Sim/pull/1134 +* Updating WEC-Sim tests for dev branch by @kmruehl in https://github.com/WEC-Sim/WEC-Sim/pull/1142 + +**Bug Fixes** +* Remove fixed mass option by @akeeste in https://github.com/WEC-Sim/WEC-Sim/pull/856 +* Move run('stopWecSim') to wecSim.m by @jtgrasb in https://github.com/WEC-Sim/WEC-Sim/pull/885 +* Pull bug fixes into dev by @akeeste in https://github.com/WEC-Sim/WEC-Sim/pull/900 +* Save slx files in 2020b fixes #920 by @jtgrasb in https://github.com/WEC-Sim/WEC-Sim/pull/923 +* Fix readCAPYTAINE by @jtgrasb in https://github.com/WEC-Sim/WEC-Sim/pull/884 +* Fixes saveViz feature for elevation import by @jtgrasb in https://github.com/WEC-Sim/WEC-Sim/pull/929 +* Fix wave elevation import with rampTime = 0 by @jtgrasb in https://github.com/WEC-Sim/WEC-Sim/pull/917 +* readCapytaine_fixes_for_reading_dataformats_correctly by @salhus in https://github.com/WEC-Sim/WEC-Sim/pull/947 +* Pull #954 into dev by @akeeste in https://github.com/WEC-Sim/WEC-Sim/pull/955 +* Bug fix for direction in readCapytaine by @akeeste in https://github.com/WEC-Sim/WEC-Sim/pull/999 +* Fix sign bug reported on issue #993 by @jleonqu in https://github.com/WEC-Sim/WEC-Sim/pull/1002 +* Dev: reverts PR 910, fixing error in nonLinearBuoyancy by @dforbush2 in https://github.com/WEC-Sim/WEC-Sim/pull/1017 +* Fix the transpose of linear restoring matrix to make roll mode rows to be 0 by @salhus in https://github.com/WEC-Sim/WEC-Sim/pull/1032 +* Bugfix resolving documentation build error by @kmruehl in https://github.com/WEC-Sim/WEC-Sim/pull/1059 +* fix_readWAMIT_and_writeBEMIOh5 by @salhus in https://github.com/WEC-Sim/WEC-Sim/pull/1065 +* Pulling master bugfixes into dev by @kmruehl in https://github.com/WEC-Sim/WEC-Sim/pull/1101 +* Bug fixes for v6.0 by @akeeste in https://github.com/WEC-Sim/WEC-Sim/pull/1136 +* Path fix for BEMIO example by @akeeste in https://github.com/WEC-Sim/WEC-Sim/pull/1144 + +**New Contributors** +* @JiaMiGit made their first contribution in https://github.com/WEC-Sim/WEC-Sim/pull/931 +* @agmoore4 made their first contribution in https://github.com/WEC-Sim/WEC-Sim/pull/1081 +* @RyanDavies19 made their first contribution in https://github.com/WEC-Sim/WEC-Sim/pull/1134 + + +**Issues and Pull Requests** +* \>130 issues closed since v5.0.1 +* \>74 PRs merged since v5.0.1 + +`**v6.0 Changelog** `_ + +.. image:: https://zenodo.org/badge/20451353.svg + :target: https://zenodo.org/badge/latestdoi/20451353 + +.. NOTE: this doi badge is always for the lastest release, it needs to be updated + + +`WEC-Sim v5.0.1 `_ +-------------------------------------------------------------------------------- + +**New Features** + +This is a bug fix release. New features since the previous release are not included. + +**Bug Fixes** +* Fix saveViz by @jtgrasb in `#866 `_ +* Fix typo in docs. by @mancellin in `#898 `_ +* Update documentation tutorials to fix OSWEC inertia by @jtgrasb in `#894 `_ +* CI: Split docs jobs | Add color to docs logs | Cancel runs on new push | Add 2021b to MATLAB versions by @H0R5E in `#862 `_ +* Mac path fixes and make outputDir public by @ahmedmetin in `#874 `_ +* wecSimPCT Fix (Master) by @yuyihsiang in `#870 `_ +* Fix image bug in PTO-Sim in Library Browser by @jleonqu in `#896 `_ +* update to v5.0 citation by @akeeste in `#911 `_ +* fix non-linear hydro by @dforbush2 in `#910 `_ +* Pull dev bugfixes into master by @akeeste @jtgrasb in `#950 `_ (includes `#929 `_ `#917 `_ `#884 `_ by @jtgrasb) + +**New Contributors** +* @mancellin made their first contribution in `#898 `_ +* @ahmedmetin made their first contribution in `#874 `_ + +**Issues and Pull Requests** +* \>52 issues closed since v5.0 +* \>23 PRs merged since v5.0 + +`**v5.0.1 Changelog** `_ + +.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.7121186.svg + :target: https://doi.org/10.5281/zenodo.7121186 -Previous Releases ------------------- `WEC-Sim v5.0 `_ -------------------------------------------------------------------------------- **New Features** - * Refactoring classes and properties @kmruehl in `#803 `_, `#822 `_, `#828 `_, `#832 `_, @akeeste in `#838 `_ - * Refactoring docs by @kmruehl in `#840 `_ - * Refactor BEMIO functions, tests, and documentation @akeeste in `#790 `_, `#812 `_, @H0R5E in `#839 `_, @dav-og in `#806 `_ - * Run from sim updates by @akeeste in `#737 `_ - * Allow binary STL files by @akeeste in `#760 `_ - * Update Read_AQWA and AQWA examples by @jtgrasb in `#761 `_, `#779 `_, `#797 `_, `#831 `_ - * Rename plotWaves by @jtgrasb in `#765 `_ - * Update to normalize to handle sorting mean drift forces by @nathanmtom in #808 #809 - * Remove passiveYawTest.m by @jtgrasb in `#807 `_ - * Wave class wave gauge update by @nathanmtom in `#801 `_ - * New pto sim lib by @jleonqu in `#821 `_ - * Warning/Error flags by @jtgrasb in `#826 `_ - * Add Google Analytics 4 by @akeeste in `#864 `_ **Documentation** - * Update WEC-Sim's Developer Documentation for the Morison Element Implementation by @nathanmtom in `#796 `_ - * Update response class API by @akeeste in `#802 `_ - * Doc_auto_gen_masks by @salhus in `#842 `_ - * Move documentation compilation to GitHub Actions by @H0R5E in `#817 `_ - * Add branch build in docs workflow for testing PRs by @H0R5E in `#834 `_ - * Update the WEC-Sim Theory Documentation to Clarify Wave Power Calculation by @nathanmtom in `#847 `_ - * Update documentation on mean drift and current by @akeeste in `#800 `_ **Bug Fixes** - * Fix cable library links. Resolves #770 by @akeeste in #774 #775 - * Fix rate transition error by @akeeste in `#799 `_ - * Fix cable implementation by @dforbush2 in `#827 `_ - * PTO-Sim bug fix by @jleonqu in `#833 `_ - * Bug fix for the regular wave power full expression by @nathanmtom in `#841 `_ - * Fix documentation on dev branch by @H0R5E in `#816 `_ - * Bug fix: responseClass reading the MoorDyn Lines.out file too early, resolves `#811 `_ by @akeeste in `#814 `_ **Issues and Pull Requests** - -* \>52 issues closed since v4.4 - -* \>44 PRs merged since v4.4 + * \>52 issues closed since v4.4 + * \>44 PRs merged since v4.4 .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.6555137.svg @@ -180,47 +218,31 @@ Previous Releases `WEC-Sim v4.4 `_ -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +-------------------------------------------------------------------------------- * New Features - - * Added WEC-Sim Library blocks for cable, spherical constraint, and spherical pto `#712 `_ `#675 `_ - - * Added feature to add/remove WEC-Sim path and create temp directory for each run `#685 `_ `#686 `_ - - * Updated WEC-Sim Library to 2020b and saved Simulink Library Functions to (`*.m`) files `#686 `_ `#654 `_ - - * Split WEC-Sim Library into sublibraries for each class `#720 `_ - + * Added WEC-Sim Library blocks for cable, spherical constraint, and spherical pto `#712 `_ `#675 `_ + * Added feature to add/remove WEC-Sim path and create temp directory for each run `#685 `_ `#686 `_ + * Updated WEC-Sim Library to 2020b and saved Simulink Library Functions to (`*.m`) files `#686 `_ `#654 `_ + * Split WEC-Sim Library into sublibraries for each class `#720 `_ * Restructured WEC-Sim Continuous Integration tests into class-based tests `#620 `_ - - * Added wave visualization with wave markers and post-processing `#736 `_ `#678 `_ - + * Added wave visualization with wave markers and post-processing `#736 `_ `#678 `_ * Moved nonlinear hydrodynamics and morison elements to properties of the Body Class `#692 `_ * Documentation - - * Added developer manual content for WEC-Sim Library, Run from Simulink, Simulink Functions, Added Mass, Software Tests `#728 `_ - + * Added developer manual content for WEC-Sim Library, Run from Simulink, Simulink Functions, Added Mass, Software Tests `#728 `_ * Added user manual content for troubleshooting WEC-Sim `#641 `_ - - * Updated content for PTO-Sim, ParaView, WEC-Sim Applications and Tutorials `#668 `_ `#642 `_ `#649 `_ `#643 `_ - + * Updated content for PTO-Sim, ParaView, WEC-Sim Applications and Tutorials `#668 `_ `#642 `_ `#649 `_ `#643 `_ * Added multi-version documentation for ``master`` and ``dev`` branches `#630 `_ * Bug Fixes - - * Resolved bug with macro for ParaView 5.9 `#459 `_ - - * Resolved bugs in BEMIO with Read_Capytaine, READ_AQWA, and Write_H5 functions `#727 `_ `#694 `_ `#636 `_ - + * Resolved bug with macro for ParaView 5.9 `#459 `_ + * Resolved bugs in BEMIO with Read_Capytaine, READ_AQWA, and Write_H5 functions `#727 `_ `#694 `_ `#636 `_ * Resolved bug with variable time-step solver `#656 `_ -* Issues and Pull Requests - +* Issues and Pull Requests * \> 57 issues closed since v4.3 - * \> 54 PRs merged since v4.3 .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.5608563.svg @@ -229,56 +251,37 @@ Previous Releases `WEC-Sim v4.3 `_ -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +-------------------------------------------------------------------------------- * New Features - - * Added the ability for WEC-Sim to be run directly from Simulink `#503 `_ `#512 `_ `#548 `_ - - * Added capability to read Capytaine (.nc) output. Includes examples of running Capytaine with hydrostatics `#464 `_ - - * Created a more accurate infinite frequency added mass calculation `#517 `_ - + * Added the ability for WEC-Sim to be run directly from Simulink `#503 `_ `#512 `_ `#548 `_ + * Added capability to read Capytaine (.nc) output. Includes examples of running Capytaine with hydrostatics `#464 `_ + * Created a more accurate infinite frequency added mass calculation `#517 `_ * Added ability for setInitDisp to intake multiple initial rotations `#516 `_ `#586 `_ * Documentation - - * Restructured into four manuals: introduction, theory, user and development `#455 `_ `#557 `_ - - * Update of code structure section `#455 `_, links `#649 `_ , diagrams `#643 `_, paraview `#642 `_, - + * Restructured into four manuals: introduction, theory, user and development `#455 `_ `#557 `_ + * Update of code structure section `#455 `_, links `#649 `_ , diagrams `#643 `_, paraview `#642 `_, * Added section on suggested troubleshooting `#641 `_ * Continuous integration tests - - * Overhaul and speed up of tests `#508 `_ `#620 `_ - + * Overhaul and speed up of tests `#508 `_ `#620 `_ * Extension of tests to the applications cases `#7 `_ * Clean up - - * Created issue templates on GitHub `#575 `_ `#634 `_ - - * Updated Morison Element warning flags `#408 `_ - - * Clean up response class methods `#491 `_ `#514 `_ - + * Created issue templates on GitHub `#575 `_ `#634 `_ + * Updated Morison Element warning flags `#408 `_ + * Clean up response class methods `#491 `_ `#514 `_ * Clean up paraview output functions `#490 `_ * Bug Fixes - - * Paraview macros and .pvsm files `#459 `_ - - * BEMIO read mean drift force in R2021a `#636 `_ - - * PTO-Sim calling workspace `#632 `_ - + * Paraview macros and .pvsm files `#459 `_ + * BEMIO read mean drift force in R2021a `#636 `_ + * PTO-Sim calling workspace `#632 `_ * Combine_BEM Ainf initialization `#611 `_ -* Issues and Pull Requests - +* Issues and Pull Requests * \> 100 issues closed since v4.2 - * \> 45 PRs merged since v4.2 .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.5122959.svg @@ -287,32 +290,22 @@ Previous Releases `WEC-Sim v4.2 `_ -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +-------------------------------------------------------------------------------- * New Features - * Added normal/tangential option for Morison Force (``simu.morisonElement = 2``) `#408 `_ - * Added Drag Body (``body(i).nhBody=2``) `#423 `_ `#384 `_ - * WEC-Sim output saved to structure `#426 `_ - * Added WEC-Sim parallel execution for batch runs (``wecSimPCT``) using MATLAB parallel computing toolbox `#438 `_ - * Added end stops to PTOs `#445 `_ * Documentation - * Automatically compile docs with TravisCI `#439 `_ - * Generate docs for master and dev branches of WEC-Sim * Bug Fixes - * Resolved convolution integral bug for body-to-body interactions `#444 `_ - * Resolved PTO-Sim bug for linear to rotary conversion blocks `#247 `_ `#485 `_ - * Resolved variant subsystem labeling bug `#486 `_ `#479 `_ .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4391330.svg @@ -321,22 +314,16 @@ Previous Releases `WEC-Sim v4.1 `_ -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +-------------------------------------------------------------------------------- * Added passive yaw - * Revised spectral formulations per IEC TC114 TS 62600-2 Annex C - * Updated examples on the `WEC-Sim_Applications `_ repository - * Added unit tests with Jenkins - * Added API documentation for WEC-Sim classes * Merged Pull Requests - - * Updated BEMIO for AQWA version comparability `#373 `_ - + * Updated BEMIO for AQWA version comparability `#373 `_ * Extended capabilities for ParaView visualization `#355 `_ .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3924765.svg @@ -344,12 +331,10 @@ Previous Releases `WEC-Sim v4.0 `_ -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +-------------------------------------------------------------------------------- * Added mean drift force calculation - * Added generalized body modes for simulating flexible WEC devices and for structure loading analysis - * Updated BEMIO for mean drift force and generalized body modes .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3827897.svg @@ -358,100 +343,71 @@ Previous Releases `WEC-Sim v3.1 `_ -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +-------------------------------------------------------------------------------- * Added wave gauges for three locations - * Added command line documentation for objects - * Added error and warning flags - * Converted Morison Elements to script instead of block - * Converted WEC-Sim and PTO-Sim library files back to slx format - * Fixed plot error in MATLAB 2018b `WEC-Sim v3.0 `_ -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +-------------------------------------------------------------------------------- * Added option of :ref:`equal energy spacing ` for irregular waves (default) - * Added option to calculate the wave elevation at a location different from the origin - * Added option to define :ref:`gamma for JONSWAP spectrum ` - * Improved the WEC-Sim simulation speed when using rapid-acceleration mode - * Fixed path bug in BEMIO for LINUX/OSX users * Changed/Added following WEC-Sim parameters - - * waves.randPreDefined -> :ref:`waves.phaseSeed ` - - * waves.phaseRand -> waves.phase - - * simu.dtFeNonlin -> :ref:`simu.dtNL ` - - * simu.rampT -> :ref:`simu.rampTime ` - + * waves.randPreDefined -> :ref:`waves.phaseSeed ` + * waves.phaseRand -> waves.phase + * simu.dtFeNonlin -> :ref:`simu.dtNL ` + * simu.rampT -> :ref:`simu.rampTime ` * Added simu.dtME to allow specification of :ref:`Morison force time-step ` `WEC-Sim v2.2 `_ -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +-------------------------------------------------------------------------------- * Added option to save pressure data for nonlinear hydro (`simu.pressureDis`) - * Update to moorDyn parser (doesn't require line#.out) * Repository cleanup - - * Implemented `Git LFS `_ for tracking ``*.h5`` files - - * Added `WEC-Sim Application repository `_ as a `submodule `_ - - * Moved `moorDyn `_ to its own repository - + * Implemented `Git LFS `_ for tracking ``*.h5`` files + * Added `WEC-Sim Application repository `_ as a `submodule `_ + * Moved `moorDyn `_ to its own repository * Removed publications from repository, :ref:`available on website ` `WEC-Sim v2.1 `_ -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +-------------------------------------------------------------------------------- * Added MATLAB version of BEMIO (to replace python version) - * Added variable time-step option with 'ode45' by @ratanakso - * Update to MCR, option to not re-load ``*.h5`` file by @bradling - * Update to waveClass to allow for definition of min/max wave frequency by @bradling `WEC-Sim v2.0 `_ -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +-------------------------------------------------------------------------------- * Updated WEC-Sim Library (generalized joints/constraints/PTOs) - * Body-to-body interactions for radiation forces - * Morison forces - * Batch run mode (MCR) - * Mooring sub-library implemented in mooringClass (no longer in body or joint) - * More realistic PTO and mooring modeling through PTO-Sim and integration with MoorDyn - * Non-hydrodynamic body option - * Visualization using ParaView `WEC-Sim v1.3 `_ -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +-------------------------------------------------------------------------------- * Added Morison Elements * Body2Body Interactions * Multiple Case Runs (wecSimMCR) @@ -462,7 +418,7 @@ Previous Releases * Visualization with Paraview `WEC-Sim v1.2 `_ -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +-------------------------------------------------------------------------------- * Nonlinear Froude-Krylov hydrodynamics and hydrostatics * State space radiation * Wave directionality @@ -473,7 +429,7 @@ Previous Releases `WEC-Sim v1.1 `_ -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +-------------------------------------------------------------------------------- * WEC-Sim v1.1, `available on GitHub `_ * Improvements in code stability through modifications to the added mass, radiation damping calculations, and impulse response function calculations * Implementation of state space representation of radiation damping convolution integral calculation @@ -481,7 +437,7 @@ Previous Releases * Documentation available on WEC-Sim Website `WEC-Sim v1.0 `_ -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +-------------------------------------------------------------------------------- * Initial release of WEC-Sim (originally on OpenEI, now on GitHub) * Available as a static download * Documentation available in PDF diff --git a/docs/user/webinars.rst b/docs/user/webinars.rst index 00e815a7d7..24a48c1f7b 100644 --- a/docs/user/webinars.rst +++ b/docs/user/webinars.rst @@ -117,15 +117,15 @@ is available below. -Advanced Features Webinars +Advanced Features Series -------------------------- -The WEC-Sim team hosted a series of Advanced Features Webinars. The +The WEC-Sim team hosted a series of Advanced Features Series. The topics are listed below. Recordings of each are available below, along with the presentations. =========== ==================================== - **Webinar** **Topic** + **Series** **Topic** 1 Multiple Condition Runs (MCR) 2 Nonlinear Hydrodynamics 3 Non-hydrodynamic Bodies @@ -141,15 +141,15 @@ presentations. .. _webinar1: -Webinar 1 - Multiple Condition Runs (MCR) +Series 1 - Multiple Condition Runs (MCR) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The webinar presents an overview of how to run multiple cases in WEC-Sim. The -presentation is available for download here ( `Webinar 1 Slides +The series presents an overview of how to run multiple cases in WEC-Sim. The +presentation is available for download here ( `Series 1 Slides <../_static/downloads/advancedFeaturesWebinars/1_WEC-Sim_AdvFeatures_MCR_Batch_Runs.pdf>`__ ), and the recording is available below. -**Webinar 1 - Multiple Condition Runs (MCR)** +**Series 1 - Multiple Condition Runs (MCR)** .. raw:: html @@ -158,15 +158,15 @@ available below. .. _webinar2: -Webinar 2 - Nonlinear Buoyancy and Froude-Krylov Wave Excitation +Series 2 - Nonlinear Buoyancy and Froude-Krylov Wave Excitation ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ This section is focused on how to implement Nonlinear Buoyancy and Froude-Krylov Wave Excitation forces in WEC-Sim. The presentation is available -for download here ( `Webinar 2 Slides <../_static/downloads/advancedFeaturesWebinars/2_WEC-Sim_AdvFeatures_Nonlinear_hydro.pdf>`__ ), +for download here ( `Series 2 Slides <../_static/downloads/advancedFeaturesWebinars/2_WEC-Sim_AdvFeatures_Nonlinear_hydro.pdf>`__ ), and the recordings are available below. -**Webinar 2 - Nonlinear Buoyancy and Froude-Krylov Wave Excitation** +**Series 2 - Nonlinear Buoyancy and Froude-Krylov Wave Excitation** .. raw:: html @@ -175,15 +175,15 @@ and the recordings are available below. .. _webinar3: -Webinar 3 - Non-hydrodynamic Bodies +Series 3 - Non-hydrodynamic Bodies ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ This webinar presents an overview of the non-hydrodynamic body implementation in WEC-Sim. The -presentation is available for download here ( `Webinar 3 Slides +presentation is available for download here ( `Series 3 Slides <../_static/downloads/advancedFeaturesWebinars/3_WEC-Sim_AdvFeatures_Non_hydro.pdf>`__ ), and the recordings are available below. -**Webinar 3 - Non-hydrodynamic Bodies** +**Series 3 - Non-hydrodynamic Bodies** .. raw:: html @@ -191,15 +191,15 @@ available below. .. _webinar4: -Webinar 4 - Body-to-Body Interactions +Series 4 - Body-to-Body Interactions ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -This is section of the Advanced Features Webinar presents some examples of how body-to-body interactions are modeled in WEC-Sim. -The presentation is available for download here ( `Webinar 4 Slides +This is section of the Advanced Features Series presents some examples of how body-to-body interactions are modeled in WEC-Sim. +The presentation is available for download here ( `Series 4 Slides <../_static/downloads/advancedFeaturesWebinars/4_WEC-Sim_AdvFeatures_B2B.pdf>`__ ), and the recordings are available below. -**Webinar 4 - Body-to-Body Interactions** +**Series 4 - Body-to-Body Interactions** .. raw:: html @@ -207,15 +207,15 @@ available below. .. _webinar5: -Webinar 5 - PTO-Sim +Series 5 - PTO-Sim ^^^^^^^^^^^^^^^^^^^ This section is focused on PTO-Sim. -The presentation is available for download here ( `Webinar 5 Slides +The presentation is available for download here ( `Series 5 Slides <../_static/downloads/advancedFeaturesWebinars/5_WEC-Sim_AdvFeatures_PTOSim.pdf>`__ ), and the recordings are available below. -**Webinar 5 - PTO-Sim** +**Series 5 - PTO-Sim** .. raw:: html @@ -223,15 +223,15 @@ available below. .. _webinar6: -Webinar 6 - WEC-Sim Controls +Series 6 - WEC-Sim Controls ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ This section presents some examples of how to implement control algorithms for WECs using WEC-Sim. -The presentation is available for download here ( `Webinar 6 Slides +The presentation is available for download here ( `Series 6 Slides <../_static/downloads/advancedFeaturesWebinars/6_WEC-Sim_AdvFeatures_Controls.pdf>`__ ), and the recordings are available below. -**Webinar 6 - WEC-Sim Controls** +**Series 6 - WEC-Sim Controls** .. raw:: html @@ -239,15 +239,15 @@ available below. .. _webinar7: -Webinar 7 - Modeling Cables +Series 7 - Modeling Cables ^^^^^^^^^^^^^^^^^^^^^^^^^^^ This section is focused on the Cable Block from WEC-Sim. -The presentation is available for download here ( `Webinar 7 Slides +The presentation is available for download here ( `Series 7 Slides <../_static/downloads/advancedFeaturesWebinars/7_WEC-Sim_AdvFeatures_Cable.pdf>`__ ), and the recordings are available below. -**Webinar 7 - Modeling Cables** +**Series 7 - Modeling Cables** .. raw:: html @@ -256,15 +256,15 @@ available below. .. _webinar8: -Webinar 8 - Using MoorDyn with WEC-Sim +Series 8 - Using MoorDyn with WEC-Sim ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ This section presents an overview of how to use MoorDyn with WEC-Sim. -The presentation is available for download here ( `Webinar 8 Slides +The presentation is available for download here ( `Series 8 Slides <../_static/downloads/advancedFeaturesWebinars/8_WEC-Sim_AdvFeatures_MoorDyn.pdf>`__ ), and the recordings are available below. -**Webinar 8 - Using MoorDyn with WEC-Sim** +**Series 8 - Using MoorDyn with WEC-Sim** .. raw:: html @@ -273,15 +273,15 @@ available below. .. _webinar9: -Webinar 9 - Modeling OWC Devices +Series 9 - Modeling OWC Devices ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ This section presents an overview of how to use model OWC devices using WEC-Sim. -The presentation is available for download here ( `Webinar 9 Slides +The presentation is available for download here ( `Series 9 Slides <../_static/downloads/advancedFeaturesWebinars/9_WEC-Sim_AdvFeatures_OWC_Modeling.pdf>`__ ), and the recordings are available below. -**Webinar 9 - Modeling OWC Devices** +**Series 9 - Modeling OWC Devices** .. raw:: html @@ -290,15 +290,15 @@ available below. .. _webinar10: -Webinar 10 - Desalination +Series 10 - Desalination ^^^^^^^^^^^^^^^^^^^^^^^^^ This section presents an overview of how to use WEC-Sim to model a desalination application. -The presentation is available for download here ( `Webinar 10 Slides +The presentation is available for download here ( `Series 10 Slides <../_static/downloads/advancedFeaturesWebinars/10_WEC-Sim_AdvFeatures_Desal.pdf>`__ ), and the recordings are available below. -**Webinar 10 - Desalination** +**Series 10 - Desalination** .. raw:: html @@ -307,15 +307,15 @@ available below. .. _webinar11: -Webinar 11 - WEC-Sim Visualization +Series 11 - WEC-Sim Visualization ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ This section presents an overview of how to post-process results in WEC-Sim. -The presentation is available for download here ( `Webinar 11 Slides +The presentation is available for download here ( `Series 11 Slides <../_static/downloads/advancedFeaturesWebinars/11_WEC-Sim_AdvFeatures_Visualization.pdf>`__ ), and the recordings are available below. -**Webinar 11 - WEC-Sim Visualization** +**Series 11 - WEC-Sim Visualization** .. raw:: html diff --git a/source/objects/simulationClass.m b/source/objects/simulationClass.m index 4f40e4afaa..9d17e92488 100755 --- a/source/objects/simulationClass.m +++ b/source/objects/simulationClass.m @@ -84,7 +84,7 @@ date = datetime % (`string`) Simulation date and time gitCommit = [] % (`string`) GitHub commit maxIt = [] % (`integer`) Total number of simulation time steps. Approximate for variable step solvers. Default = dependent - wsVersion = '5.0.1' % (`string`) WEC-Sim version + wsVersion = '6.0' % (`string`) WEC-Sim version end methods