Skip to content

shagun751/WaveSpec.jl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

WaveSpec

Stable Dev Build Status Coverage


Description

WaveSpec provides functions related to ocean-wave input for numerical models. These include

Function Description
dispersionRel(h, T) Function for calculation the wave-length for a ocean wave with period T and in water-depth h,
jonswap(Hs, Tp) Function for calculation jonswap spectrum, for a given significant wave height Hs and peak time period Tp)
waveAiry1D(sp, t, x, z) Generate time-series for wave-elevation and particle velocity at location (x,z) at at time-instances t for a ocean-wave spectrum defined by sp

Tutorials

Please refer to the test folder for the tutorials


Installation

WaveSpec is a registered package in the official Julia package registry. Thus, the installation of WaveSpec is straight forward using the Julia's package manager. Open the Julia REPL, type ] to enter package mode, and install as follows

pkg> add WaveSpec

Guidelines for Using Revise.jl in Development

Revise.jl enables developers to modify dependencies and immediately reflect those changes in the active Julia REPL without requiring a restart.

While Revise.jl is a powerful tool, it is not recommended to add it as a package dependency. Instead, you should configure it to load automatically in your local Julia REPL. You can follow the instructions here to set this up.

This approach ensures that Revise.jl is available in your local environment, allowing you to take advantage of its features without adding it to the package itself.


Contact

Please contact Oriol Colomes, Shagun Agarwal for further questions.


About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published