v2.2.3

Main changes: corrected documentation build bugs from the past two patch releases. Plus quite a bit of related code cleanup.

What's Changed

• Documentation build corrections and cleanup by @michaelcdevin in https://github.com/SNL-WaterPower/WecOptTool/pull/210

Full Changelog: SNL-WaterPower/WecOptTool@v2.2.2...v2.2.3

v2.2.2

What's Changed

• removed internal URLs in tutorials by @michaelcdevin in https://github.com/SNL-WaterPower/WecOptTool/pull/208

Full Changelog: SNL-WaterPower/WecOptTool@v2.2.1...v2.2.2

v2.2.1

What's Changed

• Documentation site build rework by @michaelcdevin in https://github.com/SNL-WaterPower/WecOptTool/pull/204
• update Capytaine to version 1.5 by @cmichelenstrofer in https://github.com/SNL-WaterPower/WecOptTool/pull/205

Full Changelog: SNL-WaterPower/WecOptTool@v2.2.0...v2.2.1

v2.2.0

What's Changed

• Clean up testing suite for wavespectra v3.13.0 breaking changes by @michaelcdevin in https://github.com/SNL-WaterPower/WecOptTool/pull/189
• Fix documentation website deployment by @michaelcdevin in https://github.com/SNL-WaterPower/WecOptTool/pull/187
• Impedance transduced effort flow variables by @dtgaebe in https://github.com/SNL-WaterPower/WecOptTool/pull/185
• Remove sine component of 2-point wave by @michaelcdevin in https://github.com/SNL-WaterPower/WecOptTool/pull/191
• NEW FEATURE: Geometry scale factor by @ryancoe in https://github.com/SNL-WaterPower/WecOptTool/pull/190
• Fix for the from_impedancefunction by @akeow in https://github.com/SNL-WaterPower/WecOptTool/pull/192
• Add skips to unit tests for when geom module isn't installed by @michaelcdevin in https://github.com/SNL-WaterPower/WecOptTool/pull/200

New Contributors

• @akeow made their first contribution in https://github.com/SNL-WaterPower/WecOptTool/pull/192

Full Changelog: SNL-WaterPower/WecOptTool@v2.1.3...v2.2.0

v2.1.0

Main changes: Refactoring of tests and CI/CD. Release in conda-forge. And some code cleanup.

What's Changed

• NEW FEATURE: Add freq and period coords to post-proc results by @ryancoe in https://github.com/SNL-WaterPower/WecOptTool/pull/152
• DOCUMENTATION: imageio v3 interface and pygifsicle optimization for gif animations in docs by @ryancoe in https://github.com/SNL-WaterPower/WecOptTool/pull/147
• CI/CD improvements by @cmichelenstrofer in https://github.com/SNL-WaterPower/WecOptTool/pull/151
• BUG FIX: avoid divide by zero warning when finding period from frequency by @ryancoe in https://github.com/SNL-WaterPower/WecOptTool/pull/156
• DOCUMENTATION: API Docs improvement. by @cmichelenstrofer in https://github.com/SNL-WaterPower/WecOptTool/pull/155
• NEW FEATURE: improve/fix scipy.minimize interfaces in wec.solve by @ryancoe in https://github.com/SNL-WaterPower/WecOptTool/pull/145
• CLEANUP: hydrostatics _set_* functions combined into one by @michaelcdevin in https://github.com/SNL-WaterPower/WecOptTool/pull/159
• CI/CD: Improve unit tests. by @cmichelenstrofer in https://github.com/SNL-WaterPower/WecOptTool/pull/161
• BUGFIX: fix bug with PID controllers. Fixes #163 by @cmichelenstrofer in https://github.com/SNL-WaterPower/WecOptTool/pull/166
• BUGFIX: Factor of sqrt(2) in irregular_wave by @cmichelenstrofer in https://github.com/SNL-WaterPower/WecOptTool/pull/167
• CI/CD: Improve integration tests by @ryancoe in https://github.com/SNL-WaterPower/WecOptTool/pull/164
• PTO: use power loss (in Watts) instead of efficiency or loss ratio by @cmichelenstrofer in https://github.com/SNL-WaterPower/WecOptTool/pull/173
• CI/CD: Update push.yml by @cmichelenstrofer in https://github.com/SNL-WaterPower/WecOptTool/pull/174
• TUTORIALS: New tutorial using AquaHarmonics device, power loss map by @cmichelenstrofer in https://github.com/SNL-WaterPower/WecOptTool/pull/172

Full Changelog: SNL-WaterPower/WecOptTool@v2.0.0...v2.1.0

v2.0.0

Version 2.0.0

New features

• Restructured core.py: now allows for multiple workflows including initializing the WEC class from transfer functions without requiring meshing or BEM solution.
• Restructured pto.py to accomplish all different PTO realizations with a single class.
• Added non-linear kinematics to the PTO class.
• Added non-linear power-chain conversion to the PTO class.
• The waves module is now based on the wavespectra package.
• Restructered the tests and separated into unit tests and integration tests.
• Updated tutorial.
• Updated post-processing and plotting for WEC and PTO dynamic responses.
• API Autodocumentation now uses typehint information.
• Use latest Capytaine version, v1.4.2.
• Updated API documentation, website, and CI workflows.

v1.1.0

Version 1.1.0

• minor updates to README
• logging of decision vector and objective function
• f_add should be passed as a dict, e.g., {'my_name': my_func}
  • optionally treat buoyancy/gravity explicitly via user-defined functions passed to f_add
  • time and freq domain results calculated for entries of f_add after solve completes
• logging of decision vector and objective function
  • controlled entirely via logging package config
  • move to info logging level (debug gives too much from other packages, e.g., matplotlib)
• added tests for multiple WEC/PTO degrees of freedom.
• allow user to pass bounds via solve to scipy.optimize.minimize

Bug fixes

• geom.WaveBot.plot_cross_section now plots correct location of waterline
• All constraints are now being enforced when multiple constraints are passed
• Fix shape/linear algebra bugs in fixed structure PTOs with multiple PTO DOFs

v1.0.2

Version 1.0.2

• update Tutorial 2
  • new r2 vector
  • improve scaling
  • update discussion of results
• logging of decision vector and objective function
  • now uses absolute value of mean
  • move to debug logging level

Bug fixes

• Correct dependency name for jupyter-notebook
• Move jupyter-notebook to base install dependecy

New features

• Create continuous time functions from the WEC dynamics and PTO pseudo-spectral results.

v1.0.1

Version 1.0.1

Major Changes

Bug fixes

• Fixed bug with modifying mass and other properties of the WEC object. Renamed mass_matrix to mass.
• Fix broken link in RELEASING

New features

• Expand Theory page in documentation to include
  • Animations and comparison between pseudo-spectral and time-stepping solutions
  • Discussion of scaling
• Add JONSWAP spectrum
• Optional logging of x and obj_fun(x) at each iteration
• Add example PI controller to PTO module
• Add core methods for
  • Theoretical power limit
  • Natural frequency
• Add tests for
  • Proportional damping (P) controller gives theoretical power limit at natural frequency
  • Proportional integral (PI) controller gives theoretical power limit for regular wave
• Check test results against previous solution where possible

v1.0.0

Initial release