wecopttool 1.0.1

WEC Design Optimization Toolbox

WecOptTool

The Wave Energy Converter Design Optimization Toolbox (WecOptTool) allows users to perform wave energy converter (WEC) device design optimization studies with constrained optimal control.

NOTE: If you are looking for the WecOptTool code used in previous published work (MATLAB version) please see WecOptTool-MATLAB.

Project Information

Refer to WecOptTool documentation for more information, including project overview, tutorials, theory, and API documentation.

Getting started

WecOptTool requires Python 3.9 (waiting on vtk -> 3.10).

Option 1 - using pip for Capytiane (requires Fortran compilers):

pip install git+https://github.com/LHEEA/meshmagick.git@3.3
pip install wecopttool

Option 2 - using Conda for Capytiane (requires the Conda package manager):

pip install git+https://github.com/LHEEA/meshmagick.git@3.3
conda install -c conda-forge capytaine
pip install wecopttool

Tutorials

The tutorials can be found in the examples directory and are written as Jupyter Notebooks. There are many ways to interact with Jupyter Notebooks. To run the notebooks on your local machine, first install the classical Jupyter Notebook locally:

pip install notebook

To run the tutorials, from the directory containing the notebooks run

jupyter notebook

Getting help

To report bugs, use WecOptTool's issues page. For general discussion, use WecOptTool's discussion page

Contributing

If your interersted in contributing to WecOptTool see our contribution guidelines.