This repository is used for maintaining and distributing example files for DTOcean. Archives (in zip or tar.gz formats) containing the examples can be downloaded from the Releases page.
The following table describes the content of each of the top level folders:
| Folder | Description |
|---|---|
| Getting Started | Files to accompany the Getting Started 1: Example Project tutorial |
| RM3 WEC Analysis | A copy of the project featured in the DTOcean WEC Pre-processor video tutorials |
Contributions are gratefully received and should be provided using pull requests. This repository uses dvc to manage copies of the examples which are 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.
The Poetry package manager is required to install dvc. To collect the examples from the external service, first clone this repository and then install Poetry. From the root of the repository use Poetry to install dependencies:
poetry installNow use dvc pull to populate the
export folder with the database tables:
poetry run dvc pullTo contribute additional examples, 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.
These examples are maintained by Mathew Topper at Data Only Greater.
Huge thanks is extended to the following folks for their contributions to this collection:
- Sterling Olson at Sandia National Labs
- Francesco Ferri at Aalborg University
The examples in this repository are public domain, as detailed by the Unlicense.