dtocean-app

This repository contains the main graphical application of the DTOcean software tools. The code contained in this package is a Qt GUI view of the underlying model, provided by the dtocean-core package.

Part of the DTOcean suite of tools.

Installation

pip install dtocean-app

Install a desktop shortcut to the UI with the following command:

dtocean init

Note that Design and assessment modules must be installed separately.

Usage

Graphical Interface

If dtocean init was called a shortcut named "DTOcean" should be available in the desktop start menu

Alternatively, the UI can be started from a command line terminal:

dtocean app

To send all output to the cmd window (useful when crashes occur before logging is started) use "debug mode":

dtocean app --debug

See the "Getting Started 1: Example Project" chapter of the DTOcean documentation for an example project.

Command Line Tools

A utility is provided to copy user modifiable configuration files to the users "AppData" directory (on Windows). For instance the logging configuration can be modified once these files have been copied. To get help:

dtocean app config -h

Development

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

If installing from the git repository, the image files must first be retrieved using git-lfs (ensure that git-lfs is installed first):

git lfs fetch --all
git lfs pull

To install:

poetry install

Tests

A test suite is provided with the source code that uses pytest. To install the testing dependencies:

poetry install --with test

Alternatively to include additional modules which enable the full suite of tests, use the command:

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

The above tests can be run across all compatible Python versions using tox and tox-uv. To install and run:

poetry install --with tox
poetry run tox

Contributing

Please see the dtocean GitHub repository for contributing guidelines.

Credits

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

• Mathew Topper at TECNALIA
• Vincenzo Nava at TECNALIA
• Rui Duarte at France Energies Marines

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

Licenses

Software

GPL-3.0

Icons

The icons used with the graphical interface are source directly or derived from the following open source icon sets:

• Crystal Clear (LPGL-2.1)
• GNOME (GPL-2.0)
• ScreenRuler Tango (GPL-3.0)