dtocean-hydrodynamics 4.0.1

Hydrodynamics module for the DTOcean tools

dtocean-hydrodynamics

This package provides the Hydrodynamics design module for the DTOcean tools. It can calculate the energy output of arrays of fixed or floating wave or tidal ocean energy converters, including the effect of interactions. It can optimise the position of the devices for maximum energy yield, constrained by the given environment.

Part of the DTOcean suite of tools.

Installation

pip install dtocean-hydrodynamics

After installation, ensure that all the necessary data files are downloaded using the following command:

dtocean-hydro init

Alternatively, if dtocean-core is installed, use:

dtocean init

Usage

Examples

Example scripts are available in the examples folder of the source code.

For tidal energy converters:

cd examples
python tidal_fixed_layout.py

For wave energy converters:

cd examples
python wave_fixed_layout.py

Command Line Tools

A graphical user interface to the WEC analysis tool is provided. This tool is a required pre-processing step for analysing the interactions of wave energy converters. To get help:

dtocean-wec -h

Alternatively, if dtocean-core is installed, the GUI can be accessed using:

dtocean hydrodynamics wec

Documentation

Video tutorials describing how to use the WEC simulator tool can be found on the Data Only Greater YouTube Channel.

Development

Development of dtocean-hydrodynamics uses the Poetry dependency manager. Poetry must be installed and available on the command line.

To install:

poetry install

After installation, ensure that all the necessary data files are downloaded using the following command:

dtocean-hydro init

Alternatively, if dtocean-core is installed, use:

dtocean init

Tests

A test suite is provided with the source code that uses pytest.

Install the testing dependencies:

poetry install --with test

Additional tests are available for the plugins to dtocean-core and dtocean-app. Enable these tests by installing the test-extras group:

poetry install --with test --with test-extras

Run the tests:

poetry run pytest

Code quality can also be audited using the ruff and pyright tools. Install the dependencies:

poetry install --with audit

Run the audit:

poetry run ruff
poetry run pyright src

Contributing

Please see the dtocean GitHub repository for contributing guidelines.

Credits

This package was initially created as part of the EU DTOcean project by:

• Francesco Ferri at Aalborg University
• Pau Mercade Ruiz at Aalborg University
• Thomas Roc at IT Power (now ITPEnergised)
• Chris Chartrand at Sandia National Labs
• Jean-Francois Filipot at France Energies Marines
• Rui Duarte at France Energies Marines
• Mathew Topper at TECNALIA

It is now maintained by Mathew Topper at Data Only Greater.

License

GPL-3.0