Skip to main content

WEC Design Optimization Toolbox

Project description

Test-WecOptTool Coverage Status

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.

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-3.1.0.tar.gz (73.2 kB view details)

Uploaded Source

Built Distribution

wecopttool-3.1.0-py3-none-any.whl (55.1 kB view details)

Uploaded Python 3

File details

Details for the file wecopttool-3.1.0.tar.gz.

File metadata

  • Download URL: wecopttool-3.1.0.tar.gz
  • Upload date:
  • Size: 73.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for wecopttool-3.1.0.tar.gz
Algorithm Hash digest
SHA256 dc6706aca19cc1e56a05c408d86435cbef1237bd17637f71ffc3f1f8ab674ec9
MD5 40538dece4eb4bc3e89b45dba9a99e1f
BLAKE2b-256 1b0795d2722b562d5ce351f064e82d440bf44e321d17e54b4998cf0d8f887a49

See more details on using hashes here.

File details

Details for the file wecopttool-3.1.0-py3-none-any.whl.

File metadata

  • Download URL: wecopttool-3.1.0-py3-none-any.whl
  • Upload date:
  • Size: 55.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for wecopttool-3.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3478ed0053b936f66c337225f249652787ff8f4ada3318b3594da9211085fcde
MD5 2fdc94f40d1c46a5822c5edc7c05412e
BLAKE2b-256 594e0142fcb54610dd1f0cc281ad71561f8221c7e867398620582acfb5ac2136

See more details on using hashes here.

Supported by

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