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
If you are brand new to Python and/or want detailed installation instructions, click here.
WecOptTool requires Python >= 3.8. Python 3.11 & 3.12 are supported.
It is strongly recommended you create a dedicated virtual environment (e.g., using conda, mamba, venv, etc.) before installing WecOptTool.
From your dedicated environment, you can install WecOptTool via conda, pip, or mamba:
Option 1 - using Conda:
conda install -c conda-forge wecopttool
Option 2 - using pip (requires Fortran compilers on your system):
pip install wecopttool
Option 3 - using Mamba:
mamba install wecopttool
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
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/sandialabs/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 you are interested in contributing to WecOptTool, see our contribution guidelines.
1 maintainer
Metadata
1 maintainer
Release files for wecopttool 3.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| wecopttool-3.2.1.tar.gz | 74.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| wecopttool-3.2.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 130.8 kB
Release files / wecopttool-3.2.1.tar.gz
| Download URL | wecopttool-3.2.1.tar.gz |
|---|---|
| Size | 74.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1fcf33cdf6c15515a752021cdbaf2adabbc71c33ce078ac8f8e48bc290896231
|
|
BLAKE2b-256 checksum How to use checksums |
5e699e755308fbcf2a8506e9abe6805d2f52627a225d2e6d2e111d3bed7797ec
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Release files / wecopttool-3.2.1-py3-none-any.whl
| Download URL | wecopttool-3.2.1-py3-none-any.whl |
|---|---|
| Size | 56.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3e55842b9bca9ec1f406b88ad4fdf605f6cdf0fdf32c51d5400013a5fb52b1b2
|
|
BLAKE2b-256 checksum How to use checksums |
419ad30b6d555f0fb99edfff0810982dbfef73f10ba3893afb3dfa50dc4558c9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
