fowd

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

https://github.com/dionhaefner/fowd

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    1 of 2 committers (50.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.2%) to scientific vocabulary

Keywords

data-science machine-learning ocean open-data waves

Keywords from Contributors

mesh interactive
Last synced: 6 months ago · JSON representation ·

Repository

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

Basic Info
Statistics
  • Stars: 14
  • Watchers: 1
  • Forks: 4
  • Open Issues: 1
  • Releases: 12
Topics
data-science machine-learning ocean open-data waves
Created over 6 years ago · Last pushed over 2 years ago
Metadata Files
Readme License Citation

README.md

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:

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: - samplingrate - waterdepth - 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.

Owner

  • Name: Dion Häfner
  • Login: dionhaefner
  • Kind: user
  • Location: Malmö
  • Company: @pasteurlabs | Niels Bohr Institute

I do science with Python.

Citation (CITATION.cff)

authors:
  - family-names: Häfner
    given-names: Dion
cff-version: 1.2.0
message: "If you use this software, please cite the article from preferred-citation."
title: FOWD
url: "https://github.com/dionhaefner/FOWD"
preferred-citation:
  type: article
  title: "FOWD: A Free Ocean Wave Dataset for Data Mining and Machine Learning"
  authors:
    - family-names: Häfner
      given-names: Dion
    - family-names: Gemmrich
      given-names: Johannes
    - family-names: Jochum
      given-names: Markus
  year: 2021
  journal: "Journal of Atmospheric and Oceanic Technology"
  volume: 38
  number: 7
  pages: "1305 - 1322"
  doi: "10.1175/JTECH-D-20-0185.1"
  url: "https://journals.ametsoc.org/view/journals/atot/aop/JTECH-D-20-0185.1/JTECH-D-20-0185.1.xml"

GitHub Events

Total
  • Issues event: 2
  • Watch event: 4
Last Year
  • Issues event: 2
  • Watch event: 4

Committers

Last synced: over 1 year ago

All Time
  • Total Commits: 98
  • Total Committers: 2
  • Avg Commits per committer: 49.0
  • Development Distribution Score (DDS): 0.01
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Dion Häfner d****r@n****k 97
dependabot[bot] 4****] 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 13
  • Total pull requests: 3
  • Average time to close issues: 3 months
  • Average time to close pull requests: about 17 hours
  • Total issue authors: 2
  • Total pull request authors: 2
  • Average comments per issue: 0.15
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 2
Past Year
  • Issues: 1
  • Pull requests: 0
  • Average time to close issues: 1 day
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • dionhaefner (12)
  • eroome (1)
Pull Request Authors
  • dependabot[bot] (2)
  • dionhaefner (1)
Top Labels
Issue Labels
Pull Request Labels
dependencies (2)

Dependencies

requirements.txt pypi
  • Bottleneck ==1.3.2
  • cftime ==1.1.3
  • click ==7.1.2
  • cycler ==0.10.0
  • filelock ==3.0.12
  • kiwisolver ==1.2.0
  • matplotlib ==3.2.1
  • netCDF4 ==1.5.3
  • numpy ==1.22.0
  • pandas ==1.0.3
  • pyparsing ==2.4.7
  • python-dateutil ==2.8.1
  • pytz ==2020.1
  • scipy ==1.4.1
  • six ==1.14.0
  • tqdm ==4.46.0
  • xarray ==0.15.1
setup.py pypi
  • bottleneck *
  • click *
  • filelock *
  • matplotlib *
  • netcdf4 *
  • numpy *
  • scipy >=1.0
  • tqdm *
  • xarray *