The DTOcean database is a PostgreSQL database used for storing persistent data, such as ocean energy converter (OEC) designs, metocean observations for sites, and reference data for electrical, mooring and foundations components, ports, vessels, etc.
The pre-installed data shipped with the database contains free to use examples of OECs, sites, and reference data. The included data was used in the development of two scenarios that contributed to journal publications, as shown in the table below.
| Scenario | Location | Device | Device Type | Publications |
|---|---|---|---|---|
| 1 | Eureka, CA, USA | RM3 | Floating Wave | [1] |
| 2 | Tacoma Narrows, WA, USA | RM1 | Fixed Tidal | [2] [3] |
The recommended method for installing the latest version of the DTOcean database is using Docker Compose to run the database in a container. Details on how to prepare your system to install containers is included in the installation instructions.
Download the zip or tar.gz archive from the latest release page, decompress the folder, and then follow the instructions in INSTALLATION.md. Note that a copy of the installation instructions is also included in the archives.
If you are installing version v2.0.0 or v1.0.0 of the database then follow the
instructions in the README_database_installation.txt file found in the zip
archives. Beware that those instructions require outdated versions of
PostgreSQL.
Instructions for preparing data to be stored in the database and a description of the database schema can be found in the dtocean documentation.
This repository uses dvc to manage copies of the published data. The data, in csv format, is stored on a remote service (external to GitHub) and the repository only contains dvc managed pointers to the data. Commands provided by dvc are used to transfer the data to and from the external remote.
Python is used to install dvc and for testing database initialization. The Poetry package manager is used to manage Python dependencies. To prepare the repository for installation from source, first clone it and install Poetry. From the root of the repository use Poetry to install dependencies:
poetry install --with testNow use dvc pull to populate the
export folder with the database tables:
poetry run dvc pullFollow the instructions in INSTALLATION.md to deploy the docker container from your local git repo.
The database container initialization typically requires between 2 and 3 minutes to complete. Tests developed with pytest are provided to test if the initialization was successful.
Before running the tests, certain environment variables with values matching those used when creating the containers (see the Environment Variables section) must be defined. The variables to include (if set) are:
- DTOCEAN_DB_EXAMPLES_NAME
- DTOCEAN_DB_TEMPLATE_NAME
- DTOCEAN_USER_NAME
- DTOCEAN_USER_PASSWORD
- POSTGRES_PORT
Note that DTOCEAN_USER_PASSWORD is the only variable used here which is required to be set during the installation process. Once the variables are set, call the following command to run the tests:
poetry run pytest testsContributions are gratefully received and should be provided using pull requests. To contribute additional data, you must set up a temporary DVC remote to share the data and make sure to check the 'Allow edits from maintainers' option in the pull request. Alternatively, open an issue to discuss other methods for transmitting the data.
This database was initially created as part of the EU DTOcean project by:
- Chris O’Donoghue at University College Cork
- Mathew Topper at TECNALIA
- David Bould at the University of Edinburgh
It is now maintained by Mathew Topper at Data Only Greater.
Gratitude is given to Sandia National Labs for their help updating the example data. All new data was acquired from public sources.