Giter VIP home page Giter VIP logo

pydiwasp's Introduction

pyDiwasp

conversion of diwasp package (DIWASP: DIrectional WAve SPectrum analysis Version 1.4) for python converted from https://github.com/metocean/diwasp

I would LOVE help making this into better package of the original diwasp tool. Please check issues for needed functionality adds.

Toolbox contents:

Main functions:

  • dirspec.m Main function for directional wave analysis
  • readspec.m Reads in DIWASP format spectrum files
  • writespec.m Writes DIWASP format spectrum files
  • plotspec.m Plots DIWASP spectrums
  • testspec.m Testing function for the estimation methods
  • makespec.m Makes a fake spectrum and generates fake data for testing dirspec.m
  • infospec.m Returns information about a directional spectrum
  • data_structures.m is a help file describing the new Version 1.1 data structures

Private functions (some can be used as stand alone functions):

The transfer functions

  • /private/elev.m
  • /private/pres.m
  • /private/velx.m
  • /private/vely.m
  • /private/velz.m
  • /private/slpx.m
  • /private/slpy.m
  • /private/vels.m
  • /private/accs.m

The estimation functions

  • /private/DFTM.m
  • /private/EMLM.m
  • /private/IMLM.m
  • /private/EMEP.m
  • /private/BDM.m

Miscellaneous functions

  • /private/smoothspec.m
  • /private/wavenumber.m
  • /private/makerandomsea.m
  • /private/makewavedata.m
  • /private/Hsig.m
  • /private/gsamp.m
  • /private/check_data.m

carying original license agreement and copyright

License agreement

DIWASP, is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation. However, the DIWASP license includes the following addendum concerning its usage: This software and any derivatives of it shall only be used for educational purposes or scientific research without the intention of any financial gain. Use of this software or derivatives for any purpose that results in financial gain for a person or organization without written consent from the author is a breach of the license agreement. This software is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. In addition the author is not liable in any way for consequences arising from the application of software output for any design or decision-making process. The GNU General Public License forms the main part of the license agreement included in the package.

Copyright (C) 2002 David Johnson Coastal Oceanography Group, CWR, UWA, Perth

pydiwasp's People

Contributors

dnowacki-usgs avatar sbfrf avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

pydiwasp's Issues

Additional features from Matlab version

Hey Spicer, hope you've been well!
Thanks for posting this python conversion, I am keen to try it out!
Just wondering if you had had a chance to look at any of the other estimation methods or datatypes. If not I am happy to help in porting these across.

more Testing

This code could use more thorough testing. Open to suggestions, or volunteers!

Documentation enhancement

Most of this repository is built as replica of matlab version of diwasp, and as such, there is no specific documentation to pyDiwasp. Happy to accept Pull Requests!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.