2. Installation

2.2. Application

The DTOcean suite, including the desktop application, can be installed from PyPI. Standalone wizard-based installers and Conda packages are currently not available, but may be reimplemented in the future.

2.2.1. PyPI

Ensure that a compatible Python version (see the Index page) is available on the command line [1]. Use pip to install the dtocean suite:

pip install dtocean

Once the dtocean packages are installed, an initialization step is required to download large files and add a desktop shortcut:

dtocean init

Once this command has completed, as shortcut called “DTOcean” should be available in the OS start menu, which will open the DTOcean desktop application.

2.3. Database

The use of DTOcean is supported by a persistent PostgreSQL database. The latest version of the database package can be downloaded from Github and installation instructions are included within the package.

2.4. Configuration Files

2.4.1. Updating

When upgrading DTOcean, it may be necessary to update its configuration files. Options for updating the database and logging configuration files are:

  • overwriting old files with the new default settings (which requires no further user interaction) or,

  • copying the new configuration files alongside the old, so that the user can manually merge them.

The configuration files are updated using specific command line utilities.

Database:

To update the database configuration files:

  1. Copy the new configuration files next to the old:

    dtocean core config database

  2. Or, overwrite the old files:

    dtocean core config database --overwrite

Logging:

To update the logger configuration files:

  1. Copy the new configuration files next to the old:

    dtocean core config logging

  2. Or, overwrite the old files:

    dtocean core config logging --overwrite

2.4.2. File Locations

The location of the configuration files, if the user chooses to merge their old settings into the new configuration file, are:

Database:

C:\Users\<USERNAME>\AppData\Roaming\DTOcean\dtocean_core\config\database.yaml C:\Users\<USERNAME>\AppData\Roaming\DTOcean\dtocean_core\config\database.yaml.new

Logging:

C:\Users\<USERNAME>\AppData\Roaming\DTOcean\dtocean_app\config\logging.yaml C:\Users\<USERNAME>\AppData\Roaming\DTOcean\dtocean_app\config\logging.yaml.new

Footnotes