FOWD

:ocean: Processing framework for FOWD, a free ocean wave dataset, ready for your ML application.

Installation

After downloading the repository, you can install FOWD and all dependencies (preferably into a virtual environment) via:

$ pip install -r requirements.txt
$ pip install .

Usage

After installing the Python code, you can use the command line tool fowd to create a FOWD dataset from a raw source.

CDIP

Currently, the best supported source is CDIP buoy data:

$ fowd process-cdip 433p1 -o fowd-cdip-out

will process all CDIP data located in the 433p1 folder.

Generic inputs

Use

$ fowd process-generic infile.nc -o outdir

Generic inputs must be netCDF files with the following structure:

Variables:
- time
- displacement

Attributes:
- sampling_rate
- water_depth
- longitude
- latitude

QC plots

All data processing writes QC information in JSON format. You can visualize records in that QC file by using

$ fowd plot-qc qcfile.json

Testing

Run tests and sanity checks via

$ fowd run-tests

Test results are checked automatically, but sanity checks have to be inspected manually.