https://github.com/dionhaefner/fowd

Processing framework for FOWD, a free ocean wave dataset, ready for your ML application :ocean:
https://github.com/dionhaefner/fowd

data-science machine-learning ocean open-data waves

Last synced: 4 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/dionhaefner/fowd
• Owner: dionhaefner
• License: mit
• Created: 2019-07-09T08:49:31.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-07-06T22:01:53.000Z (over 1 year ago)
• Last Synced: 2024-10-09T13:23:08.781Z (4 months ago)
• Topics: data-science, machine-learning, ocean, open-data, waves
• Language: Python
• Homepage: https://www.nbi.ku.dk/english/research/pice/oceanography/
• Size: 114 KB
• Stars: 10
• Watchers: 2
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Citation: CITATION.cff

Awesome Lists containing this project

README

        
# 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:

```bash

$ 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](https://cdip.ucsd.edu/):

```bash

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

```

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

### Generic inputs

Use

```bash

$ 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

```bash

$ fowd plot-qc qcfile.json

```

## Testing

Run tests and sanity checks via

```bash

$ fowd run-tests

```

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