WEC Design Optimization Toolbox
Project description
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 Conda
for Capytaine (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
Option 2 - using pip
for Capytaine (requires Fortran compilers):
pip install git+https://github.com/LHEEA/meshmagick.git@3.3
pip install wecopttool
Tutorials
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 https://github.com/SNL-WaterPower/WecOptTool.git
cd WecOptTool/examples
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for wecopttool-1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 16620253814a0b24438fcb1ddc7fc0efdf53a7fbc4272a456f8d1d4daf96d7be |
|
MD5 | 7030631d0c68d679254a8f95b4d1086b |
|
BLAKE2b-256 | 73f3fca85c90cdd8353c2de4974914d4cda3e7c262980dc7388796870d1cdffa |