Skip to main content

WEC Design Optimization Toolbox

Project description

Test-WecOptTool Coverage Status


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.8. Python 3.9 & 3.10 are supported. It is strongly recommended you create a dedicated virtual environment (e.g., using conda, venv, etc.) before installing wecopttool.

Option 1 - using Conda:

conda install -c conda-forge wecopttool

Option 2 - using pip (requires Fortran compilers on your system):

pip install wecopttool

This approach is not recommended for Windows users since compiling capytaine on Windows requires extra steps.

Geometry module and tutorials

To use our geometry examples, including for running the tutorials, you will need to install some additional dependencies. For the tutorials you will also need to install jupyter.

pip install wecopttool[geometry] jupyter

or on a Mac (Zsh shell)

pip install wecopttool\[geometry] jupyter


The tutorials can be found in the examples directory and are written as Jupyter Notebooks. To run the tutorials, first download the notebook files and then, from the directory containing the notebooks, run jupyter notebook. Using git to obtain the notebooks this can be done by running

git clone
cd WecOptTool/examples
jupyter notebook

Getting help

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


If you are interested in contributing to WecOptTool, see our contribution guidelines.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wecopttool-2.6.0.tar.gz (68.6 kB view hashes)

Uploaded source

Built Distribution

wecopttool-2.6.0-py3-none-any.whl (50.2 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page